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

fixing cross-reference links on API doc page

Browse source
This commit is contained in:
matt swanson 2011-03-13 15:32:19 -09:00
parent 00c5b7a937
commit 4141afa22b
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/api.rst
View file

@ -40,24 +40,24 @@ Incoming Request Data
This is a proxy. See :ref:`notes-on-proxies` for more information. This is a proxy. See :ref:`notes-on-proxies` for more information.
The request object is an instance of a :class:`~werkzeug.Request` The request object is an instance of a :class:`~werkzeug.wrappers.Request`
subclass and provides all of the attributes Werkzeug defines. This subclass and provides all of the attributes Werkzeug defines. This
just shows a quick overview of the most important ones. just shows a quick overview of the most important ones.
.. attribute:: form .. attribute:: form
A :class:`~werkzeug.MultiDict` with the parsed form data from `POST` A :class:`~werkzeug.datastructures.MultiDict` with the parsed form data from `POST`
or `PUT` requests. Please keep in mind that file uploads will not or `PUT` requests. Please keep in mind that file uploads will not
end up here, but instead in the :attr:`files` attribute. end up here, but instead in the :attr:`files` attribute.
.. attribute:: args .. attribute:: args
A :class:`~werkzeug.MultiDict` with the parsed contents of the query A :class:`~werkzeug.datastructures.MultiDict` with the parsed contents of the query
string. (The part in the URL after the question mark). string. (The part in the URL after the question mark).
.. attribute:: values .. attribute:: values
A :class:`~werkzeug.CombinedMultiDict` with the contents of both A :class:`~werkzeug.datastructures.CombinedMultiDict` with the contents of both
:attr:`form` and :attr:`args`. :attr:`form` and :attr:`args`.
.. attribute:: cookies .. attribute:: cookies
@ -79,11 +79,11 @@ Incoming Request Data
.. attribute:: files .. attribute:: files
A :class:`~werkzeug.MultiDict` with files uploaded as part of a A :class:`~werkzeug.datastructures.MultiDict` with files uploaded as part of a
`POST` or `PUT` request. Each file is stored as `POST` or `PUT` request. Each file is stored as
:class:`~werkzeug.FileStorage` object. It basically behaves like a :class:`~werkzeug.datastructures.FileStorage` object. It basically behaves like a
standard file object you know from Python, with the difference that standard file object you know from Python, with the difference that
it also has a :meth:`~werkzeug.FileStorage.save` function that can it also has a :meth:`~werkzeug.datastructures.FileStorage.save` function that can
store the file on the filesystem. store the file on the filesystem.
.. attribute:: environ .. attribute:: environ
@ -228,7 +228,7 @@ Useful Functions and Classes
.. function:: abort(code) .. function:: abort(code)
Raises an :exc:`~werkzeug.exception.HTTPException` for the given Raises an :exc:`~werkzeug.exceptions.HTTPException` for the given
status code. For example to abort request handling with a page not status code. For example to abort request handling with a page not
found exception, you would call ``abort(404)``. found exception, you would call ``abort(404)``.
@ -308,7 +308,7 @@ Useful Internals
.. data:: _request_ctx_stack .. data:: _request_ctx_stack
The internal :class:`~werkzeug.LocalStack` that is used to implement The internal :class:`~werkzeug.local.LocalStack` that is used to implement
all the context local objects used in Flask. This is a documented all the context local objects used in Flask. This is a documented
instance and can be used by extensions and application code but the instance and can be used by extensions and application code but the
use is discouraged in general. use is discouraged in general.
@ -435,7 +435,7 @@ exceptions where it is good to know that this object is an actual proxy:
:ref:`signals`) :ref:`signals`)
If you need to get access to the underlying object that is proxied, you If you need to get access to the underlying object that is proxied, you
can use the :meth:`~werkzeug.LocalProxy._get_current_object` method:: can use the :meth:`~werkzeug.local.LocalProxy._get_current_object` method::
app = current_app._get_current_object() app = current_app._get_current_object()
my_signal.send(app) my_signal.send(app)