summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-11-07 19:38:26 -0500
committerNed Batchelder <ned@nedbatchelder.com>2012-11-07 19:38:26 -0500
commit746fc885e42d7f746ae1501cd83ce3fb373791af (patch)
tree7d07e8ccb37d9d7af0f0d1b6ab0d30acf5275e17
parent3321245ed534e1d6865824cf5accec9968c65ff2 (diff)
downloadpython-coveragepy-git-746fc885e42d7f746ae1501cd83ce3fb373791af.tar.gz
Remove an odd sys.modules entry so that pydoc can find coverage.coverage. #206.
-rw-r--r--CHANGES.txt4
-rw-r--r--coverage/__init__.py6
2 files changed, 10 insertions, 0 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
index 8785d15b..363d7c6b 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -31,11 +31,15 @@ Version 3.5.4b1
- Docstrings for the legacy singleton methods are more helpful. Thanks Marius
Gedminas. Closes `issue 205`_.
+- The pydoc tool can now show docmentation for the class `coverage.coverage`.
+ Closes `issue 206`_.
+
.. _issue 139: https://bitbucket.org/ned/coveragepy/issue/139/easy-check-for-a-certain-coverage-in-tests
.. _issue 163: https://bitbucket.org/ned/coveragepy/issue/163/problem-with-include-and-omit-filename
.. _issue 193: https://bitbucket.org/ned/coveragepy/issue/193/unicodedecodeerror-on-htmlpy
.. _issue 201: https://bitbucket.org/ned/coveragepy/issue/201/coverage-using-django-14-with-pydb-on
.. _issue 205: https://bitbucket.org/ned/coveragepy/issue/205/make-pydoc-coverage-more-friendly
+.. _issue 206: https://bitbucket.org/ned/coveragepy/issue/206/pydoc-coveragecoverage-fails-with-an-error
Version 3.5.3 --- 29 September 2012
diff --git a/coverage/__init__.py b/coverage/__init__.py
index 2fc49d0f..4d82375c 100644
--- a/coverage/__init__.py
+++ b/coverage/__init__.py
@@ -78,6 +78,12 @@ analysis2 = _singleton_method('analysis2')
report = _singleton_method('report')
annotate = _singleton_method('annotate')
+# Because of the "from coverage.control import fooey" lines at the top of the
+# file, there's an entry for coverage.coverage in sys.modules, mapped to None.
+# This makes some inspection tools (like pydoc) unable to find the class
+# coverage.coverage. So remove that entry.
+import sys
+del sys.modules['coverage.coverage']
# COPYRIGHT AND LICENSE
#