summaryrefslogtreecommitdiff
path: root/coverage/__init__.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2009-05-09 20:46:58 -0400
committerNed Batchelder <ned@nedbatchelder.com>2009-05-09 20:46:58 -0400
commit1f7fcec9352691a6e7a90c20e13dc59b65865030 (patch)
treecb24410520bf6cd1060eb08060bbb11ce75a0316 /coverage/__init__.py
parent30ddcc968a6654f5cdb5ccce6d7f1490ff4995b5 (diff)
downloadpython-coveragepy-git-1f7fcec9352691a6e7a90c20e13dc59b65865030.tar.gz
More docstrings all around.
Diffstat (limited to 'coverage/__init__.py')
-rw-r--r--coverage/__init__.py12
1 files changed, 10 insertions, 2 deletions
diff --git a/coverage/__init__.py b/coverage/__init__.py
index c1b95874..c787b341 100644
--- a/coverage/__init__.py
+++ b/coverage/__init__.py
@@ -23,12 +23,20 @@ from coverage.misc import CoverageException
_the_coverage = None
def _singleton_method(name):
- def func(*args, **kwargs):
+ """Return a function to the `name` method on a singleton `coverage` object.
+
+ The singleton object is created the first time one of these functions is
+ called.
+
+ """
+ def wrapper(*args, **kwargs):
+ """Singleton wrapper around a coverage method."""
global _the_coverage
if not _the_coverage:
_the_coverage = coverage()
return getattr(_the_coverage, name)(*args, **kwargs)
- return func
+ return wrapper
+
# Define the module-level functions.
use_cache = _singleton_method('use_cache')