draw lines package

Обзор

Модуль Python для рисования стиля и цветных линий в терминале. Эта утилита позволяет настраивать стили линий, цвета и позиционирование текста, что делает его универсальным инструментом для улучшения вывода приложений CLI.

Функции

• Настраиваемые текстовые позиции: слева, справа или центр.
• Поддержка различных текстовых цветов и стилей, включая жирные шрифты.
• Регулируемая ширина линии и прокладка.
• Использует colorama для обработки цвета и стиля, обеспечивая совместимость в различных операционных системах.

Установка

pip install wolfsoftware.drawlines

Использование

Основная функциональность обеспечивается функцией draw_line , которая может использоваться для создания строк в терминале с или без текста.

Функция подписи

 def draw_line ( text = '' , position = 'center' , fill_char = '-' , pad = 2 , width = - 1 , color = '' ):
    """
    Draw a line across the terminal with optional text.

    Args:
        text (str): Text to include in the line. Defaults to '' (no text).
        position (str): Position of the text ('left', 'right', 'center'). Defaults to 'center'.
        fill_char (str): Character used to fill the line. Defaults to '-'.
        pad (int): Padding characters around the text. Defaults to 2.
        width (int): Total width of the line; defaults to the terminal width if set to -1.
        color (str): Color and style of the text, e.g., 'red', 'blue+bold'. Defaults to no color.
    """

Примеры

1. Простая строка с настройками по умолчанию

 from your_module import draw_line

# Draw a simple dashed line
print ( draw_line ())

Выход

------------------------------------------------------------------------------------------

2. Линия с центрированным текстом и пользовательским цветом

 # Draw a line with centered text
print ( draw_line ( text = "Hello, World!" , position = 'center' ))

Выход

------------------------------------- Hello, World ! --------------------------------------

Если вы установите fill_char=' ' вы просто получите центрированный текст без строки.

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

 # Draw a line with left-aligned text and asterisk fill character
print ( draw_line ( text = "Left aligned text" , position = 'left' , fill_char = '*' ))

Выход

 ** Left aligned text ********************************************************************* 

Настройка

В этом разделе приведены подробную информацию о том, как вы можете настроить параметры функции draw_line . Ниже приведена таблица, в которой перечислены каждый параметр, его значение по умолчанию, цель и разрешенные значения:

Имя	Значение по умолчанию	Цель	Разрешенные значения
текст	''	Любая строка, которую вы хотите отобразить в линии.	Любая строка
позиция	'центр'	Где разместить текст.	«слева», «Центр», «Право»
fill_char	'-'	Персонаж для использования при рисовании линии. Если дано более одного, используется только первый.	Любой единственный персонаж
левый_Пад	2	Сколько fill_chars использовать в качестве префикса при выравнивании оставшегося текста.	Любое положительное целое число
right_pad	2	Сколько FILL_CHARS использовать в качестве постфикса при выравнивании текста.	Любое положительное целое число
ширина	-1	Как широко нарисовать линию. По умолчанию ширину терминала за вычетом одного, если не указано.	Любое целое число; -1 для ширины терминала минус 1
цвет	''	Какой цвет сделать текст.	«Жирный», «черный», «синий», «cyan», «green», «grey», «magent», «красный», «белый», «желтый», «черный+жирный», «синий+жирный», «Голубая+жирный», «зеленый+жирный», «серый+жирный», «magenta+bold», «Red+Bold», «Белый», «Белый», «Белый», «Белый».
смелый	ЛОЖЬ	Если текст будет смелым. Это может быть использовано с определенным цветом или без него.	Правда, ложь

Если вы добавляете жирным шрифтом в цвет, он должен прийти после названия цвета. EB Cyan+Bold не Bold+Cyan, так как это приведет к брошению исключения.