Fix warnings

main/extra_func.py

@@ -6,9 +6,20 @@ from zenpy.lib.exception import APIException
 from main.models import UserProfile
 
 
-# Дополнительные функции
 class ZendeskAdmin:
-    # Класс существует, чтобы в каждой фунциии отдельно не проверять аккаунт администратора
+    """
+        Класс **ZendeskAdmin** существует, чтобы в каждой фунциии отдельно не проверять аккаунт администратора
+
+        :param credentials:  Полномочия пользователя (первым указывается учетная запись организации в Zendesk)
+        :type credentials: :class:`list of dictionaries`
+        :param email: Email пользователя, указанный в Zendesk
+        :type email: :class:`email`
+        :param token: Токен пользователя (формируется в Zendesk)
+        :type token: :class:`str`
+        :param password: Пароль пользователя, указанный в Zendesk
+        :type password: :class:`str`
+    """
+
     credentials = {
         'subdomain': 'ngenix1612197338'
     }
@@ -23,22 +34,54 @@ class ZendeskAdmin:
         return True if self.admin.search(email, type='user') else False
 
     def get_user_name(self, email: str) -> str:
+        """
+            Функция **get_user_name** возвращает имя пользователя
+
+            :param user_name: Имя пользователя
+            :type user_name: :class:`str`
+        """
         user = self.admin.users.search(email).values[0]
         return user.name
 
     def get_user_role(self, email: str) -> str:
+        """
+            Функция **get_user_role** возвращает роль пользователя
+
+            :param user_role: Роль пользователя
+            :type user_role: :class:`str`
+        """
         user = self.admin.users.search(email).values[0]
         return user.role
 
     def get_user_id(self, email: str) -> str:
+        """
+            Функция **get_user_id** возвращает id пользователя
+
+            :param user_id: ID пользователя
+            :type user_id: :class:`str`
+        """
         user = self.admin.users.search(email).values[0]
         return user.id
 
     def get_user_image(self, email: str) -> str:
+        """
+            Функция **get_user_image** возвращает аватар пользователя
+
+            :param user_image: Аватар пользователя
+            :type user_image: :class:`img`
+        """
         user = self.admin.users.search(email).values[0]
         return user.photo['content_url'] if user.photo else None
 
     def create_admin(self) -> None:
+        """
+                Функция **Create_admin()** создает администратора, проверяя наличие вводимых данных в env.
+
+                :param credentials: В список полномочий администратора вносятся email, token, password из env
+                :raise: :class:`ValueError`: исключение, вызываемое если email не введен в env
+                :raise: :class:`APIException`: исключение, вызываемое если пользователя с таким email не существует в Zendesk
+        """
+
         if self.email is None:
             raise ValueError('access_controller email not in env')
         self.credentials['email'] = os.getenv('ACCESS_CONTROLLER_API_EMAIL')
@@ -58,10 +101,10 @@ class ZendeskAdmin:
 
 def update_profile(user_profile: UserProfile):
     """
-    Функция обновляет профиль пользователя в соотвтетствии с текущим в Zendesk
+        Функция обновляет профиль пользователя в соотвтетствии с текущим в Zendesk
 
-    :param user_profile: Объект профиля пользователя
-    :type user_profile: :class:`main.models.UserProfile`
+        :param user_profile: Объект профиля пользователя
+        :type user_profile: :class:`main.models.UserProfile`
     """
     user_profile.name = ZendeskAdmin().get_user_name(user_profile.user.email)
     user_profile.role = ZendeskAdmin().get_user_role(user_profile.user.email)
@@ -90,7 +133,7 @@ def check_user_auth(email: str, password: str) -> bool:
     :param password: Пароль пользователя
     :type password: :class:`str`
     :return: True, если входные данные верны, иначе False
-    :raise :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
+    :raise: :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
     :rtype: :class:`bool`
     """
     creds = {

main/models.py

@@ -36,18 +36,16 @@ def save_user_profile(sender, instance, **kwargs):
 
 class RoleChangeLogs(models.Model):
     """
-    Модель для логирования изменений ролей пользователя
+        Модель для логирования изменений ролей пользователя
 
-    :param user: Пользователь, которому присвоили другую роль,
-    ForeignKey к модели :class:`django.contrib.auth.models.User`
-    :param name: Имя пользователя
-    :type name: :class:`str`
-    :param new_role: Присвоенная роль
-    :type new_role: :class:`str`
-    :param change_time: Дата изменения роли`
-    :type change_time: :class:`datetime.datetime`
-    :param changed_by: Кем была изменена роль,
-    ForeignKey к модели :class:`django.contrib.auth.models.User`
+        :param user: Пользователь, которому присвоили другую роль,  ForeignKey к модели :class:`django.contrib.auth.models.User`
+        :param name: Имя пользователя
+        :type name: :class:`str`
+        :param new_role: Присвоенная роль
+        :type new_role: :class:`str`
+        :param change_time: Дата изменения роли`
+        :type change_time: :class:`datetime.datetime`
+        :param changed_by: Кем была изменена роль, ForeignKey к модели :class:`django.contrib.auth.models.User`
     """
     user = models.ForeignKey(to=User, on_delete=models.CASCADE)
     name = models.TextField()