From 774cbbe8029c4845ba2d68336b7d53dc7b1f3982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D1=82=D0=B5=D0=BF=D0=B0=D0=BD=D0=B5=D0=BD=D0=BA?= =?UTF-8?q?=D0=BE=20=D0=9E=D0=BB=D1=8C=D0=B3=D0=B0?= Date: Thu, 18 Feb 2021 09:19:00 +0300 Subject: [PATCH] Fix warnings --- main/extra_func.py | 55 +++++++++++++++++++++++++++++++++++++++++----- main/models.py | 20 ++++++++--------- 2 files changed, 58 insertions(+), 17 deletions(-) diff --git a/main/extra_func.py b/main/extra_func.py index 73c533b..7a0a2de 100644 --- a/main/extra_func.py +++ b/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 = { diff --git a/main/models.py b/main/models.py index e7d356d..3e3fe29 100644 --- a/main/models.py +++ b/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()