maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Merge pull request #1325 from bsutherland/rqst_properteis_doc_iri_patch

Browse source 
Clarify contents of request properties.
This commit is contained in:
Markus Unterwaditzer 2015-03-05 22:03:54 +01:00
commit 7ae1c5a8b9
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/api.rst
View file

@ -92,25 +92,26 @@ Incoming Request Data
.. attribute:: base_url .. attribute:: base_url
.. attribute:: url_root .. attribute:: url_root
Provides different ways to look at the current URL. Imagine your Provides different ways to look at the current
application is listening on the following URL:: `IRI<http://tools.ietf.org/html/rfc3987>`_. Imagine your
application is listening on the following application root::
http://www.example.com/myapplication http://www.example.com/myapplication
And a user requests the following URL:: And a user requests the following URI::
http://www.example.com/myapplication/page.html?x=y http://www.example.com/myapplication/%CF%80/page.html?x=y
In this case the values of the above mentioned attributes would be In this case the values of the above mentioned attributes would be
the following: the following:
============= ====================================================== ============= ======================================================
`path` ``/page.html`` `path` ``u'/π/page.html'``
`full_path` ``/page.html?x=y`` `full_path` ``u'/π/page.html?x=y'``
`script_root` ``/myapplication`` `script_root` ``u'/myapplication'``
`base_url` ``http://www.example.com/myapplication/page.html`` `base_url` ``u'http://www.example.com/myapplication/π/page.html'``
`url` ``http://www.example.com/myapplication/page.html?x=y`` `url` ``u'http://www.example.com/myapplication/π/page.html?x=y'``
`url_root` ``http://www.example.com/myapplication/`` `url_root` ``u'http://www.example.com/myapplication/'``
============= ====================================================== ============= ======================================================
.. attribute:: is_xhr .. attribute:: is_xhr