rich/README.ru.md

English readme • 简体中文 readme • 正體中文 readme • Lengua española readme • Deutsche readme • Läs på svenska • 日本語 readme • 한국어 readme • Français readme • Schwizerdütsch readme • हिन्दी readme • Português brasileiro readme • Italian readme • Русский readme

Rich это Python библиотека позволяющая отображать красивый текст и форматировать терминал.

Rich API упрощает добавление цветов и стилей к выводу терминала. Rich также позволяет отображать красивые таблицы, прогресс бары, markdown, код с отображением синтаксиса, ошибки, и т.д. — прямо после установки.

Для видео инструкции смотрите calmcode.io от @fishnets88.

Посмотрите что люди думают о Rich.

Cовместимость

Rich работает с Linux, OSX, и Windows. True color / эмоджи работают с новым терминалом Windows, классический терминал лимитирован 16 цветами. Rich требует Python 3.6.1 или более новый.

Rich работает с Jupyter notebooks без дополнительной конфигурации.

Установка

Установите с pip или вашим любимым PyPI менеджером пакетов.

python -m pip install rich

Запустите следующею команду чтобы проверить Rich вывод в вашем терминале:

python -m rich

Rich Print

Простейший способ получить красивый вывод это импортировать метод rich print, он принимает такие же аргументы что и стандартный метод print. Попробуйте:

from rich import print

print("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", locals())

Rich REPL

Rich может быть установлен в Python REPL, так, все данные будут выведены через Rich.

>>> from rich import pretty
>>> pretty.install()

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

Для большего контроля над терминалом Rich, импортируйте и инициализируйте класс Console.

from rich.console import Console

console = Console()

У класса console есть метод print который имеет идентичный функционал к встроеной функции print. Вот пример использования:

console.print("Hello", "World!")

Как вы могли подумать, этот выведет "Hello World!" в терминал. Запомните что, в отличии от встроеной функции print, Rich увеличит ваш текст так, чтобы он распространялся на всю ширину терминала.

Есть несколько способов добавить цвет и стиль к вашему выводу. Вы можете выбрать стиль для всего вывода добавив аргумент style. Вот пример:

console.print("Hello", "World!", style="bold red")

Вывод будет выглядить примерно так:

Этого достаточно чтобы стилизовать 1 строку. Для более детального стилизования, Rich использует специальную разметку похожую по синтаксису на bbcode. Вот пример:

console.print("Where there is a [bold cyan]Will[/bold cyan] there [u]is[/u] a [i]way[/i].")

Вы можете использовать класс Console чтобы генерировать утонченный вывод с минимальными усилиями. Смотрите документацию Console API для детального объяснения.

Rich Inspect

В Rich есть функция inspect которая может украсить любой Python объект, например класс, переменная, или функция.

>>> my_list = ["foo", "bar"]
>>> from rich import inspect
>>> inspect(my_list, methods=True)

Смотрите документацию inspect для детального объяснения.

Библиотека Rich

Rich содержит несколько встроенных визуализаций которые вы можете использовать чтобы сделать элегантный вывод в важем CLI или помочь в дебаггинге кода.

Вот несколько вещей которые может делать Rich (нажмите чтобы узнать больше):

Лог

В классе console есть метод log() который похож на print(), но также изображает столбец для текущего времени, файла и линии кода которая вызвала метод. По умолчанию Rich будет подсвечивать синтаксис для структур Python и для строк repr. Если вы передадите в метод коллекцию (т.е. dict или list) Rich выведет её так, чтобы она помещалась в доступном месте. Вот пример использования этого метода.

from rich.console import Console
console = Console()

test_data = [
    {"jsonrpc": "2.0", "method": "sum", "params": [None, 1, 2, 4, False, True], "id": "1",},
    {"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
    {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": "2"},
]

def test_log():
    enabled = False
    context = {
        "foo": "bar",
    }
    movies = ["Deadpool", "Rise of the Skywalker"]
    console.log("Hello from", console, "!")
    console.log(test_data, log_locals=True)


test_log()

Код выше выведет это:

Запомните аргумент log_locals, он выводит таблицу имеющую локальные переменные функции в которой метод был вызван.

Метод может быть использован для вывода данных в терминал в длинно-работающих программ, таких как сервера, но он также может помочь в дебаггинге.

Обработчик Логов

Вы также можете использовать встроенный класс Handler чтобы форматировать и раскрашивать вывод из встроенной библиотеки logging. Вот пример вывода:

Эмоджи

Чтобы вставить эмоджи в вывод консоли поместите название между двумя двоеточиями. Вот пример:

>>> console.print(":smiley: :vampire: :pile_of_poo: :thumbs_up: :raccoon:")
😃 🧛 💩 👍 🦝

Пожалуйста, используйте это мудро.

Таблицы

Rich может отображать гибкие таблицы с символами unicode. Есть большое количество форматов границ, стилей, выравниваний ячеек и т.п.

Эта анимация была сгенерирована с помощью table_movie.py в директории примеров.

Вот пример более простой таблицы:

from rich.console import Console
from rich.table import Table

console = Console()

table = Table(show_header=True, header_style="bold magenta")
table.add_column("Date", style="dim", width=12)
table.add_column("Title")
table.add_column("Production Budget", justify="right")
table.add_column("Box Office", justify="right")
table.add_row(
    "Dec 20, 2019", "Star Wars: The Rise of Skywalker", "$275,000,000", "$375,126,118"
)
table.add_row(
    "May 25, 2018",
    "[red]Solo[/red]: A Star Wars Story",
    "$275,000,000",
    "$393,151,347",
)
table.add_row(
    "Dec 15, 2017",
    "Star Wars Ep. VIII: The Last Jedi",
    "$262,000,000",
    "[bold]$1,332,539,889[/bold]",
)

console.print(table)

Этот пример выводит:

Запомните что разметка консоли отображается таким же способом что и print() и log(). На самом деле, всё, что может отобразить Rich может быть в заголовках или рядах (даже другие таблицы).

Класс Table достаточно умный чтобы менять размер столбцов, так, чтобы они заполняли доступную ширину терминала, обёртывая текст как нужно. Вот тот же самый пример с терминалом меньше таблицы:

Прогресс Бары

Rich может отображать несколько плавных прогресс баров чтобы отслеживать долго-идущие задания.

Для базового использования, оберните любую последовательность в функции track и переберите результат. Вот пример:

from rich.progress import track

for step in track(range(100)):
    do_step(step)

Отслеживать больше чем 1 задание не сложнее. Вот пример взятый из документации:

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

Чтобы попробовать самому, скачайте examples/downloader.py который может скачать несколько URL одновременно пока отображая прогресс.

Статус

Для ситуаций где сложно высчитать прогресс, вы можете использовать метод статус который будет отображать крутящуюся анимацию и сообщение. Анимация не перекроет вам доступ к консоли. Вот пример:

from time import sleep
from rich.console import Console

console = Console()
tasks = [f"task {n}" for n in range(1, 11)]

with console.status("[bold green]Working on tasks...") as status:
    while tasks:
        task = tasks.pop(0)
        sleep(1)
        console.log(f"{task} complete")

Это генерирует вот такой вывод в консоль.

Крутящиеся анимации были взяты из cli-spinners. Вы можете выбрать одну из них указав параметр spinner. Запустите следующую команду чтобы узнать доступные анимации:

python -m rich.spinner

Эта команда выдаёт вот такой вывод в терминал:

Дерево

Rich может отобразить дерево с указаниями. Дерево идеально подходит для отображения структуры файлов или любых других иерархических данных.

Ярлыки дерева могут быть простым текстом или любой другой вещью Rich может отобразить. Запустите следующую команду для демонстрации:

python -m rich.tree

Это генерирует следующий вывод:

Смотрите пример tree.py для скрипта который отображает дерево любой директории, похоже на команду linux tree.

Столбцы

Rich может отображать контент в столбцах с равной или оптимальной шириной. Вот очень простой пример клона команды ls (MacOS / Linux) который отображает a файлы директории в столбцах:

import os
import sys

from rich import print
from rich.columns import Columns

directory = os.listdir(sys.argv[1])
print(Columns(directory))

Следующий скриншот это вывод из примера столбцов который изображает данные взятые из API в столбцах:

Markdown

Rich может отображать markdown и делает неплохую работу в форматировании под терминал.

Чтобы отобразить markdown импортируйте класс Markdown и инициализируйте его с помощью строки содержащей код markdown. После чего выведите его в консоль. Вот пример:

from rich.console import Console
from rich.markdown import Markdown

console = Console()
with open("README.md") as readme:
    markdown = Markdown(readme.read())
console.print(markdown)

Это выведет что-то похожее на это:

Подсвечивание Синтаксиса

Rich использует библиотеку pygments чтобы имплементировать подсвечивание синтаксиса. Использование похоже на отображение markdown; инициализируйте класс Syntax и выводите его в консоль. Вот пример:

from rich.console import Console
from rich.syntax import Syntax

my_code = '''
def iter_first_last(values: Iterable[T]) -> Iterable[Tuple[bool, bool, T]]:
    """Iterate and generate a tuple with a flag for first and last value."""
    iter_values = iter(values)
    try:
        previous_value = next(iter_values)
    except StopIteration:
        return
    first = True
    for value in iter_values:
        yield first, False, previous_value
        first = False
        previous_value = value
    yield first, True, previous_value
'''
syntax = Syntax(my_code, "python", theme="monokai", line_numbers=True)
console = Console()
console.print(syntax)

Это выведет что-то похожее на это:

Ошибки

Rich может отображать красивые ошибки которые проще читать и показывают больше кода чем стандартные ошибки Python. Вы можете установить Rich как стандартный обработчик ошибок чтобы все непойманные ошибки отображал Rich.

Вот как это выглядит на OSX (похоже на Linux):

Все визуализации Rich используют протокол Console, который также позволяет вам добавлять свой Rich контент.

Rich для предприятий

Rich доступен как часть подписки Tidelift.

Поддержатели проекта Rich и тысячи других работают над подпиской Tidelift чтобы предоставить коммерческую поддержку и поддержание для проектов с открытым кодом вы используете чтобы построить своё приложение. Сохраните время, избавьтесь от риска, и улучшите состояние кода, пока вы платите поддержателям проектов вы используете. Узнайте больше.

Проекты использующие Rich

Вот пару проектов использующих Rich:

• BrancoLab/BrainRender библиотека Python для визуализации нейроанатомических данных в 3 измерениях
• Ciphey/Ciphey автоматизированная утилита для расшифровки
• emeryberger/scalene Высокая производительность, высокая точность CPU и профилировщик памяти для Python
• hedythedev/StarCli Просматривайте трендовые проекты GitHub прямо из вашего терминала
• intel/cve-bin-tool Эта утилита сканирует известные уязвимости (openssl, libpng, libxml2, expat and a few others) чтобы уведомить вас если ваша система использует библиотеки с известными уязвимостями.
• nf-core/tools Библиотека Python с полезными инструментами для сообщества nf-core.
• cansarigol/pdbr pdb + Rich библиотека для улучшенного дебаггинга
• plant99/felicette Изображения со спутников для чайников.
• seleniumbase/SeleniumBase Автоматизируйте и тестируйте в 10 раз быстрее с Selenium и pytest. Батарейки включены.
• smacke/ffsubsync Автоматически синхронизируйте субтитры с видео.
• tryolabs/norfair Простая библиотека Python для добавления 2D отслеживания к любому детектеру в реальном времени.
• ansible/ansible-lint Ansible-lint проверяет пьесы для практик и поведений которые могут быть исправлены
• ansible-community/molecule Ansible Molecule тестинг фреймворк
• +Ещё больше!