From ba27f895878bb155fefb8c1b9beee2c9f3d85b3f Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Sun, 18 Jan 2015 13:29:33 -0500 Subject: [PATCH] Clarified a contrib.sites deprecation and added to 1.7 release notes. --- docs/internals/deprecation.txt | 4 ++-- docs/ref/contrib/sites.txt | 8 +++++--- docs/releases/1.7.txt | 11 +++++++++++ 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 45180a107e..c587d3b98d 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -206,8 +206,8 @@ details on these changes. * ``AppCommand.handle_app()`` will no longer be supported. -* ``RequestSite`` will be located in ``django.contrib.sites.requests`` and - ``get_current_site`` in ``django.contrib.sites.shortcuts``. +* ``RequestSite`` and ``get_current_site()`` will no longer be importable from + ``django.contrib.sites.models``. * FastCGI support via the ``runfcgi`` management command will be removed. Please deploy your project using WSGI. diff --git a/docs/ref/contrib/sites.txt b/docs/ref/contrib/sites.txt index 91fbd2af85..b3dd2933a7 100644 --- a/docs/ref/contrib/sites.txt +++ b/docs/ref/contrib/sites.txt @@ -472,9 +472,10 @@ a fallback when the database-backed sites framework is not available. Sets the ``name`` and ``domain`` attributes to the value of :meth:`~django.http.HttpRequest.get_host`. - .. versionchanged:: 1.7 + .. deprecated:: 1.7 - This class used to be defined in ``django.contrib.sites.models``. + This class used to be defined in ``django.contrib.sites.models``. The + old import location will work until Django 1.9. A :class:`~django.contrib.sites.requests.RequestSite` object has a similar interface to a normal :class:`~django.contrib.sites.models.Site` object, @@ -498,9 +499,10 @@ Finally, to avoid repetitive fallback code, the framework provides a object or a :class:`~django.contrib.sites.requests.RequestSite` object based on the request. - .. versionchanged:: 1.7 + .. deprecated:: 1.7 This function used to be defined in ``django.contrib.sites.models``. + The old import location will work until Django 1.9. .. versionchanged:: 1.8 diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 93572ddfd3..e2dc732ae2 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -1757,6 +1757,17 @@ FastCGI support FastCGI support via the ``runfcgi`` management command will be removed in Django 1.9. Please deploy your project using WSGI. +Moved objects in ``contrib.sites`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Following the app-loading refactor, two objects in +``django.contrib.sites.models`` needed to be moved because they must be +available without importing ``django.contrib.sites.models`` when +``django.contrib.sites`` isn't installed. Import ``RequestSite`` from +``django.contrib.sites.requests`` and ``get_current_site()`` from +``django.contrib.sites.shortcuts``. The old import locations will work until +Django 1.9. + .. removed-features-1.7: Features removed in 1.7