Документация библиотеки - TestDocs

OpenAV - библиотека для чего-то там …

---

Быстрый старт

Установка и обновление

Зависимости

Устанавливаются автоматически

Библиотека	Рекомендуемая версия	Текущая версия
colorama	0.4.6
numpy	1.24.0
pandas	1.5.2
prettytable	3.5.0

Примеры

Модули

Определение языка

class test_docs_2022.modules.core.language.Language(lang: str = <property object>)

Базовые классы: object

Класс для интернационализации (I18N) и локализации (L10N)

Параметры

lang (str) – Язык

__get_languages() → List[Optional[str]]

Получение поддерживаемых языков

Примечание

private (приватный метод)

Результат

Список поддерживаемых языков

Тип результата

List[Optional[str]]

__get_locales() → List[Dict[str, method]]

Получение языковых пакетов

Примечание

private (приватный метод)

Результат

Список словарей с языковыми пакетами

Тип результата

List[Dict[str, MethodType]]

__lang: str = 'ru'

Язык

Примечание

private (приватный аргумент)

__set_locale(lang: str = 'ru') → method

Установка языка

Примечание

private (приватный метод)

Параметры

lang (str) – Язык

Результат

MethodType перевода строк на один из поддерживаемых языков если метод запущен через конструктор

Тип результата

MethodType

property lang: str

Получение/установка текущего языка

Параметры

(str) –

Язык, доступные варианты:

• "ru" - Русский язык (по умолчанию)

• "en" - Английский язык

Результат

Язык

Тип результата

str

property locales: List[str]

Получение поддерживаемых языков

Результат

Список поддерживаемых языков

Тип результата

List[str]

property path_to_locales: str

Получение директории с языковыми пакетами

Результат

Директория с языковыми пакетами

Тип результата

str

Сообщения

class test_docs_2022.modules.core.messages.Messages(lang: str = <property object>)

Базовые классы: Language

Класс для сообщений

Параметры

lang (str) –

__lang: str

Язык

Примечание

private (приватный аргумент)

Настройки

class test_docs_2022.modules.core.settings.Settings(lang: str = <property object>)

Базовые классы: Messages

Класс для настроек

Параметры

lang (str) –

__lang: str

Язык

Примечание

private (приватный аргумент)

property color_blue: str

Получение синего цвета текста в терминале

Результат

Цвет текста в терминале

Тип результата

str

property color_green: str

Получение зеленого цвета текста в терминале

Результат

Цвет текста в терминале

Тип результата

str

property color_red: str

Получение красного цвета текста в терминале

Результат

Цвет текста в терминале

Тип результата

str

property text_bold: str

Получение жирного начертания текста в терминале

Результат

Жирное начертание текста в терминале

Тип результата

str

property text_end: str

Получение сброса оформления текста в терминале

Результат

Сброс оформления текста в терминале

Тип результата

str

Ядро

class test_docs_2022.modules.core.core.CoreMessages(lang: str = <property object>)

Базовые классы: Settings

Класс для сообщений

Параметры

lang (str) –

class test_docs_2022.modules.core.core.Core(lang: str = <property object>)

Базовые классы: CoreMessages

Класс-ядро модулей

Параметры

lang (str) –

inv_args(class_name: str, build_name: str, out: bool = True) → None

Сообщение об указании неверных типов аргументов

Параметры

• class_name (str) – Имя класса

• build_name (str) – Имя метода/функции

• out (bool) – Печатать процесс выполнения

Результат

None

Тип результата

None

libs_vers(out: bool = True) → bool

Получение и отображение версий установленных библиотек

Параметры

out (bool) – Отображение

Результат

True если версии установленных библиотек отображены, в обратном случае False

Тип результата

bool

message_info(message: str, space: int = 0, out: bool = True) → None

Информационное сообщение

Параметры

• message (str) – Сообщение

• space (int) – Количество пробелов в начале текста

• out (bool) – Отображение

Результат

None

Тип результата

None

Сборка

class test_docs_2022.modules.lab.build.Run(lang: str = <property object>)

Базовые классы: Core

Класс для сборки библиотеки

Параметры

lang (str) –

__lang: str

Язык

Примечание

private (приватный аргумент)

run(out: bool = True) → bool

Запуск

Параметры

out (bool) – Печатать процесс выполнения

Результат

True если запуск прошел успешно, в обратном случае False

Тип результата

bool

Определение языка

Документация для файла modules/core/language.py

Сообщения

Документация для файла modules/core/messages.py

Настройки

Документация для файла modules/core/settings.py

Ядро

Документация для файла modules/core/core.py

Сборка

Документация для файла modules/lab/build.py