fix lint: fix all lint issues

Author: jitendra-ky

zserver/admin.py

@@ -1,6 +1,13 @@
 from django.contrib import admin
 
-from zserver.models import Message, Session, SignUpOTP, UserProfile, VerifyUserOTP, UnverifiedUserProfile
+from zserver.models import (
+    Message,
+    Session,
+    SignUpOTP,
+    UnverifiedUserProfile,
+    UserProfile,
+    VerifyUserOTP,
+)
 
 # Register your models here.
 admin.site.register(UserProfile)

zserver/models/user_profile.py

@@ -14,6 +14,8 @@ class BaseUserProfile(models.Model):
     updated_at = models.DateTimeField(auto_now=True, blank=False, null=False)
 
     class Meta:
+        """make this model abstract so that it doesn't create a table."""
+
         abstract = True # don't create a table for this model
 
     def __str__(self) -> str:
@@ -40,7 +42,7 @@ def generate_otp(self) -> str:
 # Model for unverified user profiles
 class UnverifiedUserProfile(BaseUserProfile):
     email = models.EmailField(max_length=100, blank=False, null=False, unique=False)
-    
+
     def generate_otp(self) -> str:
         """Generate a 6-digit OTP for the user."""
         generated_opt = "".join(random.choices(string.digits, k=6))
@@ -65,9 +67,10 @@ class VerifyUserOTP(models.Model):
     user = models.ForeignKey(UnverifiedUserProfile, on_delete=models.CASCADE)
     otp = models.CharField(max_length=6, blank=False, null=False)
     created_at = models.DateTimeField(auto_now_add=True, blank=False, null=False)
-    
+
     def __str__(self) -> str:
-        return self.user.email + ' ' + self.otp
+        """Return the email of the user associated with the OTP."""
+        return self.user.email + " " + self.otp
 
 
 # let's create a modle for login sessions

zserver/serializers/user_profile.py

@@ -1,6 +1,6 @@
 from rest_framework import serializers
 
-from zserver.models import Session, SignUpOTP, UserProfile, UnverifiedUserProfile, VerifyUserOTP
+from zserver.models import Session, SignUpOTP, UnverifiedUserProfile, UserProfile, VerifyUserOTP
 
 
 # Serializer class for the UserProfile model
@@ -42,7 +42,7 @@ class Meta:
         extra_kwargs = {
             "password": {"write_only": True},  # Make the password field write-only
         }
-    
+
     def validate_email(self, value: str) -> str:
         """Validate that the email is not already in use."""
         if UserProfile.objects.filter(email=value).exists():
@@ -63,13 +63,13 @@ def create(self, validated_data: dict) -> UnverifiedUserProfile:
 # serializer for VerifyUserOTP model
 class VerifyUserOTPSerializer(serializers.ModelSerializer):
     email = serializers.EmailField(max_length=100)
-    
+
     class Meta:
         """Meta class to specify the model and fields to be serialized."""
 
         model = VerifyUserOTP
         fields = ["otp", "email"]
-    
+
     def validate(self, data: dict) -> dict:
         """Validate the OTP and email."""
         email = data.get("email")
@@ -91,9 +91,9 @@ def validate(self, data: dict) -> dict:
         data["user"] = user
         data["user_otp"] = user_otp
         return data
-    
+
     def signup_user(self) -> None:
-        """ add user to UserProfile table and delete the OTP."""
+        """Add user to UserProfile table and delete the OTP."""
         user = self.validated_data["user"]
         user_profile = UserProfile(
             fullname=user.fullname,

zserver/tests/user_profile.py

@@ -3,7 +3,7 @@
 from rest_framework import status
 from rest_framework.test import APIClient
 
-from zserver.models import Session, SignUpOTP, UserProfile, UnverifiedUserProfile, VerifyUserOTP
+from zserver.models import Session, SignUpOTP, UnverifiedUserProfile, UserProfile, VerifyUserOTP
 
 
 class UserProfileViewTest(TestCase):

zserver/views/user_profile.py

@@ -15,8 +15,8 @@
     ForgotPasswordSerializer,
     ResetPasswordSerializer,
     SessionSerializer,
-    UserProfileSerializer,
     UnverifiedUserProfileSerializer,
+    UserProfileSerializer,
     VerifyUserOTPSerializer,
 )
 from zserver.utils import get_env_var
@@ -102,9 +102,9 @@ def post(self, request: Request) -> Response:
 
 
 class VerifyUserOTPView(APIView):
-    
+
     def post(self, request: Request) -> Response:
-        """verify OTP and signup user"""
+        """Verify OTP and signup user."""
         serializer = VerifyUserOTPSerializer(data=request.data)
         if serializer.is_valid():
             serializer.signup_user()