Tools
Tools
Общий пакет для готовых функций. Модули в этом пакете:
analysis: Позволяет находить все jpeg-файлы в директории.download: Позволяет скачать и разархивировать датасет.parser: Парсер сайта госкаталог.notebook: Позволяет обновлять идентификаторы ячеек в ноутбуке.logger_config: Позволяет настроить логгер для сервера и клиента.
display_images
Показывает изображения в графическом окне
| PARAMETER | DESCRIPTION |
|---|---|
images_per_row
|
Сколько изображений на одной строчке
TYPE:
|
image_paths
|
Список путей к изображениям
TYPE:
|
subtitle
|
Подзаголовок
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
None
|
None |
Source code in Tools/analysis.py
find_image_files
Получение списка путей к jpeg-файлам в нужной директории
| PARAMETER | DESCRIPTION |
|---|---|
directory
|
Путь к папке поиска
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
Список путей к jpeg-файлам |
Source code in Tools/analysis.py
find_needed_jpeg_files
Поиск нужных jpeg-файлов в нужной директории по их id имени
| PARAMETER | DESCRIPTION |
|---|---|
directory
|
Путь к папке поиска
TYPE:
|
target_names
|
Список имен для поиска
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
Список путей к jpeg-файлам |
Source code in Tools/analysis.py
download_zip
Скачивает zip-файл по ссылке и возвращает путь до него
| PARAMETER | DESCRIPTION |
|---|---|
url
|
ссылка на zip-файл с Yandex.Disk
TYPE:
|
path
|
место, куда нужно сохранить zip-файл
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Path
|
путь до загруженного разархивированного zip-файла |
Source code in Tools/download.py
extract_zip
Извлекает содержимое zip-файла в папку destination_directory
| PARAMETER | DESCRIPTION |
|---|---|
zip_file
|
файл с zip-архивом
TYPE:
|
destination_directory
|
место разархивирования
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Path
|
место разархивирования |
Source code in Tools/download.py
get_ya_disk_url
Возвращает ссылку на скачивание файла с https://disk.yandex.ru по публичной общей ссылке
| PARAMETER | DESCRIPTION |
|---|---|
public_key
|
публичная ссылка на файл
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
ссылка на скачивание |
Source code in Tools/download.py
configure_client_logging
configure_client_logging(log_folder=LOG_FOLDER)
configure_server_logging
configure_server_logging(log_folder=LOG_FOLDER)
Создание логгера для сервера
Source code in Tools/logger_config.py
set_cell_id
Обновляет идентификаторы ячеек в файле ноутбука от 1 до N
| PARAMETER | DESCRIPTION |
|---|---|
notebook_path
|
путь к файлу ipynb
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
1 - файл обновлен |
Source code in Tools/notebook.py
goskatalog_parser
Скачивает картины с сайта госкаталог и возвращает словарь с результатами парсинга
| PARAMETER | DESCRIPTION |
|---|---|
classes
|
список скачиваемых категорий
TYPE:
|
path
|
место куда будут сохраняться картины
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
(Path, list)
|
(путь к папке с картинами, словарь с пропущенными картинами) |
Source code in Tools/parser.py
zip_files
Создает zip-файл из папки с картинками
| PARAMETER | DESCRIPTION |
|---|---|
path
|
путь к папке с картинками
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
путь к zip-файлу |
Tools.analysis
find_image_files
Получение списка путей к jpeg-файлам в нужной директории
| PARAMETER | DESCRIPTION |
|---|---|
directory
|
Путь к папке поиска
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
Список путей к jpeg-файлам |
Source code in Tools/analysis.py
find_needed_jpeg_files
Поиск нужных jpeg-файлов в нужной директории по их id имени
| PARAMETER | DESCRIPTION |
|---|---|
directory
|
Путь к папке поиска
TYPE:
|
target_names
|
Список имен для поиска
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[str]
|
Список путей к jpeg-файлам |
Source code in Tools/analysis.py
display_images
Показывает изображения в графическом окне
| PARAMETER | DESCRIPTION |
|---|---|
images_per_row
|
Сколько изображений на одной строчке
TYPE:
|
image_paths
|
Список путей к изображениям
TYPE:
|
subtitle
|
Подзаголовок
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
None
|
None |
Source code in Tools/analysis.py
get_image_json_info
Извлечение информации об изображении из JSON-файла
| PARAMETER | DESCRIPTION |
|---|---|
path
|
Путь к изображению
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
dict
|
Словарь с информацией о JSON-файле |
Source code in Tools/analysis.py
Tools.parser
goskatalog_parser
Скачивает картины с сайта госкаталог и возвращает словарь с результатами парсинга
| PARAMETER | DESCRIPTION |
|---|---|
classes
|
список скачиваемых категорий
TYPE:
|
path
|
место куда будут сохраняться картины
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
(Path, list)
|
(путь к папке с картинами, словарь с пропущенными картинами) |
Source code in Tools/parser.py
download_art
Скачивает одну картину с сайта и сохраняет ее в папку вместе с JSON-файлом
| PARAMETER | DESCRIPTION |
|---|---|
art
|
словарь с данными картины
TYPE:
|
path
|
путь к папке
TYPE:
|
session
|
сессия для запросов
TYPE:
|
Source code in Tools/parser.py
zip_files
Создает zip-файл из папки с картинками
| PARAMETER | DESCRIPTION |
|---|---|
path
|
путь к папке с картинками
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
путь к zip-файлу |
Tools.download
get_ya_disk_url
Возвращает ссылку на скачивание файла с https://disk.yandex.ru по публичной общей ссылке
| PARAMETER | DESCRIPTION |
|---|---|
public_key
|
публичная ссылка на файл
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
ссылка на скачивание |
Source code in Tools/download.py
download_zip
Скачивает zip-файл по ссылке и возвращает путь до него
| PARAMETER | DESCRIPTION |
|---|---|
url
|
ссылка на zip-файл с Yandex.Disk
TYPE:
|
path
|
место, куда нужно сохранить zip-файл
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Path
|
путь до загруженного разархивированного zip-файла |
Source code in Tools/download.py
extract_zip
Извлекает содержимое zip-файла в папку destination_directory
| PARAMETER | DESCRIPTION |
|---|---|
zip_file
|
файл с zip-архивом
TYPE:
|
destination_directory
|
место разархивирования
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Path
|
место разархивирования |
Source code in Tools/download.py
Tools.notebook
set_cell_id
Обновляет идентификаторы ячеек в файле ноутбука от 1 до N
| PARAMETER | DESCRIPTION |
|---|---|
notebook_path
|
путь к файлу ipynb
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
1 - файл обновлен |
Source code in Tools/notebook.py
Tools.logger_config
InterceptHandler
Bases: Handler
Интеграция loguru с uvicorn. Default handler from examples in loguru documentation. See https://loguru.readthedocs.io/en/stable/overview.html#entirely-compatible-with-standard-logging https://pawamoy.github.io/posts/unify-logging-for-a-gunicorn-uvicorn-app/
emit
Source code in Tools/logger_config.py
setup_logger
Настройка loguru для записи логов.
| PARAMETER | DESCRIPTION |
|---|---|
log_file
|
Путь к файлу для записи логов. Если None, логирование будет только в stdout.
DEFAULT:
|
Source code in Tools/logger_config.py
configure_client_logging
configure_client_logging(log_folder=LOG_FOLDER)
configure_server_logging
configure_server_logging(log_folder=LOG_FOLDER)
Создание логгера для сервера