django-rich 1.11.0

shell命令集成

django-rich具有Django内置

shell命令

Rich的漂亮打印

django_rich

INSTALLED_APPS

INSTALLED_APPS = [
    ...,
    "django_rich",
    ...,
]

此功能仅影响Python和bypthon解释器，不影响IPython。有关IPython支持，请参阅Rich文档。

django_rich.management.RichCommand

这是Django的BaseCommand类的子类，将其self.console设置为Rich的Console。该Console使用命令的stdout参数，默认为sys.stdout。颜色显示根据Django的--no-color和--force-color标志启用或禁用。

按照您的喜好使用self.console的功能

from time import sleep

from django_rich.management import RichCommand


class Command(RichCommand):
    def handle(self, *args, **options):
        self.console.print("[bold blue]Frobnicating widgets:[/bold blue]")

        with self.console.status("Starting...") as status:
            for i in range(1, 11):
                status.update(f"Widget {i}...")
                sleep(1)
                self.console.log(f"Widget {i} frobnicated.")

您可以通过覆盖make_rich_console类属性来自定义Console的构建。这应该是一个返回Console的可调用对象，例如functools.partial。例如，要禁用默认启用的markup和highlighting标志

from functools import partial

from django_rich.management import RichCommand
from rich.console import Console


class Command(RichCommand):
    make_rich_console = partial(Console, markup=False, highlight=False)

    def handle(self, *args, **options):
        ...

django_rich.test.RichRunner

这是一个Django的DiscoverRunner子类，具有彩色输出和友好的堆栈跟踪渲染。

要使用此类，将您的TEST_RUNNER设置指向它

TEST_RUNNER = "django_rich.test.RichRunner"

您也可以将其作为进一步自定义的基类。由于仅修改了输出，它应该与其他类很好地结合。

测试运行器提供以下功能

• 尽可能对输出进行颜色化。这包括Rich的默认高亮显示，将格式化数字、引号字符串、URL等。

• 失败和错误使用Rich的traceback渲染。这显示每个帧的源代码和局部值。每个帧还显示文件名和行号，在许多终端上，您可以通过点击链接跳转到该位置的文件。

• 当使用--debug-sql和--pdb标志时，输出也会进行颜色化。

• Django的DiscoverRunner的所有其他标志将继续按正常方式工作。

$ COLUMNS=120 ./manage.py test