mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-06 18:09:12 +00:00
Code Issues 32 Releases Wiki Activity

Added examples to HttpRequest.build_absolute_uri() docs.

Browse Source
This commit is contained in:
Adam Johnson 2018-12-30 00:44:45 +00:00 committed by Tim Graham
parent e817ae74da
commit b71e3d635a
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/ref/request-response.txt
View File

@ -293,16 +293,21 @@ Methods
Example: ``"/minfo/music/bands/the_beatles/?print=true"`` Example: ``"/minfo/music/bands/the_beatles/?print=true"``
.. method:: HttpRequest.build_absolute_uri(location) .. method:: HttpRequest.build_absolute_uri(location=None)
Returns the absolute URI form of ``location``. If no location is provided, Returns the absolute URI form of ``location``. If no location is provided,
the location will be set to ``request.get_full_path()``. the location will be set to ``request.get_full_path()``.
If the location is already an absolute URI, it will not be altered. If the location is already an absolute URI, it will not be altered.
Otherwise the absolute URI is built using the server variables available in Otherwise the absolute URI is built using the server variables available in
this request. this request. For example:
Example: ``"https://example.com/music/bands/the_beatles/?print=true"`` >>> request.build_absolute_uri()
'https://example.com/music/bands/the_beatles/?print=true'
>>> request.build_absolute_uri('/bands/')
'https://example.com/bands/'
>>> request.build_absolute_uri('https://example2.com/bands/')
'https://example2.com/bands/'
.. note:: .. note::