Browse Source

Merge pull request #304 from plaes/config-docs

Improve configuration docs a bit
pull/267/merge
Ron DuPlain 13 years ago
parent
commit
b209cd96f5
  1. 38
      docs/config.rst

38
docs/config.rst

@ -5,9 +5,10 @@ Configuration Handling
.. versionadded:: 0.3 .. versionadded:: 0.3
Applications need some kind of configuration. There are different things Applications need some kind of configuration. There are different settings
you might want to change like toggling debug mode, the secret key, and a you might want to change depending on the application environment like
lot of very similar things. toggling the debug mode, setting the secret key, and other such
environment-specific things.
The way Flask is designed usually requires the configuration to be The way Flask is designed usually requires the configuration to be
available when the application starts up. You can hardcode the available when the application starts up. You can hardcode the
@ -31,8 +32,7 @@ can be modified just like any dictionary::
app.config['DEBUG'] = True app.config['DEBUG'] = True
Certain configuration values are also forwarded to the Certain configuration values are also forwarded to the
:attr:`~flask.Flask` object so that you can read and write them from :attr:`~flask.Flask` object so you can read and write them from there::
there::
app.debug = True app.debug = True
@ -139,10 +139,11 @@ The following configuration values are used internally by Flask:
Configuring from Files Configuring from Files
---------------------- ----------------------
Configuration becomes more useful if you can configure from a file, and Configuration becomes more useful if you can store it in a separate file,
ideally that file would be outside of the actual application package so that ideally located outside the actual application package. This makes
you can install the package with distribute (:ref:`distribute-deployment`) packaging and distributing your application possible via various package
and still modify that file afterwards. handling tools (:ref:`distribute-deployment`) and finally modifying the
configuration file afterwards.
So a common pattern is this:: So a common pattern is this::
@ -170,12 +171,13 @@ The configuration files themselves are actual Python files. Only values
in uppercase are actually stored in the config object later on. So make in uppercase are actually stored in the config object later on. So make
sure to use uppercase letters for your config keys. sure to use uppercase letters for your config keys.
Here is an example configuration file:: Here is an example of a configuration file::
# Example configuration
DEBUG = False DEBUG = False
SECRET_KEY = '?\xbf,\xb4\x8d\xa3"<\x9c\xb0@\x0f5\xab,w\xee\x8d$0\x13\x8b83' SECRET_KEY = '?\xbf,\xb4\x8d\xa3"<\x9c\xb0@\x0f5\xab,w\xee\x8d$0\x13\x8b83'
Make sure to load the configuration very early on so that extensions have Make sure to load the configuration very early on, so that extensions have
the ability to access the configuration when starting up. There are other the ability to access the configuration when starting up. There are other
methods on the config object as well to load from individual files. For a methods on the config object as well to load from individual files. For a
complete reference, read the :class:`~flask.Config` object's complete reference, read the :class:`~flask.Config` object's
@ -186,9 +188,9 @@ Configuration Best Practices
---------------------------- ----------------------------
The downside with the approach mentioned earlier is that it makes testing The downside with the approach mentioned earlier is that it makes testing
a little harder. There is no one 100% solution for this problem in a little harder. There is no single 100% solution for this problem in
general, but there are a couple of things you can do to improve that general, but there are a couple of things you can keep in mind to improve
experience: that experience:
1. create your application in a function and register blueprints on it. 1. create your application in a function and register blueprints on it.
That way you can create multiple instances of your application with That way you can create multiple instances of your application with
@ -203,10 +205,10 @@ experience:
Development / Production Development / Production
------------------------ ------------------------
Most applications need more than one configuration. There will at least Most applications need more than one configuration. There should be at
be a separate configuration for a production server and one used during least separate configurations for the production server and the one used
development. The easiest way to handle this is to use a default during development. The easiest way to handle this is to use a default
configuration that is always loaded and part of version control, and a configuration that is always loaded and part of the version control, and a
separate configuration that overrides the values as necessary as mentioned separate configuration that overrides the values as necessary as mentioned
in the example above:: in the example above::

Loading…
Cancel
Save