django-rich

=========== django-rich

.. image:: https://img.shields.io/github/actions/workflow/status/adamchainz/django-rich/main.yml.svg?branch=main&style=for-the-badge :target: https://github.com/adamchainz/django-rich/actions?workflow=CI

.. image:: https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge :target: https://github.com/adamchainz/django-rich/actions?workflow=CI

.. image:: https://img.shields.io/pypi/v/django-rich.svg?style=for-the-badge :target: https://pypi.org/project/django-rich/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge :target: https://github.com/pre-commit/pre-commit :alt: pre-commit

Extensions for using Rich <https://rich.readthedocs.io/>__ with Django.

Work smarter and faster with my book Boost Your Django DX <https://adamchainz.gumroad.com/l/byddx>__ which covers many ways to improve your development experience. I wrote django-rich whilst working on the book!

Requirements

Python 3.9 to 3.13 supported.

Django 4.2 to 5.2 supported.

Installation

• Install with pip:

  .. code-block:: sh

  python -m pip install django-rich
  

None of django-rich’s features are activated by default. Follow the documentation below to use them.

Reference

shell command integration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

django-rich has an extended version of Django’s built-in |shell command|__ that enables Rich’s pretty-printing <https://rich.readthedocs.io/en/stable/introduction.html?highlight=install#rich-in-the-repl>__. To activate this feature, add django_rich to your INSTALLED_APPS setting:

.. |shell command| replace:: shell command __ https://docs.djangoproject.com/en/stable/ref/django-admin/#shell

.. code-block:: python

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

This feature only affects the Python and bypthon interpreters, not IPython. For IPython support, see the Rich documentation <https://rich.readthedocs.io/en/stable/introduction.html#ipython-extension>__.

django_rich.management.RichCommand ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A subclass of Django’s |BaseCommand|__ class that sets its self.console to a Rich |Console|__. The Console uses the command’s stdout argument, which defaults to sys.stdout. Colourization is enabled or disabled according to Django’s --no-color and --force-color flags.

.. |BaseCommand| replace:: BaseCommand __ https://docs.djangoproject.com/en/stable/howto/custom-management-commands/#django.core.management.BaseCommand

.. |Console| replace:: Console __ https://rich.readthedocs.io/en/stable/console.html

Use the features of self.console as you like:

.. code-block:: python

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.")

You can customize the construction of the Console by overriding the make_rich_console() method. This takes some keyword arguments and passes them to the Console constructor. For example, to disable the on-by-default markup and highlighting flags, add them in a call to super():

.. code-block:: python

from functools import partial

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


class Command(RichCommand):
    def make_rich_console(self, **kwargs):
        return super().make_rich_console(**kwargs, markup=False, highlight=False)

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

django_rich.test.RichRunner ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A subclass of Django's |DiscoverRunner|__ with colourized outputs and nice traceback rendering <https://rich.readthedocs.io/en/stable/traceback.html>__.

.. image:: https://raw.githubusercontent.com/adamchainz/django-rich/main/img/RichRunner.png

.. |DiscoverRunner| replace:: DiscoverRunner __ https://docs.djangoproject.com/en/stable/topics/testing/advanced/#defining-a-test-runner

To use this class, point your |TEST_RUNNER|__ setting to it:

.. |TEST_RUNNER| replace:: TEST_RUNNER __ https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-TEST_RUNNER

.. code-block:: python

TEST_RUNNER = "django_rich.test.RichRunner"

You can also use it as a base for further customization. Since only output is modified, it should combine well with other classes.

The test runner provides the following features:

• Output is colourized wherever possible. This includes Rich’s default highlighting <https://rich.readthedocs.io/en/stable/highlighting.html>__ which will format numbers, quoted strings, URL’s, and more.

• Failures and errors use Rich’s traceback rendering <https://rich.readthedocs.io/en/stable/traceback.html>__. This displays the source code and local values per frame. Each frame also shows the filename and line number, and on many terminals you can click the link to jump to the file at that position.

• Output is also colourized when using the --debug-sql and --pdb flags.

• All other flags from Django's DiscoverRunner continue to work in the normal way.

Output Width on CI

When tests run on your CI system, you might find the output a bit narrow for showing tracebacks correctly.
This is because Rich tries to autodetect the terminal dimensions, and if that fails, it will default to 80 characters wide.
You can override this default with the ``COLUMNS`` environment variable (as per Python’s |shutil.get_terminal_size() function|__):

.. |shutil.get_terminal_size() function| replace:: ``shutil.get_terminal_size()`` function
__ https://docs.python.org/3/library/shutil.html#shutil.get_terminal_size

.. code-block:: console

    $ COLUMNS=120 ./manage.py test