doc-src/profiling.html doc-src/tests.html doc-src/tests/autotree.html doc-src/tests/index.py doc-src/tests/tree.html examples/test_profile.py @@ -1,5 +1,4 @@ This page describes the API exposed from the __libpry__ module. - @!libpry("test")!@ doc-src/api.html @@ -0,0 +1,3 @@ + +$!examples.pry("", "--help")!$ + doc-src/cli.html @@ -3,7 +3,18 @@ Overview ======== The examples in this section can be found in the _examples/project_ directory -in the __pry__ distribution. +in the __pry__ distribution. From this directory we can run __pry__ with the -s +argument to provide a coverage summary: +$!examples.pry("examples/project/test", "-s")!$ +As the output shows, the test suite does not completely cover the file _one.py_ +- lines 5 and 8 to 11 have not been run. The contents of this file are as +follows: +$!examples.py("examples/project/module/one.py", linenos="inline")!$ + +Line 5 is clearly not covered because it is unreachable. An inspection of the +relevant portion of the test suite shows that __method2__ is never called: + +$!examples.py("examples/project/test/test_one.py")!$ doc-src/coverage.html @@ -1,5 +1,4 @@ - Many projects contain code that can not be covered by unit tests. Having these portions show up in test coverage statistics is not helpful, so __pry__ provides a way to annotate code to exempt lines from coverage. @@ -7,9 +6,14 @@ provides a way to annotate code to exempt lines from coverage. :::Example ---------- - -$!test_annotation!$ - -<div class="fname">(examples/test_basic.py)</div> +$!examples.py("examples/project/module/two.py")!$ + +Even though the code within the __nocover__ block is unreachable, it does not +show up in analysis output, and _two.py_ has 100% coverage: + +$!examples.pry("examples/project/test", "-s")!$ +If a <strong>#begin nocover</strong> directive is not matched by an +<strong>#end nocover</strong> directive, it applies to the remainder of the +file. doc-src/coverage/annotations.html @@ -38,13 +38,7 @@ should be excluded from coverage analysis. The pry unit test suite lives in a parallel __test__ directory. The <strong>.pry</strong> file in the test directory looks like this: -<pre class="output"> -base = .. -coverage = ../module -exclude = ../module/exclude.py -</pre> -<div class="fname">(examples/project/test/.pry)</div> - +$!examples.plain("examples/project/test/.pry")!$ More .pry syntax ================ doc-src/coverage/dotpry.html @@ -2,5 +2,5 @@ from countershape.doc import * pages = [ Page("dotpry.html", ".pry config file"), - Page("annotations.html", "Annotations"), + Page("annotations.html", "Code Annotation"), ] doc-src/coverage/index.py @@ -1,3 +1,4 @@ +import os, os.path, subprocess import countershape.widgets import countershape.layout import countershape.grok @@ -14,19 +15,52 @@ ns.sidebar = countershape.widgets.SiblingPageIndex( ) this.layout = countershape.layout.TwoPane("yui-t2", "doc3") -ns.test_basic = readFrom("../examples/test_basic.py") -ns.test_trees = readFrom("../examples/test_trees.py") -ns.test_autotree = readFrom("../examples/test_autotree.py") -ns.test_annotation = readFrom("../examples/project/module/two.py") +class Examples: + def __init__(self, d): + self.d = os.path.abspath(d) + def _wrap(self, proc, path): + f = file(os.path.join(self.d, path)).read() + if proc: + f = proc(f) + post = "<div class=\"fname\">(%s)</div>"%path + return f + post + + def py(self, path, **kwargs): + return self._wrap(ns.pySyntax.withConf(**kwargs), path) + + def _preProc(self, f): + return "<pre class=\"output\">%s</pre>"%f + + def plain(self, path): + return self._wrap(self._preProc, path) + + def pry(self, path, args): + cur = os.getcwd() + os.chdir(os.path.join(self.d, path)) + prog = os.path.join(self.d, "pry") + pipe = subprocess.Popen( + "%s "%prog + args, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE + ).stdout + os.chdir(cur) + + content = "> pry %s\n"%args + pipe.read() + return self._preProc(content) + + +ns.examples = Examples("..") ns.libpry = countershape.grok.grok("../libpry") pages = [ Page("index.html", "Introduction"), - Page("start.html", "Writing Tests"), - Directory("trees"), + Page("tests.html", "Writing Tests"), + Directory("tests"), Page("coverage.html", "Coverage"), Directory("coverage"), + Page("profiling.html", "Profiling"), Page("cli.html", "The pry tool"), Page("api.html", "API"), Page("admin.html", "Administrivia") doc-src/index.py @@ -3,3 +3,9 @@ def method(): return 1 else: return 2 + +def method2(): + x = 2 + if x: + y = 3 + z = 1 examples/project/module/one.py @@ -1,4 +1,3 @@ - def method(): if True: return 1 @@ -6,4 +5,3 @@ def method(): else: return 2 #end nocover - examples/project/module/two.py @@ -4,7 +4,6 @@ import module.one class One(libpry.AutoTree): def test_a(self): assert module.one.method() == 1 - tests = [ One() examples/project/test/test_one.py @@ -4,7 +4,6 @@ import module.two class Two(libpry.AutoTree): def test_a(self): assert module.two.method() == 1 - tests = [ Two() examples/project/test/test_two.py @@ -217,8 +217,9 @@ class _OutputOne(_OutputZero): width, funcs = s.get_print_list([]) s.print_title() for f in funcs: - # We don't want to know about libpry itself. - if not "/libpry/" in f[0]: + # We don't want to know about libpry itself or the profile + # disable function. + if not "/libpry/" in f[0] and not "_lsprof" in f[2]: s.print_line(f) lst.append("\n") lst.append(s.stream.getvalue()) libpry/test.py @@ -5,10 +5,10 @@ import libpry def main(): from optparse import OptionParser, OptionGroup - parser = OptionParser(version="%prog 0.1") - parser.add_option("-a", "--annotate", - action="store_true", dest="annotate", - help="Annotated coverage output.") + parser = OptionParser( + usage = "%prog [options] [testfilter]", + version="%prog 0.1", + ) parser.add_option("-c", "--clear", action="store_true", dest="clear", help="Clear all .pyc and .pyo files in the project base" @@ -22,7 +22,7 @@ def main(): help="Recurse through child directories.") parser.add_option("-s", "--stats", action="store_true", dest="stats", - help="Give coverage stats") + help="Print coverage summary.") parser.add_option("-n", "--benchmark", action="store", dest="benchmark", type="int", default=1, help="Run each test N times.") @@ -31,11 +31,11 @@ def main(): help="Quiet.") parser.add_option("-v", "--verbose", action="count", dest="verbose", default=1, - help="Verbose.") + help="Increase verbosity. Can be passed multiple times.") parser.add_option( "--debug-dump", action="store_true", dest="debug", - help="For debugging only. Like list," + help="For debugging only. Like -l," " but dump the full tree structure." ) @@ -80,7 +80,7 @@ def main(): else: parser.error("Please pass only one argument.") - if options.annotate or options.stats: + if options.stats: coverage = True else: coverage = False pry doc-src/start.html doc-src/trees/autotree.html doc-src/trees/index.py doc-src/trees/tree.html 028d3e4f186b4d96fd05bd13c817afa33d38d9af Aldo Cortesi aldo@nullcube.com http://github.com/cortesi/pry/commit/22a8217e2a7bd95ec2f6a6d3b6647b5b53122fe3 22a8217e2a7bd95ec2f6a6d3b6647b5b53122fe3

2008-04-01T02:00:17-07:00

Documentation. 7ed13901a5d3c2705e1a7cc940eef26498e026a8 Aldo Cortesi aldo@nullcube.com