Usage notes and examples for HttpRequest.path and HttpRequest.path_info in docs are mixed up

[Kashemir001]

Documentation for ​HttpRequest.get_full_path_info() gives the returning value example:

Example: "/minfo/music/bands/the_beatles/?print=true"

which implies that the script prefix part, here /minfo, is contained in the returning value of HttpRequest.path_info.

Now, docs for ​path_info itself say:

For example, if the WSGIScriptAlias for your application is set to "/minfo", then ``path`` might be "/minfo/music/bands/the_beatles/" and ``path_info`` would be "/music/bands/the_beatles/".

which implies that prefix part is not contained in HttpRequest.path_info, but in HttpRequest.path. This contradicts previous example.

Looking at the ​unit test for the subject, prefix is actually expected to be included in path_info. Therefore, the correct example for ​path_info should say:

For example, if the WSGIScriptAlias for your application is set to "/minfo", then ``path`` might be "/music/bands/the_beatles/" and ``path_info`` would be "/minfo/music/bands/the_beatles/".

The usage notes for both attributes should be updated as well, so both sections updated might look like:

``HttpRequest.path``
A string representing the path to the requested page, not including the scheme, domain, script prefix, or query string.

Example: "/music/bands/the_beatles/"

Under some web server configurations, the portion of the URL after the host name is split up into a script prefix portion and a path info portion. The ``path`` attribute always contains the path info portion of the path, no matter what web server is being used. Using this instead of ``path_info`` can make your code easier to move between test and deployment servers.

For example, If the WSGIScriptAlias for your application is set to "/minfo", then ``path`` might be "/music/bands/the_beatles/" and ``path_info`` would be "/minfo/music/bands/the_beatles/".

``HttpRequest.path_info``
The ``path_info`` attribute contains the full path, including both the script prefix portion and the path info portion of the path, unlike the ``path`` attribute.

Example: "/minfo/music/bands/the_beatles/"

[Sarah Boyce]

I agree that the examples are mixed up and we should have the following:

docs/ref/request-response.txt

@@ -351 +351 @@
 
     Returns the ``path``, plus an appended query string, if applicable.
 
-    Example: ``"/music/bands/the_beatles/?print=true"``
+    Example: ``"/minfo/music/bands/the_beatles/?print=true"``
 
 .. method:: HttpRequest.get_full_path_info()
 
     Like :meth:`get_full_path`, but uses :attr:`path_info` instead of
     :attr:`path`.
 
-    Example: ``"/minfo/music/bands/the_beatles/?print=true"``
+    Example: ``"/music/bands/the_beatles/?print=true"``

The test you have linked seems to be a misleading test, the prefix is in path rather than path_info see:

• ​https://github.com/django/django/blob/d755a98b8438c10f3cff61303ceb1fe16d414e9b/django/core/handlers/wsgi.py#L67
• ​https://github.com/django/django/blob/d755a98b8438c10f3cff61303ceb1fe16d414e9b/django/core/handlers/asgi.py#L57
• ​https://github.com/django/django/blob/d755a98b8438c10f3cff61303ceb1fe16d414e9b/tests/handlers/tests.py#L345

Would you like to create a PR?

[Kashemir001]

Replying to Sarah Boyce:

Would you like to create a PR?
It might make sense to also update the linked test to be less misleading

Alright, I'll give it a go. Will switching attribute values and corresponding asserts be enough for the tests? Something about:

tests/requests_tests/tests.py

@@ -54 +54 @@
    def test_httprequest_full_path(self):
        request = HttpRequest()
-       request.path = "/;some/?awful/=path/foo:bar/"
-       request.path_info = "/prefix" + request.path
+       request.path_info = "/;some/?awful/=path/foo:bar/"
+       request.path = "/prefix" + request.path_info
        request.META["QUERY_STRING"] = ";some=query&+query=string"
        expected = "/%3Bsome/%3Fawful/%3Dpath/foo:bar/?;some=query&+query=string"
-       self.assertEqual(request.get_full_path(), expected)
-       self.assertEqual(request.get_full_path_info(), "/prefix" + expected)
+       self.assertEqual(request.get_full_path_info(), expected)
+       self.assertEqual(request.get_full_path(), "/prefix" + expected)
 
    def test_httprequest_full_path_with_query_string_and_fragment(self):
        request = HttpRequest()
-       request.path = "/foo#bar"
-       request.path_info = "/prefix" + request.path
+       request.path_info = "/foo#bar"
+       request.path = "/prefix" + request.path_info
        request.META["QUERY_STRING"] = "baz#quux"
-       self.assertEqual(request.get_full_path(), "/foo%23bar?baz#quux")
-       self.assertEqual(request.get_full_path_info(), "/prefix/foo%23bar?baz#quux")
+       self.assertEqual(request.get_full_path_info(), "/foo%23bar?baz#quux")
+       self.assertEqual(request.get_full_path(), "/prefix/foo%23bar?baz#quux")
 

[Kashemir001]

​PR

[Sarah Boyce <42296566+sarahboyce@…>]

In 96c79be4:

Fixed #36332 -- Corrected HttpRequest.get_full_path() and HttpRequest.get_full_path_info() examples.