Ran black 🎨

Author: sumit4613

.pre-commit-config.yaml

@@ -4,7 +4,8 @@ repos:
       rev: 22.10.0
       hooks:
         - id: black
-
+          args:
+            - --line-length=100
     - repo: https://github.com/PyCQA/flake8
       rev: 5.0.4
       hooks:

Makefile

@@ -64,7 +64,7 @@ docs:
 	python setup.py build_sphinx
 
 lint:
-	flake8  --exclude=*/migrations/* --max-line-length 88 drf_user
+	flake8  --exclude=*/migrations/* --max-line-length 100 drf_user
 
 format:
 	black --exclude .+/migrations/.+\.py drf_user

drf_user/__init__.py

@@ -60,9 +60,7 @@ def update_user_settings() -> dict:
                     user_settings["OTP"][otp_key] = otp_value
             elif key == "REGISTRATION":
                 if not isinstance(value, dict):
-                    raise TypeError(
-                        "USER_SETTING attribute REGISTRATION must be a dict."
-                    )
+                    raise TypeError("USER_SETTING attribute REGISTRATION must be a dict.")
                 for reg_key, reg_value in value.items():
                     user_settings["REGISTRATION"][reg_key] = reg_value
         if user_settings["REGISTRATION"]["SEND_MAIL"]:

drf_user/managers.py

@@ -30,9 +30,7 @@ def _create_user(
         Creates and saves a User with given details
         """
         email = self.normalize_email(email)
-        user = self.model(
-            username=username, email=email, name=fullname, mobile=mobile, **kwargs
-        )
+        user = self.model(username=username, email=email, name=fullname, mobile=mobile, **kwargs)
         user.set_password(password)
         user.save(using=self._db)
         return user

drf_user/models.py

@@ -33,9 +33,7 @@ class User(AbstractBaseUser, PermissionsMixin):
     Author: Himanshu Shankar (https://himanshus.com)
     """
 
-    username = models.CharField(
-        verbose_name=_("Unique UserName"), max_length=254, unique=True
-    )
+    username = models.CharField(verbose_name=_("Unique UserName"), max_length=254, unique=True)
     email = models.EmailField(verbose_name=_("Email Address"), unique=True)
     mobile = models.CharField(
         verbose_name=_("Mobile Number"),
@@ -103,15 +101,9 @@ class AuthTransaction(models.Model):
         blank=True,
         verbose_name=_("JWT Refresh Token"),
     )
-    expires_at = models.DateTimeField(
-        blank=True, null=True, verbose_name=_("Expires At")
-    )
-    create_date = models.DateTimeField(
-        verbose_name=_("Create Date/Time"), auto_now_add=True
-    )
-    update_date = models.DateTimeField(
-        verbose_name=_("Date/Time Modified"), auto_now=True
-    )
+    expires_at = models.DateTimeField(blank=True, null=True, verbose_name=_("Expires At"))
+    create_date = models.DateTimeField(verbose_name=_("Create Date/Time"), auto_now_add=True)
+    update_date = models.DateTimeField(verbose_name=_("Date/Time Modified"), auto_now=True)
     created_by = models.ForeignKey(to=User, on_delete=models.PROTECT)
 
     def __str__(self):
@@ -142,19 +134,15 @@ class OTPValidation(models.Model):
     create_date = models.DateTimeField(verbose_name=_("Create Date"), auto_now_add=True)
     update_date = models.DateTimeField(verbose_name=_("Date Modified"), auto_now=True)
     is_validated = models.BooleanField(verbose_name=_("Is Validated"), default=False)
-    validate_attempt = models.IntegerField(
-        verbose_name=_("Attempted Validation"), default=3
-    )
+    validate_attempt = models.IntegerField(verbose_name=_("Attempted Validation"), default=3)
     prop = models.CharField(
         verbose_name=_("Destination Property"),
         default=EMAIL,
         max_length=3,
         choices=DESTINATION_CHOICES,
     )
     send_counter = models.IntegerField(verbose_name=_("OTP Sent Counter"), default=0)
-    sms_id = models.CharField(
-        verbose_name=_("SMS ID"), max_length=254, null=True, blank=True
-    )
+    sms_id = models.CharField(verbose_name=_("SMS ID"), max_length=254, null=True, blank=True)
     reactive_at = models.DateTimeField(verbose_name=_("ReActivate Sending OTP"))
 
     def __str__(self):

drf_user/serializers.py

@@ -38,9 +38,7 @@ def validate_email(self, value: str) -> str:
         if check_validation(value=value):
             return value
         else:
-            raise serializers.ValidationError(
-                "The email must be " "pre-validated via OTP."
-            )
+            raise serializers.ValidationError("The email must be " "pre-validated via OTP.")
 
     def validate_mobile(self, value: str) -> str:
         """
@@ -61,9 +59,7 @@ def validate_mobile(self, value: str) -> str:
         if check_validation(value=value):
             return value
         else:
-            raise serializers.ValidationError(
-                "The mobile must be " "pre-validated via OTP."
-            )
+            raise serializers.ValidationError("The mobile must be " "pre-validated via OTP.")
 
     def validate_password(self, value: str) -> str:
         """Validate whether the password meets all django validator requirements."""
@@ -201,9 +197,7 @@ def validate(self, attrs: dict) -> dict:
                 raise NotFound(_("No user exists with provided details"))
             if "email" not in attrs.keys() and "verify_otp" not in attrs.keys():
                 raise serializers.ValidationError(
-                    _(
-                        "Email field is compulsory while verifying a non-existing user's OTP."
-                    )
+                    _("Email field is compulsory while verifying a non-existing user's OTP.")
                 )
         else:
             attrs["email"] = user.email
@@ -274,9 +268,7 @@ def get_user(email: str, mobile: str):
     def validate(self, attrs: dict) -> dict:
         """Validates the response"""
 
-        attrs["user"] = self.get_user(
-            email=attrs.get("email"), mobile=attrs.get("mobile")
-        )
+        attrs["user"] = self.get_user(email=attrs.get("email"), mobile=attrs.get("mobile"))
         return attrs
 
 
@@ -362,9 +354,7 @@ class CustomTokenObtainPairSerializer(TokenObtainPairSerializer):
     certain extra data in payload such as: email, mobile, name
     """
 
-    default_error_messages = {
-        "no_active_account": _("username or password is invalid.")
-    }
+    default_error_messages = {"no_active_account": _("username or password is invalid.")}
 
     @classmethod
     def get_token(cls, user):

drf_user/urls.py

@@ -23,13 +23,9 @@
         name="Retrieve Update Profile",
     ),
     # ex: api/user/password/reset/
-    path(
-        "password/reset/", views.PasswordResetView.as_view(), name="reset_user_password"
-    ),
+    path("password/reset/", views.PasswordResetView.as_view(), name="reset_user_password"),
     # ex: api/user/upload-image/
     path("upload-image/", views.UploadImageView.as_view(), name="upload_profile_image"),
     # ex: api/user/refresh-token/
-    path(
-        "refresh-token/", views.CustomTokenRefreshView.as_view(), name="refresh_token"
-    ),
+    path("refresh-token/", views.CustomTokenRefreshView.as_view(), name="refresh_token"),
 ]

drf_user/utils.py

@@ -130,9 +130,7 @@ def generate_otp(*, destination_property: str, destination: str) -> OTPValidatio
 
     # Checks if random number is unique among non-validated OTPs and
     # creates new until it is unique.
-    while OTPValidation.objects.filter(otp__exact=random_number).filter(
-        is_validated=False
-    ):
+    while OTPValidation.objects.filter(otp__exact=random_number).filter(is_validated=False):
         random_number: str = User.objects.make_random_password(
             length=otp_settings["LENGTH"], allowed_chars=otp_settings["ALLOWED_CHARS"]
         )
@@ -299,17 +297,13 @@ def validate_otp(*, destination: str, otp_val: int) -> bool:
     elif otp_object.validate_attempt <= 0:
         # check if attempts exceeded and regenerate otp and raise error
         generate_otp(destination_property=otp_object.prop, destination=destination)
-        raise AuthenticationFailed(
-            detail=_("Incorrect OTP. Attempt exceeded! OTP has been reset.")
-        )
+        raise AuthenticationFailed(detail=_("Incorrect OTP. Attempt exceeded! OTP has been reset."))
 
     else:
         # update attempts and raise error
         otp_object.save(update_fields=["validate_attempt"])
         raise AuthenticationFailed(
-            detail=_(
-                f"OTP Validation failed! {otp_object.validate_attempt} attempts left!"
-            )
+            detail=_(f"OTP Validation failed! {otp_object.validate_attempt} attempts left!")
         )
 
 
@@ -343,9 +337,7 @@ def send_message(
     sent = {"success": False, "message": None, "mobile_message": None}
 
     if not getattr(settings, "EMAIL_HOST", None):
-        raise ValueError(
-            "EMAIL_HOST must be defined in django setting for sending mail."
-        )
+        raise ValueError("EMAIL_HOST must be defined in django setting for sending mail.")
     if not getattr(settings, "EMAIL_FROM", None):
         raise ValueError(
             "EMAIL_FROM must be defined in django setting "
@@ -416,13 +408,9 @@ def send_otp(
     )
 
     try:
-        data: dict = send_message(
-            message, otp_settings["SUBJECT"], recip_email, recip_mobile
-        )
+        data: dict = send_message(message, otp_settings["SUBJECT"], recip_email, recip_mobile)
     except (ValueError, ValidationError) as e:
-        raise serializers.ValidationError(
-            {"detail": f"OTP sending failed! because {e}"}
-        ) from e
+        raise serializers.ValidationError({"detail": f"OTP sending failed! because {e}"}) from e
 
     otp_obj.reactive_at = timezone.now() + datetime.timedelta(
         minutes=otp_settings["COOLING_PERIOD"]

drf_user/views.py

@@ -193,21 +193,15 @@ def post(self, request, *args, **kwargs):
         destination: str = serializer.validated_data[
             "destination"
         ]  # destination is a required field
-        destination_property: str = serializer.validated_data.get(
-            "prop"
-        )  # can be email or mobile
+        destination_property: str = serializer.validated_data.get("prop")  # can be email or mobile
         user: User = serializer.validated_data.get("user")
         email: Optional[str] = serializer.validated_data.get("email")
         is_login: bool = serializer.validated_data.get("is_login")
 
         if "verify_otp" in request.data.keys():
-            if validate_otp(
-                destination=destination, otp_val=request.data["verify_otp"]
-            ):
+            if validate_otp(destination=destination, otp_val=request.data["verify_otp"]):
                 if is_login:
-                    return Response(
-                        login_user(user, self.request), status=status.HTTP_202_ACCEPTED
-                    )
+                    return Response(login_user(user, self.request), status=status.HTTP_202_ACCEPTED)
                 else:
                     return Response(
                         data={"OTP": _("OTP Validated successfully!")},
@@ -257,9 +251,7 @@ def get_object(self):
     def update(self, request, *args, **kwargs):
         """Updates user's password"""
 
-        response = super(RetrieveUpdateUserAccountView, self).update(
-            request, *args, **kwargs
-        )
+        response = super(RetrieveUpdateUserAccountView, self).update(request, *args, **kwargs)
         # we need to set_password after save the user otherwise it'll save the raw_password in db. # noqa
         if "password" in request.data.keys():
             self.request.user.set_password(request.data["password"])
@@ -311,17 +303,11 @@ def post(self, request, *args, **kwargs):
                 )
                 user.is_active = True
                 user.save(update_fields=["is_active"])
-            return Response(
-                login_user(user, self.request), status=status.HTTP_202_ACCEPTED
-            )
+            return Response(login_user(user, self.request), status=status.HTTP_202_ACCEPTED)
 
-        otp_obj: OTPValidation = generate_otp(
-            destination_property=EMAIL, destination=email
-        )
+        otp_obj: OTPValidation = generate_otp(destination_property=EMAIL, destination=email)
         # Send OTP to Email & Mobile
-        sent_otp_resp: dict = send_otp(
-            otp_obj=otp_obj, recip_email=email, recip_mobile=mobile
-        )
+        sent_otp_resp: dict = send_otp(otp_obj=otp_obj, recip_email=email, recip_mobile=mobile)
 
         if not sent_otp_resp["success"]:
             raise serializers.ValidationError(
@@ -394,9 +380,7 @@ def post(self, request, *args, **kwargs):
         image_serializer.update(
             instance=request.user, validated_data=image_serializer.validated_data
         )
-        return Response(
-            {"detail": "Profile Image Uploaded."}, status=status.HTTP_201_CREATED
-        )
+        return Response({"detail": "Profile Image Uploaded."}, status=status.HTTP_201_CREATED)
 
 
 class CustomTokenRefreshView(TokenRefreshView):
@@ -419,13 +403,9 @@ def post(self, request, *args, **kwargs):
 
         token = serializer.validated_data.get("access")
 
-        auth_transaction = AuthTransaction.objects.get(
-            refresh_token=request.data["refresh"]
-        )
+        auth_transaction = AuthTransaction.objects.get(refresh_token=request.data["refresh"])
         auth_transaction.token = token
-        auth_transaction.expires_at = (
-            timezone.now() + api_settings.ACCESS_TOKEN_LIFETIME
-        )
+        auth_transaction.expires_at = timezone.now() + api_settings.ACCESS_TOKEN_LIFETIME
         auth_transaction.save(update_fields=["token", "expires_at"])
 
         return Response({"token": str(token)}, status=status.HTTP_200_OK)

example/demo_app/urls.py

@@ -48,7 +48,5 @@
         schema_view.with_ui("swagger", cache_timeout=0),
         name="schema-swagger-ui",
     ),
-    re_path(
-        r"^redoc/$", schema_view.with_ui("redoc", cache_timeout=0), name="schema-redoc"
-    ),
+    re_path(r"^redoc/$", schema_view.with_ui("redoc", cache_timeout=0), name="schema-redoc"),
 ]