40 lines
2.8 KiB
Markdown
40 lines
2.8 KiB
Markdown
|
# Утилиты BackEnd
|
|||
|
|
***
|
|||
|
|
>Прикладные модули необходимые для различных дополнительных функций
|
|||
|
|
## Парсер YAML
|
|||
|
|
---
|
|||
|
|
>[!YAML Парсер]
|
|||
|
|
>Модуль, который сериализует изначальный файл с описанием виджетов в разметке YAML в нативные объекты Python
|
|||
|
|
### Поля
|
|||
|
|
---
|
|||
|
|
- **Путь к файлу** - Путь к .yaml файлу *( Приватный | Аргумент конструктора)*
|
|||
|
|
- **Список агрументов** - Список аргументов виджетов *(Приватный | инициализируется методом преобразования)*
|
|||
|
|
### Методы
|
|||
|
|
---
|
|||
|
|
- **Приватный | Загрузить файл | Строка** - Загружает файл с описанием виджетов в формате YAML и возвращает его в виде строки
|
|||
|
|
- **Приватный | Преобразовать в список | None** - Преобразовывает загруженный файл в нативный Python список
|
|||
|
|
- **Публичный | Создать объект | Widget** - Принимает в качестве аргументов набор параметров виджета и создаёт на их основе объект этого виджета в зависимости от типа *(сайт / соц. сеть)*
|
|||
|
|
- **Публичный, магический, перезапись | len | int** - Возвращает кол-во виджетов полученных из файла при преобразовании
|
|||
|
|
|
|||
|
|
## Redis
|
|||
|
|
---
|
|||
|
|
>[!Redis]
|
|||
|
|
>Утилита управления базой данных по протоколу Redis
|
|||
|
|
### Поля
|
|||
|
|
---
|
|||
|
|
- **Хост Redis** - Адрес нахождения базы данных Redis *(Приватный | Аргумент конструктора)*
|
|||
|
|
### Методы
|
|||
|
|
---
|
|||
|
|
- **Публичный | Получить поле | Строка** - Получает поле из БД[^1] по id
|
|||
|
|
- **Публичный | Записать поле | Целое число** - Записывает значение поля в БД[^1], возвращает id созданного поля
|
|||
|
|
- **Публичный | Удалить поле| None** - Удаляет значение поля из БД[^1]
|
|||
|
|
- **Публичный | Очистка | None** - Обнуляет БД[^1]
|
|||
|
|
|
|||
|
|
[^1]: База данных
|
|||
|
|
## Статические ф-ии
|
|||
|
|
---
|
|||
|
|
>[!Статические функции]
|
|||
|
|
>Функции, которые не относятся к определенному модулю
|
|||
|
|
>
|
|||
|
|
|
|||
|
|
- **Инциализация БД** - Отчищает базу данных, и после заполняет её модулями, полученными из парсера YAML
|