[Zope3-checkins] SVN: Zope3/trunk/src/zope/importtool/reporter.py
add docstrings that explain when and how the methods of the
reporter are called
Fred L. Drake, Jr.
fred at zope.com
Thu May 27 22:50:30 EDT 2004
Log message for revision 25074:
add docstrings that explain when and how the methods of the reporter are called
-=-
Modified: Zope3/trunk/src/zope/importtool/reporter.py
===================================================================
--- Zope3/trunk/src/zope/importtool/reporter.py 2004-05-28 02:29:08 UTC (rev 25073)
+++ Zope3/trunk/src/zope/importtool/reporter.py 2004-05-28 02:50:29 UTC (rev 25074)
@@ -20,7 +20,28 @@
"""Trivial implementation of the reporter interface."""
def request(self, importer, name, fromlist):
- pass
+ """Called before the import is performed.
+ `importer` is the full name of the module performing the import.
+
+ `name` is the module name requested for the import. This may
+ be a relative module name. It may represent a module that has
+ already been loaded.
+
+ `fromlist` is the `fromlist` argument to `__import__()`.
+
+ This method may veto the import by raising an exception.
+ """
+
def found(self, importer, imported, fromlist):
- pass
+ """Called after the import has been performed.
+
+ `importer` is the full name of the module performing the import.
+
+ `imported` is the full name of the module that was actually
+ imported.
+
+ `fromlist` is the `fromlist` argument to `__import__()`.
+
+ This method may veto the import by raising an exception.
+ """
More information about the Zope3-Checkins
mailing list