summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSenthil Kumaran <senthil@uthcode.com>2012-04-11 03:18:45 +0800
committerSenthil Kumaran <senthil@uthcode.com>2012-04-11 03:18:45 +0800
commit6d9dd4328648603350c4e86186cf687fd97329fc (patch)
tree6be203406bd1394d8769e997a994744911846a2f
parentfb2e874707b0817124a2427a9367276b13fbc4ad (diff)
parent5628fff98db90557a798c645f3bc28a097a11613 (diff)
downloadcpython-git-6d9dd4328648603350c4e86186cf687fd97329fc.tar.gz
merge heads
-rw-r--r--Doc/howto/logging.rst15
-rw-r--r--Doc/library/logging.rst16
2 files changed, 29 insertions, 2 deletions
diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst
index 029a0abf95..79e4dc9876 100644
--- a/Doc/howto/logging.rst
+++ b/Doc/howto/logging.rst
@@ -642,6 +642,21 @@ You can see that the config file approach has a few advantages over the Python
code approach, mainly separation of configuration and code and the ability of
noncoders to easily modify the logging properties.
+.. warning:: The :func:`fileConfig` function takes a default parameter,
+ ``disable_existing_loggers``, which defaults to ``True`` for reasons of
+ backward compatibility. This may or may not be what you want, since it
+ will cause any loggers existing before the :func:`fileConfig` call to
+ be disabled unless they (or an ancestor) are explicitly named in the
+ configuration. Please refer to the reference documentation for more
+ information, and specify ``False`` for this parameter if you wish.
+
+ The dictionary passed to :func:`dictConfig` can also specify a Boolean
+ value with key ``disable_existing_loggers``, which if not specified
+ explicitly in the dictionary also defaults to being interpreted as
+ ``True``. This leads to the logger-disabling behaviour described above,
+ which may not be what you want - in which case, provide the key
+ explicitly with a value of ``False``.
+
.. currentmodule:: logging
Note that the class names referenced in config files need to be either relative
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 665485d660..b4185c3b9d 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -51,9 +51,21 @@ listed below.
Logger Objects
--------------
-Loggers have the following attributes and methods. Note that Loggers are never
+Loggers have the following attributes and methods. Note that Loggers are never
instantiated directly, but always through the module-level function
-``logging.getLogger(name)``.
+``logging.getLogger(name)``. Multiple calls to :func:`getLogger` with the same
+name will always return a reference to the same Logger object.
+
+The ``name`` is potentially a period-separated hierarchical value, like
+``foo.bar.baz`` (though it could also be just plain ``foo``, for example).
+Loggers that are further down in the hierarchical list are children of loggers
+higher up in the list. For example, given a logger with a name of ``foo``,
+loggers with names of ``foo.bar``, ``foo.bar.baz``, and ``foo.bam`` are all
+descendants of ``foo``. The logger name hierarchy is analogous to the Python
+package hierarchy, and identical to it if you organise your loggers on a
+per-module basis using the recommended construction
+``logging.getLogger(__name__)``. That's because in a module, ``__name__``
+is the module's name in the Python package namespace.
.. class:: Logger