132 lines
5.0 KiB
Plaintext
132 lines
5.0 KiB
Plaintext
===================================
|
|
Upgrading Django to a newer version
|
|
===================================
|
|
|
|
While it can be a complex process at times, upgrading to the latest Django
|
|
version has several benefits:
|
|
|
|
* New features and improvements are added.
|
|
* Bugs are fixed.
|
|
* Older version of Django will eventually no longer receive security updates.
|
|
(see :ref:`supported-versions-policy`).
|
|
* Upgrading as each new Django release is available makes future upgrades less
|
|
painful by keeping your code base up to date.
|
|
|
|
Here are some things to consider to help make your upgrade process as smooth as
|
|
possible.
|
|
|
|
Required Reading
|
|
================
|
|
|
|
If it's your first time doing an upgrade, it is useful to read the :doc:`guide
|
|
on the different release processes </internals/release-process>`.
|
|
|
|
Afterwards, you should familiarize yourself with the changes that were made in
|
|
the new Django version(s):
|
|
|
|
* Read the :doc:`release notes </releases/index>` for each 'final' release from
|
|
the one after your current Django version, up to and including the version to
|
|
which you plan to upgrade.
|
|
* Look at the :doc:`deprecation timeline</internals/deprecation>` for the
|
|
relevant versions.
|
|
|
|
Pay particular attention to backwards incompatible changes to get a clear idea
|
|
of what will be needed for a successful upgrade.
|
|
|
|
If you're upgrading through more than one feature version (e.g. A.B to A.B+2),
|
|
it's usually easier to upgrade through each feature release incrementally
|
|
(A.B to A.B+1 to A.B+2) rather than to make all the changes for each feature
|
|
release at once. For each feature release, use the latest patch release (A.B.C).
|
|
|
|
The same incremental upgrade approach is recommended when upgrading from one
|
|
LTS to the next.
|
|
|
|
Dependencies
|
|
============
|
|
|
|
In most cases it will be necessary to upgrade to the latest version of your
|
|
Django-related dependencies as well. If the Django version was recently
|
|
released or if some of your dependencies are not well-maintained, some of your
|
|
dependencies may not yet support the new Django version. In these cases you may
|
|
have to wait until new versions of your dependencies are released.
|
|
|
|
Resolving deprecation warnings
|
|
==============================
|
|
|
|
Before upgrading, it's a good idea to resolve any deprecation warnings raised
|
|
by your project while using your current version of Django. Fixing these
|
|
warnings before upgrading ensures that you're informed about areas of the code
|
|
that need altering.
|
|
|
|
In Python, deprecation warnings are silenced by default. You must turn them on
|
|
using the ``-Wa`` Python command line option or the :envvar:`PYTHONWARNINGS`
|
|
environment variable. For example, to show warnings while running tests:
|
|
|
|
.. console::
|
|
|
|
$ python -Wa manage.py test
|
|
|
|
If you're not using the Django test runner, you may need to also ensure that
|
|
any console output is not captured which would hide deprecation warnings. For
|
|
example, if you use `py.test`:
|
|
|
|
.. code-block:: console
|
|
|
|
$ PYTHONWARNINGS=always py.test tests --capture=no
|
|
|
|
Resolve any deprecation warnings with your current version of Django before
|
|
continuing the upgrade process.
|
|
|
|
Third party applications might use deprecated APIs in order to support multiple
|
|
versions of Django, so deprecation warnings in packages you've installed don't
|
|
necessarily indicate a problem. If a package doesn't support the latest version
|
|
of Django, consider raising an issue or sending a pull request for it.
|
|
|
|
Installation
|
|
============
|
|
|
|
Once you're ready, it is time to :doc:`install the new Django version
|
|
</topics/install>`. If you are using virtualenv_ and it is a major upgrade, you
|
|
might want to set up a new environment with all the dependencies first.
|
|
|
|
If you installed Django with pip_, you can use the ``--upgrade`` or ``-U`` flag:
|
|
|
|
.. console::
|
|
|
|
$ pip install -U Django
|
|
|
|
.. _pip: https://pip.pypa.io/
|
|
.. _virtualenv: https://virtualenv.pypa.io/
|
|
|
|
Testing
|
|
=======
|
|
|
|
When the new environment is set up, :doc:`run the full test suite
|
|
</topics/testing/overview>` for your application. Again, it's useful to turn
|
|
on deprecation warnings on so they're shown in the test output (you can also
|
|
use the flag if you test your app manually using ``manage.py runserver``):
|
|
|
|
.. console::
|
|
|
|
$ python -Wa manage.py test
|
|
|
|
After you have run the tests, fix any failures. While you have the release
|
|
notes fresh in your mind, it may also be a good time to take advantage of new
|
|
features in Django by refactoring your code to eliminate any deprecation
|
|
warnings.
|
|
|
|
Deployment
|
|
==========
|
|
|
|
When you are sufficiently confident your app works with the new version of
|
|
Django, you're ready to go ahead and :doc:`deploy </howto/deployment/index>`
|
|
your upgraded Django project.
|
|
|
|
If you are using caching provided by Django, you should consider clearing your
|
|
cache after upgrading. Otherwise you may run into problems, for example, if you
|
|
are caching pickled objects as these objects are not guaranteed to be
|
|
pickle-compatible across Django versions. A past instance of incompatibility
|
|
was caching pickled :class:`~django.http.HttpResponse` objects, either
|
|
directly or indirectly via the :func:`~django.views.decorators.cache.cache_page`
|
|
decorator.
|