Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adamchainz/django-upgrade

Automatically upgrade your Django projects.
https://github.com/adamchainz/django-upgrade

Last synced: about 1 month ago
JSON representation

Automatically upgrade your Django projects.

Awesome Lists containing this project

README 

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

django-upgrade

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



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

   :target: https://github.com/adamchainz/django-upgrade/actions?workflow=CI



.. image:: https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge

  :target: https://github.com/adamchainz/django-upgrade/actions?workflow=CI



.. image:: https://img.shields.io/pypi/v/django-upgrade.svg?style=for-the-badge

   :target: https://pypi.org/project/django-upgrade/



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



Automatically upgrade your Django project code.



----



**Improve your code quality** with my book `Boost Your Django DX `__ which covers using  pre-commit, django-upgrade, and many other tools.

I wrote django-upgrade whilst working on the book!



----



Installation

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



Use **pip**:



.. code-block:: sh



    python -m pip install django-upgrade



Python 3.9 to 3.13 supported.



(Python 3.12+ is required to correctly apply fixes within f-strings.)



pre-commit hook

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



You can also install django-upgrade as a `pre-commit `__ hook.

Add the following to the ``repos`` section of your ``.pre-commit-config.yaml`` file (`docs `__), above any code formatters (such as Black):



.. code-block:: yaml



    -   repo: https://github.com/adamchainz/django-upgrade

        rev: ""  # replace with latest tag on GitHub

        hooks:

        -   id: django-upgrade

            args: [--target-version, "5.0"]   # Replace with Django version



Then, upgrade your entire project:



.. code-block:: sh



    pre-commit run django-upgrade --all-files



Commit any changes.

In the process, your other hooks will run, potentially reformatting django-upgrade’s changes to match your project’s code style.



Keep the hook installed in order to upgrade all code added to your project.

pre-commit’s ``autoupdate`` command will also let you take advantage of future django-upgrade features.



Usage

=====



``django-upgrade`` is a commandline tool that rewrites files in place.

Pass your Django version as ``.`` to the ``--target-version`` flag and a list of files.

django-upgrade’s fixers will rewrite your code to avoid ``DeprecationWarning``\s and use some new features.



For example:



.. code-block:: sh



    django-upgrade --target-version 5.0 example/core/models.py example/settings.py



``django-upgrade`` focuses on upgrading your code and not on making it look nice.

Run django-upgrade before formatters like `Black `__.



Some of django-upgrade’s fixers make changes to models that need migrations:



* ``index_together``

* ``null_boolean_field``



Add a `test for pending migrations `__ to ensure that you do not miss these.



``django-upgrade`` does not have any ability to recurse through directories.

Use the pre-commit integration, globbing, or another technique for applying to many files.

Some fixers depend on the names of containing directories to activate, so ensure you run django-upgrade with paths relative to the root of your project.

For example, |with git ls-files pipe xargs|_:



.. |with git ls-files pipe xargs| replace:: with ``git ls-files | xargs``

.. _with git ls-files pipe xargs: https://adamj.eu/tech/2022/03/09/how-to-run-a-command-on-many-files-in-your-git-repository/



.. code-block:: sh



    git ls-files -z -- '*.py' | xargs -0 django-upgrade --target-version 5.0



…or PowerShell’s |ForEach-Object|__:



.. |ForEach-Object| replace:: ``ForEach-Object``

__ https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/foreach-object



.. code-block:: powershell



    git ls-files -- '*.py' | %{django-upgrade --target-version 5.0 $_}



The full list of fixers is documented below.



Options

=======



``--target-version``

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



The version of Django to target, in the format ``.``.

django-upgrade enables all of its fixers for versions up to and including the target version.



This option defaults to 2.2, the oldest supported version when this project was created.

See the list of available versions with ``django-upgrade --help``.



``--exit-zero-even-if-changed``

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



Exit with a zero return code even if files have changed.

By default, django-upgrade uses the failure return code 1 if it changes any files, which may stop scripts or CI pipelines.



``--only ``

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



Run only the named fixer (names are documented below).

The fixer must still be enabled by ``--target-version``.

Select multiple fixers with multiple ``--only`` options.



For example:



.. code-block:: sh



    django-upgrade --target-version 5.0 --only admin_allow_tags --only admin_decorators example/core/admin.py



``--skip ``

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



Skip the named fixer.

Skip multiple fixers with multiple ``--skip`` options.



For example:



.. code-block:: sh



    django-upgrade --target-version 5.0 --skip admin_register example/core/admin.py



``--list-fixers``

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



List all available fixers’ names and then exit.

All other options are ignored when listing fixers.



For example:



.. code-block:: sh



    django-upgrade --list-fixers



History

=======



`django-codemod `__ is a pre-existing, more complete Django auto-upgrade tool, written by Bruno Alla.

Unfortunately its underlying library `LibCST `__ is particularly slow, making it annoying to run django-codemod on every commit and in CI.



django-upgrade is an experiment in reimplementing such a tool using the same techniques as the fantastic `pyupgrade `__.

The tool leans on the standard library’s `ast `__ and `tokenize `__ modules, the latter via the `tokenize-rt wrapper `__.

This means it will always be fast and support the latest versions of Python.



For a quick benchmark: running django-codemod against a medium Django repository with 153k lines of Python takes 133 seconds.

pyupgrade and django-upgrade both take less than 0.5 seconds.



Fixers

======



All Versions

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



The below fixers run regardless of the target version.



Versioned blocks

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



**Name:** ``versioned_branches``



Removes outdated comparisons and blocks from ``if`` statements comparing to ``django.VERSION``.

Supports comparisons of the form:



.. code-block:: text



    if django.VERSION  (, ):

        ...



Where ```` is one of ``<``, ``<=`` , ``>``, or ``>=``, and ```` and ```` are integer literals.

A single ``else`` block may be present, but ``elif`` is not supported.



.. code-block:: diff



    -if django.VERSION < (4, 1):

    -    class RenameIndex:

    -        ...



    -if django.VERSION >= (4, 1):

    -    constraint.validate()

    -else:

    -    custom_validation(constraint)

    +constraint.validate()



See also `pyupgrade’s similar feature `__ that removes outdated code from checks on the Python version.



Versioned test skip decorators

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



**Name:** ``versioned_test_skip_decorators``



Removes outdated test skip decorators that compare to ``django.VERSION``.

Like the above, it requires comparisons of the form:



.. code-block:: text



    django.VERSION  (, )



Supports these test skip decorators:



* |unittest.skipIf|__



  .. |unittest.skipIf| replace:: ``@unittest.skipIf``

  __ https://docs.python.org/3/library/unittest.html#unittest.skipIf



* |unittest.skipUnless|__



  .. |unittest.skipUnless| replace:: ``@unittest.skipUnless``

  __ https://docs.python.org/3/library/unittest.html#unittest.skipUnless



* |pytest.mark.skipif|__



  .. |pytest.mark.skipif| replace:: ``@pytest.mark.skipif``

  __ https://docs.pytest.org/en/stable/how-to/skipping.html#id1



For example:



.. code-block:: diff



     import unittest



     import django

     import pytest

     from django.test import TestCase



     class ExampleTests(TestCase):

    -    @unittest.skipIf(django.VERSION < (5, 1), "Django 5.1+")

         def test_one(self):

             ...



    -    @unittest.skipUnless(django.VERSION >= (5, 1), "Django 5.1+")

         def test_two(self):

             ...



    -    @pytest.mark.skipif(django.VERSION < (5, 1), reason="Django 5.1+")

         def test_three(self):

             ...



    [email protected](django.VERSION < (5, 1), "Django 5.1+")

     class Example2Tests(TestCase):

         ...



    [email protected](django.VERSION < (5, 1), reason="Django 5.1+")

     class Example3Tests(TestCase):

         ...



Django 5.1

----------



`Release Notes `__



``CheckConstraint`` ``condition`` argument

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



**Name:** ``check_constraint_condition``



Rewrites calls to ``CheckConstraint`` and built-in subclasses from the old ``check`` argument to the new name ``condition``.



.. code-block:: diff



   -CheckConstraint(check=Q(amount__gte=0))

   +CheckConstraint(condition=Q(amount__gte=0))



Django 5.0

----------



`Release Notes `__



``format_html()`` calls

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



**Name:** ``format_html``



Rewrites ``format_html()`` calls without ``args`` or ``kwargs`` but using ``str.format()``.

Such calls are most likely incorrectly applying formatting without escaping, making them vulnerable to HTML injection.

Such use cases are why calling ``format_html()`` without any arguments or keyword arguments was deprecated in `Ticket #34609 `__.



.. code-block:: diff



     from django.utils.html import format_html



    -format_html("{}".format(message))

    +format_html("{}", message)



    -format_html("{name}".format(name=name))

    +format_html("{name}", name=name)



Django 4.2

----------



`Release Notes `__



``STORAGES`` setting

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



**Name:** ``settings_storages``



Combines deprecated settings ``DEFAULT_FILE_STORAGE`` and ``STATICFILES_STORAGE`` into the new ``STORAGES`` setting, within settings files.

Only applies if all old settings are defined as strings, at module level, and a ``STORAGES`` setting hasn’t been defined.



Settings files are heuristically detected as modules with the whole word “settings” somewhere in their path.

For example ``myproject/settings.py`` or ``myproject/settings/production.py``.



.. code-block:: diff



    -DEFAULT_FILE_STORAGE = "example.storages.ExtendedFileSystemStorage"

    -STATICFILES_STORAGE = "example.storages.ExtendedS3Storage"

    +STORAGES = {

    +    "default": {

    +        "BACKEND": "example.storages.ExtendedFileSystemStorage",

    +    },

    +    "staticfiles": {

    +        "BACKEND": "example.storages.ExtendedS3Storage",

    +    },

    +}



If the module has a ``from ... import *`` with a module path mentioning “settings”, django-upgrade makes an educated guess that a base ``STORAGES`` setting is imported from there.

It then uses ``**`` to extend that with any values in the current module:



.. code-block:: diff



     from example.settings.base import *

    -DEFAULT_FILE_STORAGE = "example.storages.S3Storage"

    +STORAGES = {

    +    **STORAGES,

    +    "default": {

    +        "BACKEND": "example.storages.S3Storage",

    +    },

    +}



Test client HTTP headers

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



**Name:** ``test_http_headers``



Transforms HTTP headers from the old WSGI kwarg format to use the new ``headers`` dictionary, for:



* ``Client`` method like ``self.client.get()``

* ``Client`` instantiation

* ``RequestFactory`` instantiation



.. code-block:: diff



    -response = self.client.get("/", HTTP_ACCEPT="text/plain")

    +response = self.client.get("/", headers={"accept": "text/plain"})



     from django.test import Client

    -Client(HTTP_ACCEPT_LANGUAGE="fr-fr")

    +Client(headers={"accept-language": "fr-fr"})



     from django.test import RequestFactory

    -RequestFactory(HTTP_USER_AGENT="curl")

    +RequestFactory(headers={"user-agent": "curl"})



``index_together`` deprecation

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



**Name:** ``index_together``



Rewrites ``index_together`` declarations into ``indexes`` declarations in model ``Meta`` classes.



.. code-block:: diff



     from django.db import models



     class Duck(models.Model):

         class Meta:

    -       index_together = [["bill", "tail"]]

    +       indexes = [models.Index(fields=["bill", "tail"])]



``assertFormsetError`` and ``assertQuerysetEqual``

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



**Name:** ``assert_set_methods``



Rewrites calls to these test case methods from the old names to the new ones with capitalized “Set”.



.. code-block:: diff



    -self.assertFormsetError(response.context["form"], "username", ["Too long"])

    +self.assertFormSetError(response.context["form"], "username", ["Too long"])



    -self.assertQuerysetEqual(authors, ["Brad Dayley"], lambda a: a.name)

    +self.assertQuerySetEqual(authors, ["Brad Dayley"], lambda a: a.name)



Django 4.1

----------



`Release Notes `__



``django.utils.timezone.utc`` deprecations

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



**Name:** ``utils_timezone``



Rewrites imports of ``django.utils.timezone.utc`` to use ``datetime.timezone.utc``.

Requires an existing import of the ``datetime`` module.



.. code-block:: diff



     import datetime

    -from django.utils.timezone import utc



    -calculate_some_datetime(utc)

    +calculate_some_datetime(datetime.timezone.utc)



.. code-block:: diff



     import datetime as dt

     from django.utils import timezone



    -do_a_thing(timezone.utc)

    +do_a_thing(dt.timezone.utc)



``assertFormError()`` and ``assertFormsetError()``

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



**Name:** ``assert_form_error``



Rewrites calls to these test case methods from the old signatures to the new ones.



.. code-block:: diff



    -self.assertFormError(response, "form", "username", ["Too long"])

    +self.assertFormError(response.context["form"], "username", ["Too long"])



    -self.assertFormError(response, "form", "username", None)

    +self.assertFormError(response.context["form"], "username", [])



    -self.assertFormsetError(response, "formset", 0, "username", ["Too long"])

    +self.assertFormsetError(response.context["formset"], 0, "username", ["Too long"])



    -self.assertFormsetError(response, "formset", 0, "username", None)

    +self.assertFormsetError(response.context["formset"], 0, "username", [])



Django 4.0

----------



`Release Notes `__



``USE_L10N``

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



**Name:** ``use_l10n``



Removes the deprecated ``USE_L10N`` setting if set to its default value of ``True``.



Settings files are heuristically detected as modules with the whole word “settings” somewhere in their path.

For example ``myproject/settings.py`` or ``myproject/settings/production.py``.



.. code-block:: diff



    -USE_L10N = True



``lookup_needs_distinct``

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



**Name:** ``admin_lookup_needs_distinct``



Renames the undocumented ``django.contrib.admin.utils.lookup_needs_distinct`` to ``lookup_spawns_duplicates``:



.. code-block:: diff



    -from django.contrib.admin.utils import lookup_needs_distinct

    +from django.contrib.admin.utils import lookup_spawns_duplicates



    -if lookup_needs_distinct(self.opts, search_spec):

    +if lookup_spawns_duplicates(self.opts, search_spec):

        ...



Compatibility imports

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



Rewrites some compatibility imports:



* ``django.utils.translation.template.TRANSLATOR_COMMENT_MARK`` in ``django.template.base``



.. code-block:: diff



    -from django.template.base import TRANSLATOR_COMMENT_MARK

    +from django.utils.translation.template import TRANSLATOR_COMMENT_MARK



Django 3.2

----------



`Release Notes `__



``@admin.action()``

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



**Name:** ``admin_decorators``



Rewrites functions that have admin action attributes assigned to them to use the new |@admin.action decorator|_.

This only applies in files that use ``from django.contrib import admin`` or ``from django.contrib.gis import admin``.



.. |@admin.action decorator| replace:: ``@admin.action()`` decorator

.. [email protected] decorator: https://docs.djangoproject.com/en/stable/ref/contrib/admin/actions/#django.contrib.admin.action



.. code-block:: diff



     from django.contrib import admin



     # Module-level actions:



    [email protected](

    +    description="Publish articles",

    +)

     def make_published(modeladmin, request, queryset):

         ...



    -make_published.short_description = "Publish articles"



     # …and within classes:



     @admin.register(Book)

     class BookAdmin(admin.ModelAdmin):

    +    @admin.action(

    +        description="Unpublish articles",

    +        permissions=("unpublish",),

    +    )

         def make_unpublished(self, request, queryset):

             ...



    -    make_unpublished.allowed_permissions = ("unpublish",)

    -    make_unpublished.short_description = "Unpublish articles"



``@admin.display()``

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



**Name:** ``admin_decorators``



Rewrites functions that have admin display attributes assigned to them to use the new |@admin.display decorator|_.

This only applies in files that use ``from django.contrib import admin`` or ``from django.contrib.gis import admin``.



.. |@admin.display decorator| replace:: ``@admin.display()`` decorator

.. [email protected] decorator: https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.display



.. code-block:: diff



     from django.contrib import admin



     # Module-level display functions:



    [email protected](

    +    description="NAME",

    +)

     def upper_case_name(obj):

         ...



    -upper_case_name.short_description = "NAME"



     # …and within classes:



     @admin.register(Book)

     class BookAdmin(admin.ModelAdmin):

    +    @admin.display(

    +        description='Is Published?',

    +        boolean=True,

    +        ordering='-publish_date',

    +    )

         def is_published(self, obj):

             ...



    -    is_published.boolean = True

    -    is_published.admin_order_field = '-publish_date'

    -    is_published.short_description = 'Is Published?'



``BaseCommand.requires_system_checks``

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



**Name:** ``management_commands``



Rewrites the ``requires_system_checks`` attributes of management command classes from bools to ``"__all__"`` or ``[]`` as appropriate.

This only applies in command files, which are heuristically detected as files with ``management/commands`` somewhere in their path.



.. code-block:: diff



     from django.core.management.base import BaseCommand



     class Command(BaseCommand):

    -    requires_system_checks = True

    +    requires_system_checks = "__all__"



     class SecondCommand(BaseCommand):

    -    requires_system_checks = False

    +    requires_system_checks = []



``EmailValidator``

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



**Name:** ``email_validator``



Rewrites the ``whitelist`` keyword argument to its new name ``allowlist``.



.. code-block:: diff



     from django.core.validators import EmailValidator



    -EmailValidator(whitelist=["example.com"])

    +EmailValidator(allowlist=["example.com"])



``default_app_config``

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



**Name:** ``default_app_config``



Removes module-level ``default_app_config`` assignments from ``__init__.py`` files:



.. code-block:: diff



    -default_app_config = 'my_app.apps.AppConfig'



Django 3.1

----------



`Release Notes `__



``JSONField``

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



**Name:** ``compatibility_imports``



Rewrites imports of ``JSONField`` and related transform classes from those in ``django.contrib.postgres`` to the new all-database versions.

Ignores usage in migration files, since Django kept the old class around to support old migrations.

You will need to make migrations after this fix makes changes to models.



.. code-block:: diff



    -from django.contrib.postgres.fields import JSONField

    +from django.db.models import JSONField



``PASSWORD_RESET_TIMEOUT_DAYS``

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



**Name:** ``password_reset_timeout_days``



Rewrites the setting ``PASSWORD_RESET_TIMEOUT_DAYS`` to ``PASSWORD_RESET_TIMEOUT``, adding the multiplication by the number of seconds in a day.



Settings files are heuristically detected as modules with the whole word “settings” somewhere in their path.

For example ``myproject/settings.py`` or ``myproject/settings/production.py``.



.. code-block:: diff



    -PASSWORD_RESET_TIMEOUT_DAYS = 4

    +PASSWORD_RESET_TIMEOUT = 60 * 60 * 24 * 4



``Signal``

~~~~~~~~~~



**Name:** ``signal_providing_args``



Removes the deprecated documentation-only ``providing_args`` argument.



.. code-block:: diff



     from django.dispatch import Signal

    -my_cool_signal = Signal(providing_args=["documented", "arg"])

    +my_cool_signal = Signal()



``get_random_string``

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



**Name:** ``crypto_get_random_string``



Injects the now-required ``length`` argument, with its previous default ``12``.



.. code-block:: diff



     from django.utils.crypto import get_random_string

    -key = get_random_string(allowed_chars="01234567899abcdef")

    +key = get_random_string(length=12, allowed_chars="01234567899abcdef")



``NullBooleanField``

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



**Name:** ``null_boolean_field``



Transforms the ``NullBooleanField()`` model field to ``BooleanField(null=True)``.

Applied only in model files, not migration files, since Django kept the old class around to support old migrations.

You will need to make migrations after this fix makes changes to models.



.. code-block:: diff



    -from django.db.models import Model, NullBooleanField

    +from django.db.models import Model, BooleanField



     class Book(Model):

    -    valuable = NullBooleanField("Valuable")

    +    valuable = BooleanField("Valuable", null=True)



``ModelMultipleChoiceField``

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



**Name:** ``forms_model_multiple_choice_field``



Replace ``list`` error message key with ``list_invalid`` on forms ``ModelMultipleChoiceField``.



.. code-block:: diff



    -forms.ModelMultipleChoiceField(error_messages={"list": "Enter multiple values."})

    +forms.ModelMultipleChoiceField(error_messages={"invalid_list": "Enter multiple values."})



Django 3.0

----------



`Release Notes `__



``django.utils.encoding`` aliases

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



**Name:** ``utils_encoding``



Rewrites ``smart_text()`` to ``smart_str()``, and ``force_text()`` to ``force_str()``.



.. code-block:: diff



    -from django.utils.encoding import force_text, smart_text

    +from django.utils.encoding import force_str, smart_str



    -force_text("yada")

    -smart_text("yada")

    +force_str("yada")

    +smart_str("yada")



``django.utils.http`` deprecations

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



**Name:** ``utils_http``:



Rewrites the ``urlquote()``, ``urlquote_plus()``, ``urlunquote()``, and ``urlunquote_plus()`` functions to the ``urllib.parse`` versions.

Also rewrites the internal function ``is_safe_url()`` to ``url_has_allowed_host_and_scheme()``.



.. code-block:: diff



    -from django.utils.http import urlquote

    +from urllib.parse import quote



    -escaped_query_string = urlquote(query_string)

    +escaped_query_string = quote(query_string)



``django.utils.text`` deprecation

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



**Name:** ``utils_text``



Rewrites ``unescape_entities()`` with the standard library ``html.escape()``.



.. code-block:: diff



    -from django.utils.text import unescape_entities

    +import html



    -unescape_entities("some input string")

    +html.escape("some input string")



``django.utils.translation`` deprecations

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



**Name:** ``utils_translation``



Rewrites the ``ugettext()``, ``ugettext_lazy()``, ``ugettext_noop()``, ``ungettext()``, and ``ungettext_lazy()`` functions to their non-u-prefixed versions.



.. code-block:: diff



    -from django.utils.translation import ugettext as _, ungettext

    +from django.utils.translation import gettext as _, ngettext



    -ungettext("octopus", "octopodes", n)

    +ngettext("octopus", "octopodes", n)



Django 2.2

----------



`Release Notes `__



``HttpRequest.headers``

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



**Name:** ``request_headers``



Rewrites use of ``request.META`` to read HTTP headers to instead use |request.headers|_.

Header lookups are done in lowercase per `the HTTP/2 specification `__.



.. |request.headers| replace:: ``request.headers``

.. _request.headers: https://docs.djangoproject.com/en/stable/ref/request-response/#django.http.HttpRequest.headers



.. code-block:: diff



    -request.META['HTTP_ACCEPT_ENCODING']

    +request.headers['accept-encoding']



    -self.request.META.get('HTTP_SERVER', '')

    +self.request.headers.get('server', '')



    -request.META.get('CONTENT_LENGTH')

    +request.headers.get('content-length')



    -"HTTP_SERVER" in request.META

    +"server" in request.headers



``QuerySetPaginator``

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



**Name:** ``queryset_paginator``



Rewrites deprecated alias ``django.core.paginator.QuerySetPaginator`` to ``Paginator``.



.. code-block:: diff



    -from django.core.paginator import QuerySetPaginator

    +from django.core.paginator import Paginator



    -QuerySetPaginator(...)

    +Paginator(...)



``FixedOffset``

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



**Name:** ``timezone_fixedoffset``



Rewrites deprecated class ``FixedOffset(x, y))`` to ``timezone(timedelta(minutes=x), y)``



Known limitation: this fixer will leave code broken with an ``ImportError`` if ``FixedOffset`` is called with only ``*args`` or ``**kwargs``.



.. code-block:: diff



    -from django.utils.timezone import FixedOffset

    -FixedOffset(120, "Super time")

    +from datetime import timedelta, timezone

    +timezone(timedelta(minutes=120), "Super time")



``FloatRangeField``

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



**Name:** ``postgres_float_range_field``



Rewrites model and form fields using ``FloatRangeField`` to ``DecimalRangeField``, from the relevant ``django.contrib.postgres`` modules.



.. code-block:: diff



     from django.db.models import Model

    -from django.contrib.postgres.fields import FloatRangeField

    +from django.contrib.postgres.fields import DecimalRangeField



     class MyModel(Model):

    -    my_field = FloatRangeField("My range of numbers")

    +    my_field = DecimalRangeField("My range of numbers")



``TestCase`` class database declarations

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



**Name:** ``testcase_databases``



Rewrites the ``allow_database_queries`` and ``multi_db`` attributes of Django’s ``TestCase`` classes to the new ``databases`` attribute.

This only applies in test files, which are heuristically detected as files with either “test” or “tests” somewhere in their path.



Note that this will only rewrite to ``databases = []`` or ``databases = "__all__"``.

With multiple databases you can save some test time by limiting test cases to the databases they require (which is why Django made the change).



.. code-block:: diff



     from django.test import SimpleTestCase



     class MyTests(SimpleTestCase):

    -    allow_database_queries = True

    +    databases = "__all__"



         def test_something(self):

             self.assertEqual(2 * 2, 4)



Django 2.1

----------



`Release Notes `__



No fixers yet.



Django 2.0

----------



`Release Notes `__



URL’s

~~~~~



**Name:** ``django_urls``



Rewrites imports of ``include()`` and ``url()`` from ``django.conf.urls`` to ``django.urls``.

``url()`` calls using compatible regexes are rewritten to the |new path() syntax|_, otherwise they are converted to call ``re_path()``.



.. |new path() syntax| replace:: new ``path()`` syntax

.. _new path() syntax: https://docs.djangoproject.com/en/2.0/releases/2.0/#simplified-url-routing-syntax



.. code-block:: diff



    -from django.conf.urls import include, url

    +from django.urls import include, path, re_path



     urlpatterns = [

    -    url(r'^$', views.index, name='index'),

    +    path('', views.index, name='index'),

    -    url(r'^about/$', views.about, name='about'),

    +    path('about/', views.about, name='about'),

    -    url(r'^post/(?P[-a-zA-Z0-9_]+)/$', views.post, name='post'),

    +    path('post//', views.post, name='post'),

    -    url(r'^weblog', include('blog.urls')),

    +    re_path(r'^weblog', include('blog.urls')),

     ]



Existing ``re_path()`` calls are also rewritten to the ``path()`` syntax when eligible.



.. code-block:: diff



    -from django.urls import include, re_path

    +from django.urls import include, path, re_path



     urlpatterns = [

    -    re_path(r'^about/$', views.about, name='about'),

    +    path('about/', views.about, name='about'),

         re_path(r'^post/(?P[\w-]+)/$', views.post, name='post'),

     ]



The compatible regexes that will be converted to use `path converters `__ are the following:



* ``[^/]+`` → ``str``

* ``[0-9]+`` → ``int``

* ``[-a-zA-Z0-9_]+`` → ``slug``

* ``[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`` → ``uuid``

* ``.+`` → ``path``



These are taken from the path converter classes.



For some cases, this change alters the type of the arguments passed to the view, from ``str`` to the converted type (e.g. ``int``).

This is not guaranteed backwards compatible: there is a chance that the view expects a string, rather than the converted type.

But, pragmatically, it seems 99.9% of views do not require strings, and instead work with either strings or the converted type.

Thus, you should test affected paths after this fixer makes any changes.



Note that ``[\w-]`` is sometimes used for slugs, but is not converted because it might be incompatible.

That pattern matches all Unicode word characters, such as “α”, unlike Django's ``slug`` converter, which only matches Latin characters.



``lru_cache``

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



**Name:** ``compatibility_imports``



Rewrites imports of ``lru_cache`` from ``django.utils.functional`` to use ``functools``.



.. code-block:: diff



    -from django.utils.functional import lru_cache

    +from functools import lru_cache



``ContextDecorator``

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



Rewrites imports of ``ContextDecorator`` from ``django.utils.decorators`` to use ``contextlib``.



.. code-block:: diff



    -from django.utils.decorators import ContextDecorator

    +from contextlib import ContextDecorator



``.allow_tags = True``

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



**Name:** ``admin_allow_tags``



Removes assignments of ``allow_tags`` attributes to ``True``.

This was an admin feature to allow display functions to return HTML without marking it as unsafe,  deprecated in Django 1.9.

In practice, most display functions that return HTML already use |format_html()|_ or similar, so the attribute wasn’t necessary.

This only applies in files that use ``from django.contrib import admin`` or ``from django.contrib.gis import admin``.



.. |format_html()| replace:: ``format_html()``

.. _format_html(): https://docs.djangoproject.com/en/stable/ref/utils/#django.utils.html.format_html



.. code-block:: diff



    from django.contrib import admin



    def upper_case_name(obj):

        ...



   -upper_case_name.allow_tags = True



Django 1.11

-----------



`Release Notes `__



Compatibility imports

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



**Name:** ``compatibility_imports``



Rewrites some compatibility imports:



* ``django.core.exceptions.EmptyResultSet`` in ``django.db.models.query``, ``django.db.models.sql``, and ``django.db.models.sql.datastructures``

* ``django.core.exceptions.FieldDoesNotExist`` in ``django.db.models.fields``



Whilst mentioned in the `Django 3.1 release notes `_, these have been possible since Django 1.11.



.. code-block:: diff



    -from django.db.models.query import EmptyResultSet

    +from django.core.exceptions import EmptyResultSet



    -from django.db.models.fields import FieldDoesNotExist

    +from django.core.exceptions import FieldDoesNotExist



Django 1.10

-----------



`Release Notes `__



``request.user`` boolean attributes

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



**Name:** ``request_user_attributes``



Rewrites calls to ``request.user.is_authenticated()`` and ``request.user.is_anonymous()`` to remove the parentheses, per `the deprecation `__.



.. code-block:: diff



    -request.user.is_authenticated()

    +request.user.is_authenticated



    -self.request.user.is_anonymous()

    +self.request.user.is_anonymous



Compatibility imports

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



Rewrites some compatibility imports:



* ``django.templatetags.static.static`` in ``django.contrib.staticfiles.templatetags.staticfiles``



   (Whilst mentioned in the `Django 2.1 release notes `_, this has been possible since Django 1.10.)



* ``django.urls.*`` in ``django.core.urlresolvers.*``



.. code-block:: diff



    -from django.contrib.staticfiles.templatetags.staticfiles import static

    +from django.templatetags.static import static



    -from django.core.urlresolvers import reverse

    +from django.urls import reverse



    -from django.core.urlresolvers import resolve

    +from django.urls import resolve



Django 1.9

-----------



`Release Notes `__



``on_delete`` argument

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



**Name:** ``on_delete``



Add ``on_delete=models.CASCADE`` to ``ForeignKey`` and ``OneToOneField``:



.. code-block:: diff



     from django.db import models



    -models.ForeignKey("auth.User")

    +models.ForeignKey("auth.User", on_delete=models.CASCADE)



    -models.OneToOneField("auth.User")

    +models.OneToOneField("auth.User", on_delete=models.CASCADE)



This fixer also support from-imports:



.. code-block:: diff



    -from django.db.models import ForeignKey

    +from django.db.models import CASCADE, ForeignKey



    -ForeignKey("auth.User")

    +ForeignKey("auth.User", on_delete=CASCADE)



``DATABASES``

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



**Name:** ``settings_database_postgresql``



Update the ``DATABASES`` setting backend path ``django.db.backends.postgresql_psycopg2`` to use the renamed version ``django.db.backends.postgresql``.



Settings files are heuristically detected as modules with the whole word “settings” somewhere in their path.

For example ``myproject/settings.py`` or ``myproject/settings/production.py``.



.. code-block:: diff



    DATABASES = {

        "default": {

   -        "ENGINE": "django.db.backends.postgresql_psycopg2",

   +        "ENGINE": "django.db.backends.postgresql",

            "NAME": "mydatabase",

            "USER": "mydatabaseuser",

            "PASSWORD": "mypassword",

            "HOST": "127.0.0.1",

            "PORT": "5432",

        }

    }



Compatibility imports

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



**Name:** ``compatibility_imports``



Rewrites some compatibility imports:



* ``django.forms.utils.pretty_name`` in ``django.forms.forms``

* ``django.forms.boundfield.BoundField`` in ``django.forms.forms``

* ``django.forms.widgets.SelectDateWidget`` in ``django.forms.extras``



Whilst mentioned in the `Django 3.1 release notes `_, these have been possible since Django 1.9.



.. code-block:: diff



    -from django.forms.forms import pretty_name

    +from django.forms.utils import pretty_name



Django 1.8

----------



`Release Notes `__



No fixers yet.



Django 1.7

----------



`Release Notes `__



Admin model registration

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



**Name:** ``admin_register``



Rewrites ``admin.site.register()`` calls to the new |@admin.register|_ decorator syntax when eligible.

This only applies in files that use ``from django.contrib import admin`` or ``from django.contrib.gis import admin``.



.. |@admin.register| replace:: ``@admin.register()``

.. [email protected]: https://docs.djangoproject.com/en/stable/ref/contrib/admin/#the-register-decorator



.. code-block:: diff



     from django.contrib import admin



    [email protected](MyModel1, MyModel2)

     class MyCustomAdmin(admin.ModelAdmin):

         ...



    -admin.site.register(MyModel1, MyCustomAdmin)

    -admin.site.register(MyModel2, MyCustomAdmin)



This also works with custom admin sites.

Such calls are detected heuristically based on three criteria:



1. The object whose ``register()`` method is called has a name ending with ``site``.

2. The registered class has a name ending with ``Admin``.

3. The filename has the word ``admin`` somewhere in its path.



.. code-block:: diff



    from myapp.admin import custom_site

    from django.contrib import admin



    [email protected](MyModel)

    [email protected](MyModel, site=custom_site)

    class MyModelAdmin(admin.ModelAdmin):

        pass



    -custom_site.register(MyModel, MyModelAdmin)

    -admin.site.register(MyModel, MyModelAdmin)



If a ``register()`` call is preceded by an ``unregister()`` call that includes the same model, it is ignored.



.. code-block:: python



    from django.contrib import admin



    class MyCustomAdmin(admin.ModelAdmin):

        ...



    admin.site.unregister(MyModel1)

    admin.site.register(MyModel1, MyCustomAdmin)



Compatibility imports

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



Rewrites some compatibility imports:



* ``django.contrib.admin.helpers.ACTION_CHECKBOX_NAME`` in ``django.contrib.admin``

* ``django.template.context.BaseContext``, ``django.template.context.Context``, ``django.template.context.ContextPopException`` and ``django.template.context.RequestContext`` in ``django.template.base``



.. code-block:: diff



    -from django.contrib.admin import ACTION_CHECKBOX_NAME

    +from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME



    -from django.template.base import Context

    +from django.template.context import Context