Documentation libraries - TestDocs

OpenAV is a library for something out there …

---

Quick start

Installation and update

Dependencies

Installed automatically

The library	Recommended Version	Current version
colorama	0.4.6
numpy	1.24.0
pandas	1.5.2
prettytable	3.5.0

Examples

Modules

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

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

Bases: object

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

Parameters

lang (str) – Язык

__get_languages() → List[Optional[str]]

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

Note

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

Returns

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

Return type

List[Optional[str]]

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

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

Note

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

Returns

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

Return type

List[Dict[str, MethodType]]

__lang: str = 'ru'

Язык

Note

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

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

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

Note

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

Parameters

lang (str) – Язык

Returns

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

Return type

MethodType

property lang: str

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

Parameters

(str) –

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

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

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

Returns

Язык

Return type

str

property locales: List[str]

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

Returns

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

Return type

List[str]

property path_to_locales: str

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

Returns

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

Return type

str

Сообщения

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

Bases: Language

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

Parameters

lang (str) –

__lang: str

Язык

Note

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

Настройки

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

Bases: Messages

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

Parameters

lang (str) –

__lang: str

Язык

Note

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

property color_blue: str

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

Returns

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

Return type

str

property color_green: str

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

Returns

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

Return type

str

property color_red: str

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

Returns

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

Return type

str

property text_bold: str

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

Returns

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

Return type

str

property text_end: str

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

Returns

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

Return type

str

Core

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

Bases: Settings

Class for messages

Parameters

lang (str) –

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

Bases: CoreMessages

Core class of modules

Parameters

lang (str) –

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

Message about specifying invalid argument types

Parameters

• class_name (str) – Class name

• build_name (str) – Function method name

• out (bool) – Print progress

Returns

None

Return type

None

libs_vers(out: bool = True) → bool

Getting and Displaying Versions of Installed Libraries

Parameters

out (bool) – Display

Returns

True if versions of installed libraries are displayed, otherwise False

Return type

bool

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

Announcement

Parameters

• message (str) – Message

• space (int) – Number of spaces at the beginning of the text

• out (bool) – Display

Returns

None

Return type

None

Build

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

Bases: Core

Library build class

Parameters

lang (str) –

__lang: str

Language

Note

private

run(out: bool = True) → bool

Run

Parameters

out (bool) – Print progress

Returns

True if the launch was successful, otherwise False

Return type

bool

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

Documentation for modules/core/language.py file

Сообщения

Documentation for modules/core/messages.py file

Настройки

Documentation for modules/core/settings.py file

Core

Documentation for modules/core/core.py file

Build

Documentation for modules/lab/build.py file