https://github.com/boxed/django-fastdev

An app to make it safer, faster and more fun to develop in Django
https://github.com/boxed/django-fastdev

django python

Last synced: 10 days ago
JSON representation

An app to make it safer, faster and more fun to develop in Django

• Host: GitHub
• URL: https://github.com/boxed/django-fastdev
• Owner: boxed
• License: bsd-3-clause
• Created: 2020-08-07T11:45:15.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-05-15T07:35:39.000Z (10 days ago)
• Last Synced: 2025-05-15T18:03:58.351Z (10 days ago)
• Topics: django, python
• Language: Python
• Homepage:
• Size: 112 KB
• Stars: 191
• Watchers: 8
• Forks: 15
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• stars - boxed/django-fastdev - An app to make it safer, faster and more fun to develop in Django (Python)
• stars - boxed/django-fastdev - An app to make it safer, faster and more fun to develop in Django (Python)

README

        
django-fastdev

==============

:code:`django-fastdev` is an app that makes it safer, faster and more fun to develop Django apps.

Features

--------

Error on non-existent template variables

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Django templates by default hide errors, and when it does show an error it's often not very helpful. This app changes this behavior to provide more informative error messages. For example, if you use:

.. code:: html

    {{ does_not_exist }}

instead of rendering that as an empty string, this app will raise a :code:`FastDevVariableDoesNotExist` error with a detailed message:

.. code::

    does_not_exist does not exist in context. Available top level variables:

        DEFAULT_MESSAGE_LEVELS

        False

        None

        True

        bar

        csrf_token

        foo

        messages

        perms

        request

        user

There are more specialized error messages for accessing non-existent keys in a :code:`dict` or attributes of an object several levels deep, such as :code:`foo.bar.baz` (where :code:`baz` doesn't exist).

**Handling `default` and `default_if_none` Filters**

When using the :code:`default` or :code:`default_if_none` filters, :code:`django-fastdev` will not raise an exception for non-existent variables. Instead, it behaves as one might intuitively expect by populating the context variable with the result of the filter operation. For example:

.. code:: html

    {{ does_not_exist|default:"N/A" }}

    {{ does_not_exist|default_if_none:"" }}

In these cases:

  * If :code:`does_not_exist` is undefined, :code:`default:"N/A"` will render as :code:`N/A`, and :code:`default_if_none:""` will render as an empty string (:code:`""`).

  * This ensures that templates using these filters handle missing variables gracefully, aligning with Django's built-in behavior while maintaining :code:`django-fastdev`'s strict checking for other cases.

By default, :code:`django-fastdev` only checks templates that exist within your project directory. To check ALL templates, including stock Django templates and templates from third-party libraries, add :code:`FASTDEV_STRICT_TEMPLATE_CHECKING = True` to your project :code:`settings.py`.

Improved TemplateDoesNotExist errors

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Good suggestions for what you wanted to do, and a complete list of all valid values makes it very easy to fix `TemplateDoesNotExist` errors.

NoReverseMatch errors

~~~~~~~~~~~~~~~~~~~~~

Have you ever gotten this error?

.. code::

    django.urls.exceptions.NoReverseMatch: Reverse for 'view-name' with arguments '('',)' not found. 1 pattern(s) tried:

It's because you have :code:`{% url 'view-name' does_not_exist %}`. Django sees

:code:`does_not_exist` and evaluates it to the empty string because it doesn't exist.

So that's why you get an error message that makes no sense. :code:`django-fastdev` will

make your code crash on the actual error: :code:`does_not_exist` doesn't exist.

Error if you have non-space text outside a block when extending

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A common mistake for beginners that can be hard to spot is when they do:

..  code-block:: html

    

        {% extends "something.html" %}

        stuff here

    

Django silently throws away :code:`stuff here` and :code:`

            {% block content %}{% endblock %}