]> granicus.if.org Git - python/commitdiff
Issue #12718: Add documentation on using custom importers.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Thu, 11 Aug 2011 12:45:48 +0000 (13:45 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Thu, 11 Aug 2011 12:45:48 +0000 (13:45 +0100)
Doc/library/logging.config.rst

index bb80a7f0fe4f2181433dd791444330e60801cddd..b2dd71e65a1e99d9a24a67d69ea7ba1b7b0bb067 100644 (file)
@@ -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