Commit cc083724 authored by James Bennett's avatar James Bennett
Browse files

Fixed #6382: Documented request.urlconf 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@7303 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent 41d101e9

docs/request_response.txt

+10 −0
Original line number Diff line number Diff line
@@ -141,6 +141,16 @@ All attributes except ``session`` should be considered read-only. 
    The raw HTTP POST data. This is only useful for advanced processing. Use

    ``POST`` instead.



``urlconf``

    Not defined by Django itself, but will be read if other code

    (e.g., a custom middleware class) sets it; when present, this will

    be used as the root URLConf for the current request, overriding

    the ``ROOT_URLCONF`` setting. See `How Django processes a

    request`_ for details.



.. _How Django processes a request: ../url_dispatch/#how-django-processes-a-request





Methods

-------

docs/settings.txt

+3 −1
Original line number Diff line number Diff line
@@ -754,7 +754,9 @@ ROOT_URLCONF 
Default: Not defined



A string representing the full Python import path to your root URLconf. For example:

``"mydjangoapps.urls"``. See `How Django processes a request`_.

``"mydjangoapps.urls"``. Can be overridden on a per-request basis by

setting the attribute ``urlconf`` on the incoming ``HttpRequest``

object. See `How Django processes a request`_ for details.



.. _How Django processes a request: ../url_dispatch/#how-django-processes-a-request

docs/url_dispatch.txt

+5 −3
Original line number Diff line number Diff line
@@ -32,9 +32,11 @@ How Django processes a request 
When a user requests a page from your Django-powered site, this is the

algorithm the system follows to determine which Python code to execute:



    1. Django looks at the ``ROOT_URLCONF`` setting in your `settings file`_.

       This should be a string representing the full Python import path to your

       URLconf. For example: ``"mydjangoapps.urls"``.

    1. Django determines the root URLConf module to use; ordinarily

       this is the value of the ``ROOT_URLCONF`` setting in your

       `settings file`_, but if the incoming ``HttpRequest`` object

       has an attribute called ``urlconf``, its value will be used in

       place of the ``ROOT_URLCONF`` setting.

    2. Django loads that Python module and looks for the variable

       ``urlpatterns``. This should be a Python list, in the format returned by

       the function ``django.conf.urls.defaults.patterns()``.