orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

some grammar fixes in appcontext

Browse source 
* "in lack of" -> "for lack of"
* pillar's -> pillars
* ~~however~~
* a touch of cleanup to the "two ways" paragraph
* ~~on there~~
* "database connects" -> "database connections"
This commit is contained in:
Bill Mill 2014-09-21 23:03:41 -04:00
parent c6795eb626
commit 3b3c5b8bf3
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/appcontext.rst
View file

@ -38,8 +38,8 @@ Purpose of the Application Context
---------------------------------- ----------------------------------
The main reason for the application's context existence is that in the The main reason for the application's context existence is that in the
past a bunch of functionality was attached to the request context in lack past a bunch of functionality was attached to the request context for lack
of a better solution. Since one of the pillar's of Flask's design is that of a better solution. Since one of the pillars of Flask's design is that
you can have more than one application in the same Python process. you can have more than one application in the same Python process.
So how does the code find the “right” application? In the past we So how does the code find the “right” application? In the past we
@ -48,17 +48,17 @@ with libraries that were not designed with that in mind.
A common workaround for that problem was to use the A common workaround for that problem was to use the
:data:`~flask.current_app` proxy later on, which was bound to the current :data:`~flask.current_app` proxy later on, which was bound to the current
request's application reference. Since however creating such a request request's application reference. Since creating such a request context is
context is an unnecessarily expensive operation in case there is no an unnecessarily expensive operation in case there is no request around,
request around, the application context was introduced. the application context was introduced.
Creating an Application Context Creating an Application Context
------------------------------- -------------------------------
To make an application context there are two ways. The first one is the There are two ways to make an application context. The first one is
implicit one: whenever a request context is pushed, an application context implicit: whenever a request context is pushed, an application context
will be created alongside if this is necessary. As a result of that, you will be created alongside if this is necessary. As a result, you can
can ignore the existence of the application context unless you need it. ignore the existence of the application context unless you need it.
The second way is the explicit way using the The second way is the explicit way using the
:meth:`~flask.Flask.app_context` method:: :meth:`~flask.Flask.app_context` method::
@ -91,9 +91,9 @@ For more information about that, see :ref:`extension-dev`.
Context Usage Context Usage
------------- -------------
The context is typically used to cache resources on there that need to be The context is typically used to cache resources that need to be created
created on a per-request or usage case. For instance database connects on a per-request or usage case. For instance, database connections are
are destined to go there. When storing things on the application context destined to go there. When storing things on the application context
unique names should be chosen as this is a place that is shared between unique names should be chosen as this is a place that is shared between
Flask applications and extensions. Flask applications and extensions.