From 5df3b4593d26ed659e285f633a9acd11759845c8 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Fri, 26 Oct 2012 08:42:10 -0400 Subject: #205: provide more helpful docstrings for the legacy singleton methods. --- coverage/__init__.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'coverage/__init__.py') diff --git a/coverage/__init__.py b/coverage/__init__.py index 637bc7a..e2db3a5 100644 --- a/coverage/__init__.py +++ b/coverage/__init__.py @@ -42,6 +42,24 @@ def _singleton_method(name): if not _the_coverage: _the_coverage = coverage(auto_data=True) return getattr(_the_coverage, name)(*args, **kwargs) + + import inspect + meth = getattr(coverage, name) + args, varargs, kw, defaults = inspect.getargspec(meth) + argspec = inspect.formatargspec(args[1:], varargs, kw, defaults) + docstring = meth.__doc__ + wrapper.__doc__ = ("""\ + A first-use-singleton wrapper around coverage.%(name)s. + + This wrapper is provided for backward compatibility with legacy code. + New code should use coverage.%(name)s directly. + + %(name)s%(argspec)s: + + %(docstring)s + """ % locals() + ) + return wrapper -- cgit v1.2.1