Edit docstrings, add datetime_created to CustomUser, refactor Member and Mentor fields

Author: yakser

users/admin.py

@@ -36,10 +36,7 @@ class CustomUserAdmin(admin.ModelAdmin):
             {
                 "fields": (
                     "about_me",
-                    # "key_skills",
-                    # "useful_to_project",
                     "status",
-                    # "speciality",
                     "city",
                     "region",
                     "organization",

users/migrations/0012_remove_member_speciality_remove_mentor_job_and_more.py

@@ -0,0 +1,43 @@
+# Generated by Django 4.1.2 on 2022-11-06 14:37
+
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("industries", "0001_initial"),
+        ("users", "0011_expert_additional_role_investor_additional_role_and_more"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="member",
+            name="speciality",
+        ),
+        migrations.RemoveField(
+            model_name="mentor",
+            name="job",
+        ),
+        migrations.AddField(
+            model_name="customuser",
+            name="datetime_created",
+            field=models.DateTimeField(
+                auto_now_add=True, default=django.utils.timezone.now
+            ),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="member",
+            name="preferred_industries",
+            field=models.ManyToManyField(
+                blank=True, related_name="members", to="industries.industry"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="member",
+            name="key_skills",
+            field=models.CharField(blank=True, max_length=512),
+        ),
+    ]

users/models.py

@@ -4,7 +4,6 @@
 from django.dispatch import receiver
 
 from industries.models import Industry
-
 from users.managers import CustomUserManager
 
 
@@ -14,26 +13,27 @@ def get_default_user_type():
 
 class CustomUser(AbstractUser):
     """
-    User model
+    CustomUser model
+
+    This model is used to store the user common information.
 
     Attributes:
         email: CharField instance of user's email.
         first_name: CharField instance of the user first name.
         last_name: CharField instance of the user last name.
-        patronymic: CharField instance of the user patronymic.
         password: CharField instance of the user password.
         is_active: Boolean indicating if user confirmed email.
-        birthday: DateField instance of the user's birthday.
+        user_type: PositiveSmallIntegerField indicating the user's type according  to VERBOSE_USER_TYPES.
+        patronymic: CharField instance of the user patronymic.
         avatar: URLField instance of the user's avatar url.
-        key_skills: CharField instance of user skills containing keys.
-        useful_to_project: CharField instance of the something useful... TODO
+        birthday: DateField instance of the user's birthday.
         about_me: TextField instance contains information about the user.
         status: CharField instance notifies about the user's status.
-        speciality: CharField instance the user's specialty.
-        city: CharField instance the user's name city.
         region: CharField instance the user's name region.
+        city: CharField instance the user's name city.
         organization: CharField instance the user's place of study or work.
-        tags: CharField instance tags. TODO
+        datetime_updated: A DateTimeField indicating date of update.
+        datetime_created: A DateTimeField indicating date of creation.
     """
 
     ADMIN = 0
@@ -56,14 +56,12 @@ class CustomUser(AbstractUser):
     last_name = models.CharField(max_length=255, blank=False)
     password = models.CharField(max_length=255, blank=False)
     is_active = models.BooleanField(default=False, editable=False)
-    datetime_updated = models.DateTimeField(auto_now=True)
-
     user_type = models.PositiveSmallIntegerField(
         choices=VERBOSE_USER_TYPES,
         default=get_default_user_type,
     )
 
-    patronymic = models.CharField(max_length=255, blank=True)  # Отчество
+    patronymic = models.CharField(max_length=255, blank=True)
     avatar = models.URLField(null=True, blank=True)
     birthday = models.DateField(null=True)
     about_me = models.TextField(blank=True)
@@ -72,6 +70,9 @@ class CustomUser(AbstractUser):
     city = models.CharField(max_length=255, blank=True)
     organization = models.CharField(max_length=255, blank=True)
 
+    datetime_updated = models.DateTimeField(null=False, auto_now=True)
+    datetime_created = models.DateTimeField(null=False, auto_now_add=True)
+
     USERNAME_FIELD = "email"
     REQUIRED_FIELDS = []
 
@@ -87,6 +88,17 @@ def __str__(self):
 
 
 class AbstractUserWithRole(models.Model):
+    """
+    AbstractUserWithRole abstract model
+
+    This model adds additional role field to the user model.
+
+    Attributes:
+        additional_role: PositiveSmallIntegerField indicating the user's additional role
+                         according to VERBOSE_ROLE_TYPES.
+
+    """
+
     MENTOR = 2
     EXPERT = 3
     INVESTOR = 4
@@ -107,13 +119,28 @@ class Meta:
 
 
 class Member(models.Model):
+    """
+    Member model
+
+    Represents the CustomUser with the MEMBER user type.
+
+    Attributes:
+        user: ForeignKey instance of the CustomUser model.
+        key_skills: CharField instance indicating member key skills.
+        useful_to_project: TextField instance indicates actions useful
+                           for the development and maintenance of the project.
+        preferred_industries: ManyToManyField indicating user industries preferred for work.
+    """
+
     user = models.OneToOneField(
         CustomUser, on_delete=models.CASCADE, related_name="member"
     )
 
-    key_skills = models.CharField(max_length=255, blank=True)  # TODO
+    key_skills = models.CharField(max_length=512, blank=True)
     useful_to_project = models.TextField(blank=True)
-    speciality = models.CharField(max_length=255, blank=True)
+    preferred_industries = models.ManyToManyField(
+        Industry, blank=True, related_name="members"
+    )
 
     def __str__(self):
         return f"Member<{self.id}> - {self.user.first_name} {self.user.last_name}"
@@ -123,16 +150,19 @@ class Mentor(AbstractUserWithRole):
     """
     Mentor model
 
+    Represents the CustomUser with the MENTOR user type.
+
     Attributes:
-            job: CharField instance current user job.
-            useful_to_project: CharField instance some text.
+            user: ForeignKey instance of the CustomUser model.
+            useful_to_project: TextField instance indicates actions useful
+                               for the development and maintenance of the project.
     """
 
     user = models.OneToOneField(
         CustomUser, on_delete=models.CASCADE, related_name="mentor"
     )
-
-    job = models.CharField(max_length=255, blank=True)
+    # CustomUser already has a field called "organization"
+    # job = models.CharField(max_length=255, blank=True)
     useful_to_project = models.TextField(blank=True)
 
     def __str__(self):
@@ -143,9 +173,12 @@ class Expert(AbstractUserWithRole):
     """
     Expert model
 
+    Represents the CustomUser with the EXPERT user type.
+
     Attributes:
-            preferred_industries: CharField instance TODO
-            useful_to_project: CharField instance TODO
+            preferred_industries: ManyToManyField indicating user industries preferred for work.
+            useful_to_project: TextField instance indicates actions useful
+                               for the development and maintenance of the project.
     """
 
     user = models.OneToOneField(
@@ -167,8 +200,10 @@ class Investor(AbstractUserWithRole):
     """
     Investor model
 
+    Represents the CustomUser with the INVESTOR user type.
+
     Attributes:
-            preferred_industries: CharField instance TODO
+            preferred_industries: ManyToManyField indicating user industries preferred for work.
             interaction_process_description: CharField describes the interaction process.
 
     """

users/serializers.py

@@ -10,15 +10,14 @@ class Meta:
         fields = [
             "key_skills",
             "useful_to_project",
-            "speciality",
+            "preferred_industries",
         ]
 
 
 class MentorSerializer(serializers.ModelSerializer):
     class Meta:
         model = Mentor
         fields = [
-            "job",
             "useful_to_project",
             "additional_role",
         ]