OLD | NEW |
1 =========== | 1 =========== |
2 coverage.py | 2 coverage.py |
3 =========== | 3 =========== |
4 | 4 |
5 :history: 20090524T134300, brand new docs. | 5 :history: 20090524T134300, brand new docs. |
6 :history: 20090613T164000, final touches for 3.0 | 6 :history: 20090613T164000, final touches for 3.0 |
7 :history: 20090618T195900, minor tweaks | 7 :history: 20090618T195900, minor tweaks |
8 :history: 20090707T205200, changes for 3.0.1 | 8 :history: 20090707T205200, changes for 3.0.1 |
9 :history: 20090913T084400, new command line syntax | 9 :history: 20090913T084400, new command line syntax |
10 :history: 20091004T211900, version 3.1 | 10 :history: 20091004T211900, version 3.1 |
(...skipping 11 matching lines...) Expand all Loading... |
22 :history: 20110827T221800, update for 3.5.1b1 | 22 :history: 20110827T221800, update for 3.5.1b1 |
23 :history: 20110923T081800, update for 3.5.1 | 23 :history: 20110923T081800, update for 3.5.1 |
24 :history: 20120429T162100, updated for 3.5.2b1 | 24 :history: 20120429T162100, updated for 3.5.2b1 |
25 :history: 20120503T233800, updated for 3.5.2 | 25 :history: 20120503T233800, updated for 3.5.2 |
26 :history: 20120929T093500, updated for 3.5.3 | 26 :history: 20120929T093500, updated for 3.5.3 |
27 :history: 20121117T094900, Change from easy_install to pip. | 27 :history: 20121117T094900, Change from easy_install to pip. |
28 :history: 20121128T203700, Updated for 3.6b1. | 28 :history: 20121128T203700, Updated for 3.6b1. |
29 :history: 20121223T180600, Updated for 3.6b2. | 29 :history: 20121223T180600, Updated for 3.6b2. |
30 :history: 20121229T112300, Updated for 3.6b3. | 30 :history: 20121229T112300, Updated for 3.6b3. |
31 :history: 20130105T174000, Updated for 3.6 | 31 :history: 20130105T174000, Updated for 3.6 |
| 32 :history: 20131005T210000, Updated for 3.7 |
| 33 :history: 20131212T213300, Updated for 3.7.1 |
32 | 34 |
33 | 35 |
34 Coverage.py is a tool for measuring code coverage of Python programs. It | 36 Coverage.py is a tool for measuring code coverage of Python programs. It |
35 monitors your program, noting which parts of the code have been executed, then | 37 monitors your program, noting which parts of the code have been executed, then |
36 analyzes the source to identify code that could have been executed but was not. | 38 analyzes the source to identify code that could have been executed but was not. |
37 | 39 |
38 Coverage measurement is typically used to gauge the effectiveness of tests. It | 40 Coverage measurement is typically used to gauge the effectiveness of tests. It |
39 can show which parts of your code are being exercised by tests, and which are | 41 can show which parts of your code are being exercised by tests, and which are |
40 not. | 42 not. |
41 | 43 |
42 .. ifconfig:: not prerelease | 44 .. ifconfig:: not prerelease |
43 | 45 |
44 The latest version is coverage.py 3.6, released 5 January 2013. | 46 The latest version is coverage.py 3.7.1, released 13 December 2013. |
45 It is supported on Python versions 2.3 through 3.3, and PyPy 1.8. | 47 It is supported on Python versions 2.3 through 3.4, and PyPy 2.1. |
46 | 48 |
47 .. ifconfig:: prerelease | 49 .. ifconfig:: prerelease |
48 | 50 |
49 The latest version is coverage.py 3.6b3, released 29 December 2012. | 51 The latest version is coverage.py 3.6b3, released 29 December 2012. |
50 It is supported on Python versions 2.3 through 3.3, and PyPy 1.9. | 52 It is supported on Python versions 2.3 through 3.3, and PyPy 1.9. |
51 **This is a pre-release build. The usual warnings about possible bugs apply
.** | 53 **This is a pre-release build. The usual warnings about possible bugs apply
.** |
52 The latest stable version is coverage.py 3.5.3, `described here`_. | 54 The latest stable version is coverage.py 3.5.3, `described here`_. |
53 | 55 |
54 .. _described here: http://nedbatchelder.com/code/coverage | 56 .. _described here: http://nedbatchelder.com/code/coverage |
55 | 57 |
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
127 | 129 |
128 Getting help | 130 Getting help |
129 ------------ | 131 ------------ |
130 | 132 |
131 If the :ref:`FAQ <faq>` doesn't answer your question, you can discuss | 133 If the :ref:`FAQ <faq>` doesn't answer your question, you can discuss |
132 coverage.py or get help using it on the `Testing In Python`_ mailing list. | 134 coverage.py or get help using it on the `Testing In Python`_ mailing list. |
133 | 135 |
134 .. _Testing In Python: http://lists.idyll.org/listinfo/testing-in-python | 136 .. _Testing In Python: http://lists.idyll.org/listinfo/testing-in-python |
135 | 137 |
136 Bug reports are gladly accepted at the `Bitbucket issue tracker`_. | 138 Bug reports are gladly accepted at the `Bitbucket issue tracker`_. |
137 Bitbucket also hosts the `code repository`_. | 139 Bitbucket also hosts the `code repository`_. There is a `mirrored repo`_ on |
| 140 Github. |
138 | 141 |
139 .. _Bitbucket issue tracker: http://bitbucket.org/ned/coveragepy/issues | 142 .. _Bitbucket issue tracker: http://bitbucket.org/ned/coveragepy/issues |
140 .. _code repository: http://bitbucket.org/ned/coveragepy | 143 .. _code repository: http://bitbucket.org/ned/coveragepy |
| 144 .. _mirrored repo: https://github.com/nedbat/coveragepy |
141 | 145 |
142 `I can be reached`_ in a number of ways. I'm happy to answer questions about | 146 `I can be reached`_ in a number of ways. I'm happy to answer questions about |
143 using coverage.py. I'm also available hourly for consultation or custom | 147 using coverage.py. |
144 development. | |
145 | 148 |
146 .. _I can be reached: http://nedbatchelder.com/site/aboutned.html | 149 .. _I can be reached: http://nedbatchelder.com/site/aboutned.html |
147 | 150 |
148 | 151 |
149 | 152 |
150 More information | 153 More information |
151 ---------------- | 154 ---------------- |
152 | 155 |
153 .. toctree:: | 156 .. toctree:: |
154 :maxdepth: 1 | 157 :maxdepth: 1 |
155 | 158 |
156 install | 159 install |
157 cmd | 160 cmd |
158 config | 161 config |
159 source | 162 source |
160 excluding | 163 excluding |
161 branch | 164 branch |
162 subprocess | 165 subprocess |
163 api | 166 api |
164 contributing | 167 contributing |
165 trouble | 168 trouble |
166 faq | 169 faq |
167 changes | 170 changes |
168 | 171 |
169 | 172 |
170 .. How it works | 173 .. How it works |
171 .. .coverage file format | 174 .. .coverage file format |
OLD | NEW |