summaryrefslogtreecommitdiff
path: root/Doc/library/logging.config.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2011-08-11 13:45:48 +0100
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2011-08-11 13:45:48 +0100
commit817495a63171d0bbfeaf03f3b5709e1dac399b5c (patch)
tree06be3d8763e9c1d2e60dde42e4b6a9452b18b7a9 /Doc/library/logging.config.rst
parent9dc4cad9793cd1e81d2bbc40746b55986b745309 (diff)
downloadcpython-git-817495a63171d0bbfeaf03f3b5709e1dac399b5c.tar.gz
Issue #12718: Add documentation on using custom importers.
Diffstat (limited to 'Doc/library/logging.config.rst')
-rw-r--r--Doc/library/logging.config.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index bb80a7f0fe..b2dd71e65a 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -513,6 +513,31 @@ the system will attempt to retrieve the value from
to ``config_dict['handlers']['myhandler']['mykey']['123']`` if that
fails.
+
+.. _logging-import-resolution:
+
+Import resolution and custom importers
+""""""""""""""""""""""""""""""""""""""
+
+Import resolution, by default, uses the builtin :func:`__import__` function
+to do its importing. You may want to replace this with your own importing
+mechanism: if so, you can replace the :attr:`importer` attribute of the
+:class:`DictConfigurator` or its superclass, the
+:class:`BaseConfigurator` class. However, you need to be
+careful because of the way functions are accessed from classes via
+descriptors. If you are using a Python callable to do your imports, and you
+want to define it at class level rather than instance level, you need to wrap
+it with :func:`staticmethod`. For example::
+
+ from importlib import import_module
+ from logging.config import BaseConfigurator
+
+ BaseConfigurator.importer = staticmethod(import_module)
+
+You don't need to wrap with :func:`staticmethod` if you're setting the import
+callable on a configurator *instance*.
+
+
.. _logging-config-fileformat:
Configuration file format