Merge pull request #244 from PROCOLLAB-github/feature/type-hints

stubs + типизация моделей и сериалайзеров в приложении users

Author: yakser

mypy.ini

@@ -0,0 +1,7 @@
+[mypy]
+plugins =
+    mypy_django_plugin.main
+    mypy_drf_plugin.main
+
+[mypy.plugins.django-stubs]
+django_settings_module = "procollab.settings"

poetry.lock

@@ -61,6 +61,8 @@ django-prometheus = "^2.3.1"
 loguru = "^0.7.1"
 tablib = {extras = ["xlsx"], version = "^3.5.0"}
 django-redis = "^5.3.0"
+django-stubs = {extras = ["compatible-mypy"], version = "^4.2.6"}
+djangorestframework-stubs = {extras = ["compatible-mypy"], version = "^3.14.4"}
 
 
 [build-system]

pyproject.toml

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.3 on 2023-12-02 16:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("users", "0041_alter_customuser_options"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="expert",
+            options={"verbose_name": "Эксперт", "verbose_name_plural": "Эксперты"},
+        ),
+        migrations.AlterModelOptions(
+            name="investor",
+            options={"verbose_name": "Инвестор", "verbose_name_plural": "Инвесторы"},
+        ),
+        migrations.AlterModelOptions(
+            name="member",
+            options={"verbose_name": "Участник", "verbose_name_plural": "Участники"},
+        ),
+        migrations.AlterModelOptions(
+            name="mentor",
+            options={"verbose_name": "Ментор", "verbose_name_plural": "Менторы"},
+        ),
+    ]

users/migrations/0042_alter_expert_options_alter_investor_options_and_more.py

@@ -1,7 +1,7 @@
 from django.contrib.auth.models import AbstractUser
 from django.db import models
 from django.db.models import QuerySet
-
+from django_stubs_ext.db.models import TypedModelMeta
 from users.constants import (
     ADMIN,
     EXPERT,
@@ -149,7 +149,7 @@ def get_full_name(self) -> str:
     def __str__(self) -> str:
         return f"User<{self.id}> - {self.first_name} {self.last_name}"
 
-    class Meta:
+    class Meta(TypedModelMeta):
         verbose_name = "Пользователь"
         verbose_name_plural = "Пользователи"
         # order by count of fields inputted, like avatar, key_skills, about_me, etc.
@@ -181,7 +181,7 @@ class UserAchievement(models.Model):
     def __str__(self):
         return f"UserAchievement<{self.id}>"
 
-    class Meta:
+    class Meta(TypedModelMeta):
         verbose_name = "Достижение"
         verbose_name_plural = "Достижения"
 
@@ -207,7 +207,7 @@ class AbstractUserWithRole(models.Model):
         null=True,
     )
 
-    class Meta:
+    class Meta(TypedModelMeta):
         abstract = True
 
 
@@ -244,7 +244,7 @@ def toggle_like(self):
     def __str__(self):
         return f"LikesOnProject<{self.id}>"
 
-    class Meta:
+    class Meta(TypedModelMeta):
         verbose_name = "Лайк на проект"
         verbose_name_plural = "Лайки на проекты"
         unique_together = ("user", "project")
@@ -268,6 +268,10 @@ class Member(models.Model):
 
     useful_to_project = models.TextField(blank=True)
 
+    class Meta(TypedModelMeta):
+        verbose_name = "Участник"
+        verbose_name_plural = "Участники"
+
     def __str__(self):
         return f"Member<{self.id}> - {self.user.first_name} {self.user.last_name}"
 
@@ -291,6 +295,10 @@ class Mentor(AbstractUserWithRole):
     preferred_industries = models.CharField(max_length=4096, null=True, blank=True)
     useful_to_project = models.TextField(blank=True)
 
+    class Meta(TypedModelMeta):
+        verbose_name = "Ментор"
+        verbose_name_plural = "Менторы"
+
     def __str__(self):
         return f"Mentor<{self.id}> - {self.user.first_name} {self.user.last_name}"
 
@@ -314,7 +322,9 @@ class Expert(AbstractUserWithRole):
     preferred_industries = models.CharField(max_length=4096, null=True, blank=True)
     useful_to_project = models.TextField(blank=True)
 
-    # TODO reviews
+    class Meta(TypedModelMeta):
+        verbose_name = "Эксперт"
+        verbose_name_plural = "Эксперты"
 
     def __str__(self):
         return f"Expert<{self.id}> - {self.user.first_name} {self.user.last_name}"
@@ -338,6 +348,10 @@ class Investor(AbstractUserWithRole):
     preferred_industries = models.CharField(max_length=4096, null=True, blank=True)
     interaction_process_description = models.TextField(blank=True)
 
+    class Meta(TypedModelMeta):
+        verbose_name = "Инвестор"
+        verbose_name_plural = "Инвесторы"
+
     def __str__(self):
         return f"Investor<{self.id}> - {self.user.first_name} {self.user.last_name}"
 
@@ -363,7 +377,7 @@ class UserLink(models.Model):
     def __str__(self):
         return f"UserLink<{self.id}> - {self.user.first_name} {self.user.last_name}"
 
-    class Meta:
+    class Meta(TypedModelMeta):
         verbose_name = "Ссылка пользователя"
         verbose_name_plural = "Ссылки пользователей"
         unique_together = ("user", "link")