Add typehints

docs/source/conf.py

@@ -134,6 +134,7 @@ extensions = [
     'sphinx.ext.graphviz',
     'sphinx.ext.napoleon',
     'sphinx.ext.inheritance_diagram',
+    'sphinx_autodoc_typehints'
 
 ]
 
@@ -200,3 +201,8 @@ spelling_ignore_pypi_package_names = True
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
+
+set_type_checking_flag = True
+typehints_fully_qualified = True
+always_document_param_types = True
+typehints_document_rtype = True

main/extra_func.py

@@ -20,65 +20,54 @@ class ZendeskAdmin:
         :type token: :class:`str`
         :param password: Пароль администратора, указанный в env
         :type password: :class:`str`
+
     """
 
-    credentials = {
+    credentials:dict = {
         'subdomain': 'ngenix1612197338'
     }
-    email = os.getenv('ACCESS_CONTROLLER_API_EMAIL')
-    token = os.getenv('ACCESS_CONTROLLER_API_TOKEN')
-    password = os.getenv('ACCESS_CONTROLLER_API_PASSWORD')
+    email: str = os.getenv('ACCESS_CONTROLLER_API_EMAIL')
+    token: str = os.getenv('ACCESS_CONTROLLER_API_TOKEN')
+    password: str = os.getenv('ACCESS_CONTROLLER_API_PASSWORD')
 
     def __init__(self):
         self.create_admin()
 
     def check_user(self, email: str) -> bool:
         """
-            Функция **check_user** осуществляет проверку существования пользователя в Zendesk
+            Функция **check_user** осуществляет проверку существования пользователя в Zendesk по email
 
-            :param email: Электронная почта пользователя
-            :type email: :class:`email`
-            :return: True, если существует, иначе False
-            :rtype: :class:`bool`
         """
         return True if self.admin.search(email, type='user') else False
 
     def get_user_name(self, email: str) -> str:
         """
-            Функция **get_user_name** возвращает имя пользователя
+            Функция **get_user_name** возвращает имя пользователя по его email
 
-            :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** возвращает роль пользователя
+            Функция **get_user_role** возвращает роль пользователя по его email
 
-            :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 пользователя
+            Функция **get_user_id** возвращает id пользователя по его email
 
-            :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** возвращает аватар пользователя
+            Функция **get_user_image** возвращает аватар пользователя по его email
 
-            :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