summaryrefslogtreecommitdiffstats
path: root/Doc/library/logging.config.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2011-04-19 12:56:39 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2011-04-19 12:56:39 (GMT)
commitf97255fd7c1d2b70dfe8032a54ce3ce0daf4cea3 (patch)
tree4d493ad4fcdf9e4360a39a9799329ac42f301e63 /Doc/library/logging.config.rst
parentcc3f02938037550118e008e9130534b84e887682 (diff)
downloadcpython-f97255fd7c1d2b70dfe8032a54ce3ce0daf4cea3.zip
cpython-f97255fd7c1d2b70dfe8032a54ce3ce0daf4cea3.tar.gz
cpython-f97255fd7c1d2b70dfe8032a54ce3ce0daf4cea3.tar.bz2
Updated documentation on fileConfig().
Diffstat (limited to 'Doc/library/logging.config.rst')
-rw-r--r--Doc/library/logging.config.rst23
1 files changed, 17 insertions, 6 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 143916f..bb80a7f 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -74,14 +74,25 @@ in :mod:`logging` itself) and defining handlers which are declared either in
.. versionadded:: 3.2
-.. function:: fileConfig(fname[, defaults])
+.. function:: fileConfig(fname, defaults=None, disable_existing_loggers=True)
- Reads the logging configuration from a :mod:`configparser`\-format file named
- *fname*. This function can be called several times from an application,
- allowing an end user to select from various pre-canned
+ Reads the logging configuration from a :mod:`configparser`\-format file
+ named *fname*. This function can be called several times from an
+ application, allowing an end user to select from various pre-canned
configurations (if the developer provides a mechanism to present the choices
- and load the chosen configuration). Defaults to be passed to the ConfigParser
- can be specified in the *defaults* argument.
+ and load the chosen configuration).
+
+ :param defaults: Defaults to be passed to the ConfigParser can be specified
+ in this argument.
+
+ :param disable_existing_loggers: If specified as ``False``, loggers which
+ exist when this call is made are left
+ alone. The default is ``True`` because this
+ enables old behaviour in a backward-
+ compatible way. This behaviour is to
+ disable any existing loggers unless they or
+ their ancestors are explicitly named in the
+ logging configuration.
.. function:: listen(port=DEFAULT_LOGGING_CONFIG_PORT)