improved documentation for config.from_object (#1870)
This commit is contained in:
parent
024fbe5a60
commit
d88c08e56f
2 changed files with 9 additions and 3 deletions
|
|
@ -310,6 +310,7 @@ that experience:
|
||||||
limit yourself to request-only accesses to the configuration you can
|
limit yourself to request-only accesses to the configuration you can
|
||||||
reconfigure the object later on as needed.
|
reconfigure the object later on as needed.
|
||||||
|
|
||||||
|
.. _config-dev-prod:
|
||||||
|
|
||||||
Development / Production
|
Development / Production
|
||||||
------------------------
|
------------------------
|
||||||
|
|
|
||||||
|
|
@ -143,10 +143,12 @@ class Config(dict):
|
||||||
- a string: in this case the object with that name will be imported
|
- a string: in this case the object with that name will be imported
|
||||||
- an actual object reference: that object is used directly
|
- an actual object reference: that object is used directly
|
||||||
|
|
||||||
Objects are usually either modules or classes.
|
Objects are usually either modules or classes. :meth:`from_object`
|
||||||
|
loads only the uppercase attributes of the module/class. A ``dict``
|
||||||
|
object will not work with :meth:`from_object` because the keys of a
|
||||||
|
``dict`` are not attributes of the ``dict`` class.
|
||||||
|
|
||||||
Just the uppercase variables in that object are stored in the config.
|
Example of module-based configuration::
|
||||||
Example usage::
|
|
||||||
|
|
||||||
app.config.from_object('yourapplication.default_config')
|
app.config.from_object('yourapplication.default_config')
|
||||||
from yourapplication import default_config
|
from yourapplication import default_config
|
||||||
|
|
@ -157,6 +159,9 @@ class Config(dict):
|
||||||
with :meth:`from_pyfile` and ideally from a location not within the
|
with :meth:`from_pyfile` and ideally from a location not within the
|
||||||
package because the package might be installed system wide.
|
package because the package might be installed system wide.
|
||||||
|
|
||||||
|
See :ref:`config-dev-prod` for an example of class-based configuration
|
||||||
|
using :meth:`from_object`.
|
||||||
|
|
||||||
:param obj: an import name or object
|
:param obj: an import name or object
|
||||||
"""
|
"""
|
||||||
if isinstance(obj, string_types):
|
if isinstance(obj, string_types):
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue