From c1805af420d5a1b72737be1fa12a44bd8d898a00 Mon Sep 17 00:00:00 2001 From: kolo Date: Tue, 8 Apr 2025 00:28:17 +0300 Subject: [PATCH] final work on dividing line --- README.md | 34 ++++++++++++++++++++++++++++++++-- pyproject.toml | 2 +- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8884e18..0dc837e 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ App(prompt: str = 'What do you want to do?\n', exit_command_description: str = 'Exit command', system_points_title: str = 'System points:', ignore_command_register: bool = True, - dividing_line: str = '-----', + dividing_line: StaticDividingLine | DynamicDividingLine = StaticDividingLine(), repeat_command_groups: bool = True, print_func: Callable[[str], None] = Console().print) ``` @@ -115,7 +115,7 @@ App(prompt: str = 'What do you want to do?\n', - `exit_command_description` (`str`): Описание команды выхода. - `system_points_title` (`str`): Заголовок перед списком системных команд. - `ignore_command_register` (`bool`): Игнорировать регистр всех команд. -- `dividing_line` (`str`): Разделительная строка между командами. +- `dividing_line` (`StaticDividingLine | DynamicDividingLine`): Разделительная строка. - `repeat_command_groups` (`bool`): Повторять описание команд перед вводом. - `print_func` (`Callable[[str], None]`): Функция вывода текста в терминал. @@ -236,6 +236,36 @@ App(prompt: str = 'What do you want to do?\n', --- +## *class* :: `StaticDivideLine` +Класс, экземпляр которого представляет собой строковый разделитель фиксированной длины + +### Конструктор +```python +StaticDivideLine(unit_part: str = '-', + length: int = 25) +``` + +**Аргументы:** +- **name : mean** +- `unit_part` (`str`): Единичная часть строкового разделителя +- `length` (`int`): Длина строкового разделителя + +--- + +## *class* :: `DinamicDivideLine` +Строковый разделитель динамической длины, которая определяется длиной обрамляемого вывода команды + +### Конструктор +```python +DinamicDivideLine(unit_part: str = '-') +``` + +**Аргументы:** +- **name : mean** +- `unit_part` (`str`): Единичная часть строкового разделителя + +--- + ## *class* :: `Router` Класс, который определяет и конфигурирует обработчики команд diff --git a/pyproject.toml b/pyproject.toml index 32bc982..b2320e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "argenta" -version = "0.4.7" +version = "0.4.8" description = "Python library for creating TUI" authors = [ {name = "kolo", email = "kolo.is.main@gmail.com"}