educommon 3.12.0__py3-none-any.whl → 3.13.2__py3-none-any.whl

educommon/django/storages/atcfs/api.py

@@ -17,32 +17,33 @@ from educommon.django.storages.atcfs.exceptions import (
 
 
 class AtcfsApi:
-    """
-    Класс для работы с запросами к ATCFS
-    """
+    """Класс для работы с запросами к ATCFS."""
 
     def _build_url(self, *args):
-        """
-        Функция составления полного урла.
+        """Функция составления полного урла.
+
         :param args: составные части пути
         :return: фбсолютный урл
         """
         chunks = (settings.URL,) + args
         url = '/'.join(chunks)
+
         return url
 
     def _get_credential_headers(self):
-        """
-        Метод генерации данных для аутентификации на сервере ATCFS.
+        """Метод генерации данных для аутентификации на сервере ATCFS.
+
         :return: словарь с необходимыми для атунетификации полями
         """
         request_id = str(uuid.uuid4())
-        sign = '{vis_id}_{vis_user}_{request_id}_{secret_key}'.format(**{
-            'vis_id': settings.VIS_ID,
-            'vis_user': settings.VIS_USER,
-            'request_id': request_id,
-            'secret_key': settings.SECRET_KEY,
-        })
+        sign = '{vis_id}_{vis_user}_{request_id}_{secret_key}'.format(
+            **{
+                'vis_id': settings.VIS_ID,
+                'vis_user': settings.VIS_USER,
+                'request_id': request_id,
+                'secret_key': settings.SECRET_KEY,
+            }
+        )
         sign = hashlib.md5(sign).hexdigest()
         headers = {
             'AtcFs-VisId': settings.VIS_ID,
@@ -50,11 +51,12 @@ class AtcfsApi:
             'AtcFs-RequestId': request_id,
             'AtcFs-Sign': sign,
         }
+
         return headers
 
     def _send_request(self, method, url, headers=None, params=None, data=None):
-        """
-        Отправка запроса
+        """Отправка запроса.
+
         :param method: get|post|delete
         :param url: URL, на который отправляется запрос
         :param headers: дополнительные заголовки
@@ -71,18 +73,18 @@ class AtcfsApi:
                 headers=full_headers,
                 params=params,
                 data=data,
-                timeout=(settings.CONNECT_TIMEOUT, None)
+                timeout=(settings.CONNECT_TIMEOUT, None),
             )
         except (
             requests.exceptions.ConnectionError,
             requests.exceptions.ConnectTimeout,
-            requests.packages.urllib3.exceptions.ConnectTimeoutError
+            requests.packages.urllib3.exceptions.ConnectTimeoutError,
         ):
             raise AtcfsUnavailable()
 
     def upload_file(self, name, content):
-        """
-        Загрузка файла на сервер ATCFS
+        """Загрузка файла на сервер ATCFS.
+
         :param name: название файла
         :param content: содержимое файла
         :return: идентификатор файла на сервере ATCFS
@@ -91,34 +93,24 @@ class AtcfsApi:
         headers = {'Content-Type': 'application/octet-stream'}
         params = {'fileName': name}
         data = content
-        response = self._send_request(
-            method='post',
-            url=url,
-            headers=headers,
-            params=params,
-            data=data
-        )
+        response = self._send_request(method='post', url=url, headers=headers, params=params, data=data)
         if response.status_code != 201:
             raise Exception(response.text)
         ident = response.text
+
         return ident
 
     def download_file(self, ident):
-        """
-        Загружаем файл с сервера в память.
+        """Загружаем файл с сервера в память.
+
         :param ident: идентификатор файла
         :return: тюпл название и содержимое
         """
         url = self._build_url(settings.FILES_PATH, ident)
-        response = self._send_request(
-            method='get',
-            url=url
-        )
+        response = self._send_request(method='get', url=url)
         if response.status_code != 200:
             raise Exception(response.text)
-        _, params = cgi.parse_header(
-            response.headers.get('Content-Disposition')
-        )
+        _, params = cgi.parse_header(response.headers.get('Content-Disposition'))
         file_name = params['filename*']
         try:
             file_name = re.findall(r'UTF-8\'\'(.*)', file_name)[0]
@@ -126,49 +118,42 @@ class AtcfsApi:
         except IndexError:
             pass
         file_content = response.content
+
         return file_name, file_content
 
     def delete_file(self, ident):
-        """
-        Удаление файла на сервере ATCFS
+        """Удаление файла на сервере ATCFS.
+
         :param ident: идентификатор файла
         """
         url = self._build_url(settings.FILES_PATH, ident)
-        response = self._send_request(
-            method='delete',
-            url=url
-        )
+        response = self._send_request(method='delete', url=url)
         if response.status_code != 200:
             raise Exception(response.text)
 
     def get_file_url(self, ident):
-        """
-        Получить прямую ссылку на файл.
+        """Получить прямую ссылку на файл.
+
         :param ident: идентификатор файла
         :return: url
         """
         url = self._build_url(settings.TMP_FILE_LINK_PATH, ident)
-        response = self._send_request(
-            method='get',
-            url=url
-        )
+        response = self._send_request(method='get', url=url)
         if response.status_code != 200:
             raise Exception(response.text)
         tmp_ident = response.text
         file_url = self._build_url(settings.TMP_FILES_PATH, tmp_ident)
+
         return file_url
 
     def get_file_info(self, ident):
-        """
-        Получить информацию о файле.
+        """Получить информацию о файле.
+
         :param ident: идентификатор файла
         :return: словарь с названием файла и его размером
         """
         url = self._build_url(settings.FILE_INFO_PATH, ident)
-        response = self._send_request(
-            method='get',
-            url=url
-        )
+        response = self._send_request(method='get', url=url)
         if response.status_code != 200:
             raise Exception(response.text)
         file_json = response.json()
@@ -176,4 +161,5 @@ class AtcfsApi:
             'name': file_json['fileName'],
             'size': file_json['size'],
         }
+
         return file_info

educommon/django/storages/atcfs/app_meta.py

@@ -11,7 +11,7 @@ def register_urlpatterns():
         re_path(
             r'^atcfs_unavailable/$',
             TemplateView.as_view(template_name='atcfs_unavailable.html'),
-            name='atcfs_unavailable'
+            name='atcfs_unavailable',
         ),
     ]
 

educommon/django/storages/atcfs/management/commands/atcfs_migrate.py

@@ -29,8 +29,8 @@ from educommon.django.storages.atcfs.api import (
 
 
 def dictfetchall(cursor):
-    """
-    Вспомогательная функция.
+    """Вспомогательная функция.
+
     cursor.fetchall возвращает данные в виде списка списков:
     (('43', 'text 1'), ('44', 'text 2'), ('45', 'text 3'))
     Эта функция преобразует в вид:
@@ -40,13 +40,13 @@ def dictfetchall(cursor):
     """
     desc = cursor.description
     columns = [col[0] for col in desc]
+
     return [dict(list(zip(columns, row))) for row in cursor.fetchall()]
 
 
 class Command(BaseCommand):
-    """
-    Команда обходит все зарегистрированные модели,
-    в которых есть поля FileField.
+    """Команда обходит все зарегистрированные модели, в которых есть поля FileField.
+
     Если для поля установлен AtcfsStorage, или он установлен глобально,
     то файл переносится на сервер ATCFS.
     """
@@ -61,12 +61,13 @@ class Command(BaseCommand):
         )
 
     def __init__(self):
-        super(Command, self).__init__()
+        super().__init__()
+
         self.api = AtcfsApi()
 
     def _get_fields(self, model):
-        """
-        Выбираем в модели все переменные, являющиеся FileField-полями.
+        """Выбираем в модели все переменные, являющиеся FileField-полями.
+
         :param model: класс модели
         :return: список названий полей FileField
         """
@@ -78,20 +79,18 @@ class Command(BaseCommand):
                 continue
             if isinstance(mem, FileDescriptor):
                 fields.append(nam)
+
         return fields
 
     def _get_models(self):
-        """
-        Берем все модели, в которых есть FileField
+        """Берем все модели, в которых есть FileField.
+
         :return: список классов моделей
         """
         models = {}
 
-        is_model = lambda x: (
-            inspect.isclass(x) and
-            isinstance(x, ModelBase) and
-            not x._meta.abstract
-        )
+        def is_model(x):
+            return inspect.isclass(x) and isinstance(x, ModelBase) and not x._meta.abstract
 
         apps = settings.INSTALLED_APPS
         for app in apps:
@@ -108,18 +107,18 @@ class Command(BaseCommand):
         return models
 
     def _delete_all_files(self, models):
-        """
-        Сервисный метод. Используется для технических нужд.
-        В работе команды не учавствует.
+        """Сервисный метод.
+
+        Используется для технических нужд. В работе команды не учавствует.
         """
         for model, fields in models.items():
-            kwargs = dict(list(zip(fields, ['']*len(fields))))
+            kwargs = dict(list(zip(fields, [''] * len(fields))))
             cnt = model.objects.all().update(**kwargs)
             print('{0}: {1}'.format(model, cnt))
 
     def _send_file(self, file_name):
-        """
-        Непосредственная отправка файла на ATCFS.
+        """Непосредственная отправка файла на ATCFS.
+
         :param file_name: название файла
         :return: идентификатор файла в ATCFS
         """
@@ -127,37 +126,31 @@ class Command(BaseCommand):
         file_path = os.path.join(settings.MEDIA_ROOT, file_name)
         try:
             with open(file_path, 'r') as fd:
-                ident = self.api.upload_file(
-                    os.path.basename(file_name), fd.read()
-                )
+                ident = self.api.upload_file(os.path.basename(file_name), fd.read())
         except IOError:
             pass
+
         return ident
 
     def _get_objs(self, model, fields):
-        """
-        Запрашиваем из базы напрямую объекты по модели.
+        """Запрашиваем из базы напрямую объекты по модели.
+
         :param model: класс модели
         :param fields: список полей
         :return: список словарей в которых id и значения полей
         """
         cursor = connection.cursor()
         select_fields = ', '.join(fields)
-        where_fields = ' OR '.join(
-            ['COALESCE({0}, \'\') <> \'\''.format(field) for field in fields]
-        )
-        sql = 'SELECT id, {0} from {1} WHERE {2};'.format(
-            select_fields,
-            model._meta.db_table,
-            where_fields
-        )
+        where_fields = ' OR '.join(["COALESCE({0}, '') <> ''".format(field) for field in fields])
+        sql = 'SELECT id, {0} from {1} WHERE {2};'.format(select_fields, model._meta.db_table, where_fields)
         cursor.execute(sql)
         objs = dictfetchall(cursor)
+
         return objs
 
     def _update_objs(self, model, objs):
-        """
-        Изменяем значения полей в базе.
+        """Изменяем значения полей в базе.
+
         :param model: класс модели
         :param objs: словарь списков, где ключ - id объекта,
         а значение - список тюплов (название, значение)
@@ -165,28 +158,20 @@ class Command(BaseCommand):
         cursor = connection.cursor()
         sql = ''
         for obj_id, obj_fields in objs.items():
-            set_fields = ', '.join(
-                ['{0[0]} = \'{0[1]}\''.format(field) for field in obj_fields]
-            )
-            sql += 'UPDATE {0} SET {1} WHERE id = {2};'.format(
-                model._meta.db_table,
-                set_fields,
-                obj_id
-            )
+            set_fields = ', '.join(["{0[0]} = '{0[1]}'".format(field) for field in obj_fields])
+            sql += 'UPDATE {0} SET {1} WHERE id = {2};'.format(model._meta.db_table, set_fields, obj_id)
         if sql:
             cursor.execute(sql)
             commit_unless_managed()
 
     def _migrate_all_files(self, models):
-        """
-        Проходимся по всем моделям, всем объектам, отсылаем файлы на ATCFS.
+        """Проходимся по всем моделям, всем объектам, отсылаем файлы на ATCFS.
+
         :param models: модели, в которых есть FileField
         """
         total = len(models)
         for i, (model, fields) in enumerate(models.items(), start=1):
-            print(self.style.SQL_KEYWORD(
-                '{0} ({1}/{2})'.format(model, i, total)
-            ))
+            print(self.style.SQL_KEYWORD('{0} ({1}/{2})'.format(model, i, total)))
             objs = self._get_objs(model, fields)
             updated_objs = {}
             for obj in objs:
@@ -196,12 +181,14 @@ class Command(BaseCommand):
                     if field_value:
                         ident = self._send_file(field_value)
                         updated_fields.append((field_name, ident))
-                        print('{0},{1},{2},{3}'.format(
-                            obj['id'],
-                            field_name.decode('UTF-8'),
-                            field_value.decode('UTF-8'),
-                            ident.decode('UTF-8')
-                        ))
+                        print(
+                            '{0},{1},{2},{3}'.format(
+                                obj['id'],
+                                field_name.decode('UTF-8'),
+                                field_value.decode('UTF-8'),
+                                ident.decode('UTF-8'),
+                            )
+                        )
                 updated_objs[obj['id']] = updated_fields
             self._update_objs(model, updated_objs)
 

educommon/django/storages/atcfs/models.py

@@ -1,4 +1 @@
 # В данном случае файл используется только как точка вызова патча.
-from . import (
-    monkey_patching,
-)

educommon/django/storages/atcfs/monkey_patching.py

@@ -1,7 +1,5 @@
-"""
-Внедряем в джанговский дефолтный FieldFile необходимый функционал
-для работы с AtcfsStorage.
-"""
+"""Внедряем в джанговский дефолтный FieldFile необходимый функционал для работы с AtcfsStorage."""
+
 import re
 
 from django.core.files.storage import (
@@ -21,8 +19,8 @@ DEFAULT_FILE_STORAGE = get_storage_class()
 
 
 def is_atcfs_storage(storage):
-    """
-    Функция определяет является ли переданный storage AtcfsStorage.
+    """Функция определяет является ли переданный storage AtcfsStorage.
+
     :param storage: объект Storage
     :return: True/False
     """
@@ -30,11 +28,12 @@ def is_atcfs_storage(storage):
     # Второй случай когда в сетингсах установлен DEFAULT_FILE_STORAGE,
     # и он не переопределен через параметр storage в филде.
     if (
-        isinstance(storage, AtcfsStorage) or
-        isinstance(storage, DefaultStorage) and
-            DEFAULT_FILE_STORAGE == AtcfsStorage
+        isinstance(storage, AtcfsStorage)
+        or isinstance(storage, DefaultStorage)
+        and DEFAULT_FILE_STORAGE == AtcfsStorage
     ):
         return True
+
     return False
 
 
@@ -42,13 +41,13 @@ def is_atcfs_storage(storage):
 # Необходимо установить field_name,
 # в котором будет храниться реальное название файла.
 
-uuid_re = re.compile(
-    r'[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
-)
+uuid_re = re.compile(r'[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
 
 old_field_file__init__ = files.FieldFile.__init__
 
+
 def new_field_file__init__(self, instance, field, name):
+    """Инициализирует FieldFile с дополнительной логикой для AtcfsStorage."""
     old_field_file__init__(self, instance, field, name)
     if is_atcfs_storage(self.storage):
         if self.name and uuid_re.match(self.name):
@@ -56,6 +55,7 @@ def new_field_file__init__(self, instance, field, name):
         else:
             self.file_name = ''
 
+
 files.FieldFile.__init__ = new_field_file__init__
 
 
@@ -63,12 +63,15 @@ files.FieldFile.__init__ = new_field_file__init__
 
 old_field_file__str__ = files.FieldFile.__str__
 
+
 def new_field_file__str__(self):
+    """Возвращает строковое представление файла."""
     if is_atcfs_storage(self.storage):
         return self.file_name or ''
     else:
         return old_field_file__str__(self)
 
+
 files.FieldFile.__str__ = new_field_file__str__
 
 
@@ -76,7 +79,9 @@ files.FieldFile.__str__ = new_field_file__str__
 
 old_file_field_get_prep_value = files.FileField.get_prep_value
 
+
 def new_file_field_get_prep_value(self, value):
+    """Подготавливает значение FileField для сохранения в БД."""
     if is_atcfs_storage(self.storage):
         if value is None:
             return None
@@ -84,4 +89,5 @@ def new_file_field_get_prep_value(self, value):
     else:
         return old_file_field_get_prep_value(self, value)
 
+
 files.FileField.get_prep_value = new_file_field_get_prep_value

educommon/django/storages/atcfs/storage.py

@@ -24,20 +24,18 @@ from educommon.django.storages.atcfs.exceptions import (
 
 
 # Сообщение, выдаваемое в интерфейс при сохранении если сервер недоступен.
-ATCFS_UNAVAILABLE_MSG = '''
+ATCFS_UNAVAILABLE_MSG = """
 Извините, в настоящий момент внешнее файловое хранилище недоступно,
 сохранение приложенного файла невозможно. Пожалуйста, повторите действие позже
 или удалите приложенный файл перед сохранением.
-'''
+"""
 
 # Ссылка на файл и имя, когда недоступен сервер.
 UNAVAILABLE_FILE_NAME = 'Файл недоступен (сбой в работе файлового хранилища)'
 
 
 class AtcfsStorage(Storage):
-    """
-    ATCFS Storage
-    """
+    """ATCFS Storage."""
 
     def __init__(self):
         self.api = AtcfsApi()
@@ -55,6 +53,7 @@ class AtcfsStorage(Storage):
         except AtcfsUnavailable:
             # Выдаем сообщение непосредственно в интерфейс.
             raise ApplicationLogicException(ATCFS_UNAVAILABLE_MSG)
+
         return ident
 
     def delete(self, ident):
@@ -72,6 +71,7 @@ class AtcfsStorage(Storage):
             file_url = self.api.get_file_url(ident)
         except AtcfsUnavailable:
             file_url = reverse('atcfs_unavailable')
+
         return file_url
 
     def size(self, ident):
@@ -80,6 +80,7 @@ class AtcfsStorage(Storage):
             file_size = file_info['size']
         except AtcfsUnavailable:
             file_size = 0
+
         return file_size
 
     def name(self, ident):
@@ -88,12 +89,11 @@ class AtcfsStorage(Storage):
             file_name = file_info['name']
         except AtcfsUnavailable:
             file_name = UNAVAILABLE_FILE_NAME
+
         return file_name
 
     def path(self, ident):
-        """
-        Загружаем файл, сохраняем его во временной папке, отдаем путь.
-        """
+        """Загружаем файл, сохраняем его во временной папке, отдаем путь."""
         try:
             file_name, file_content = self.api.download_file(ident)
         except AtcfsUnavailable:
@@ -103,34 +103,25 @@ class AtcfsStorage(Storage):
         file_path = os.path.join(dir_path, file_name)
         with open(file_path, 'w') as fd:
             fd.write(file_content)
+
         return file_path
 
     def exists(self, name):
-        """
-        Заглушка
-        """
+        """Заглушка."""
         return False
 
     def listdir(self, path):
-        """
-        Заглушка
-        """
+        """Заглушка."""
         return [], []
 
     def accessed_time(self, name):
-        """
-        Заглушка
-        """
+        """Заглушка."""
         return datetime.datetime(1, 1, 1)
 
     def created_time(self, name):
-        """
-        Заглушка
-        """
+        """Заглушка."""
         return datetime.datetime(1, 1, 1)
 
     def modified_time(self, name):
-        """
-        Заглушка
-        """
+        """Заглушка."""
         return datetime.datetime(1, 1, 1)