~ntt-pf-lab/nova/monkey_patch_notification

« back to all changes in this revision

Viewing changes to vendor/Twisted-10.0.0/doc/core/man/trial-man.html

  • Committer: Jesse Andrews
  • Date: 2010-05-28 06:05:26 UTC
  • Revision ID: git-v1:bf6e6e718cdc7488e2da87b21e258ccc065fe499
initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html  PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN'  'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">
 
2
  <head>
 
3
<title>Twisted Documentation: TRIAL.1</title>
 
4
<link href="../howto/stylesheet.css" rel="stylesheet" type="text/css"/>
 
5
  </head>
 
6
 
 
7
  <body bgcolor="white">
 
8
    <h1 class="title">TRIAL.1</h1>
 
9
    <div class="toc"><ol><li><a href="#auto0">NAME</a></li><li><a href="#auto1">SYNOPSIS</a></li><li><a href="#auto2">DESCRIPTION</a></li><li><a href="#auto3">AUTHOR</a></li><li><a href="#auto4">REPORTING BUGS</a></li><li><a href="#auto5">COPYRIGHT</a></li></ol></div>
 
10
    <div class="content">
 
11
 
 
12
<span/>
 
13
 
 
14
<h2>NAME<a name="auto0"/></h2>
 
15
 
 
16
<p>trial - run unit tests
 
17
</p>
 
18
 
 
19
<h2>SYNOPSIS<a name="auto1"/></h2>
 
20
 
 
21
<p><strong>trial</strong>  [options] [[file|package|module|TestCase|testmethod]...]</p>
 
22
 
 
23
<p><strong>trial</strong>  --help</p>
 
24
 
 
25
<h2>DESCRIPTION<a name="auto2"/></h2>
 
26
 
 
27
<p>trial loads and executes a suite of unit tests, obtained from modules,
 
28
packages and files listed on the command line.
 
29
</p>
 
30
 
 
31
<p>trial will take either filenames or fully qualified Python names as
 
32
arguments.  Thus 'trial myproject/foo.py', 'trial myproject.foo' and
 
33
 'trial myproject.foo.SomeTestCase.test_method' are all valid ways to
 
34
invoke trial.
 
35
<dl><dt><strong>-b</strong>, <strong>--debug</strong>
 
36
</dt><dd>Run the tests in the Python debugger. Also does post-mortem
 
37
debugging on exceptions. Will load '.pdbrc' from current directory if
 
38
it exists.
 
39
</dd>
 
40
 
 
41
<dt><strong>-B</strong>, <strong>--debug-stacktraces</strong>
 
42
</dt><dd>Report Deferred creation and callback stack traces
 
43
</dd>
 
44
 
 
45
<dt><strong>--coverage</strong>
 
46
</dt><dd>Generate coverage information in _trial_temp/coverage/. Requires Python 2.3
 
47
or higher.
 
48
</dd>
 
49
 
 
50
<dt><strong>--disablegc</strong>
 
51
</dt><dd>Disable the garbage collector.  I don't know why this is in trial.
 
52
</dd>
 
53
 
 
54
<dt><strong>-x</strong>, <strong>--extra</strong>
 
55
</dt><dd>Add an extra argument. (This is a hack necessary for interfacing with emacs's
 
56
`gud'.)
 
57
</dd>
 
58
 
 
59
<dt><strong>-e</strong>, <strong>--rterrors</strong>
 
60
</dt><dd>Print tracebacks to standard output as soon as they occur
 
61
</dd>
 
62
 
 
63
<dt><strong>--force-gc</strong>
 
64
</dt><dd>Run gc.collect() before and after each test case. This can be used to
 
65
isolate errors that occur when objects get collected.  This option would be
 
66
the default, except it makes tests run about ten times slower.
 
67
</dd>
 
68
 
 
69
<dt><strong>-h</strong>, <strong>--help</strong>
 
70
</dt><dd>Print a usage message to standard output, then exit.
 
71
</dd>
 
72
 
 
73
<dt><strong>--help-reporters</strong>
 
74
</dt><dd>Print a list of valid reporters to standard output, then exit.
 
75
</dd>
 
76
 
 
77
<dt><strong>--help-reactors</strong>
 
78
</dt><dd>List the names of possibly available reactors.
 
79
</dd>
 
80
 
 
81
<dt><strong>-l</strong>, <strong>--logfile</strong> &lt;logfile&gt;
 
82
</dt><dd>Direct the log to a different file. The default file is 'test.log'.
 
83
&lt;logfile&gt; is relative to _trial_temp.
 
84
</dd>
 
85
 
 
86
<dt><strong>-n</strong>, <strong>--dry-run</strong>
 
87
</dt><dd>Go through all the tests and make them pass without running.
 
88
</dd>
 
89
 
 
90
<dt><strong>-N</strong>, <strong>--no-recurse</strong>
 
91
</dt><dd>By default, trial recurses through packages to find every module inside
 
92
every subpackage.  Unless, that is, you specify this option.
 
93
</dd>
 
94
 
 
95
<dt><strong>--nopm</strong>
 
96
</dt><dd>Don't automatically jump into debugger for post-mortem analysis of
 
97
exceptions.  Only usable in conjunction with --debug.
 
98
</dd>
 
99
 
 
100
<dt><strong>--profile</strong>
 
101
</dt><dd>Run tests under the Python profiler.
 
102
</dd>
 
103
 
 
104
<dt><strong>-r</strong>, <strong>--reactor</strong> <em>&lt;reactor&gt;</em>
 
105
</dt><dd>Choose which reactor to use.  See --help-reactors for a list.
 
106
</dd>
 
107
 
 
108
<dt><strong>--recursionlimit</strong>
 
109
</dt><dd>Set Python's recursion limit. See sys.setrecursionlimit()
 
110
</dd>
 
111
 
 
112
<dt><strong>--reporter</strong>
 
113
</dt><dd>Select the reporter to use for Trial's output.  Use the --help-reporters
 
114
option to see a list of valid reporters.
 
115
</dd>
 
116
 
 
117
<dt><strong>--spew</strong>
 
118
</dt><dd>Print an insanely verbose log of everything that happens. Useful when
 
119
debugging freezes or locks in complex code.
 
120
</dd>
 
121
 
 
122
<dt><strong>--tbformat</strong> &lt;format&gt;
 
123
</dt><dd>Format to display tracebacks with. Acceptable values are 'default', 'brief'
 
124
and 'verbose'. 'brief' produces tracebacks that play nicely with Emacs' GUD.
 
125
</dd>
 
126
 
 
127
<dt><strong>--temp-directory &lt;directory&gt;</strong>
 
128
</dt><dd>WARNING: Do not use this options unless you know what you are doing. 
 
129
By default, trial creates a directory called _trial_temp under the current
 
130
working directory.  When trial runs, it first <em>deletes</em> this directory,
 
131
then creates it, then changes into the directory to run the tests. The log
 
132
file and any coverage files are stored here. Use this option if you wish to
 
133
have trial run in a directory other than _trial_temp. Be warned, trial
 
134
will <em>delete</em> the directory before re-creating it.
 
135
</dd>
 
136
 
 
137
<dt><strong>--testmodule &lt;filename&gt;</strong>
 
138
</dt><dd>Ask trial to look into &lt;filename&gt; and run any tests specified using the
 
139
Emacs-style buffer variable 'test-case-name'.
 
140
</dd>
 
141
 
 
142
<dt><strong>--unclean-warnings</strong>
 
143
</dt><dd>As of Twisted 8.0, trial will report an error if the reactor is left unclean
 
144
at the end of the test. This option is provided to assist in migrating from
 
145
Twisted 2.5 to Twisted 8.0 and later. Enabling this option will turn the errors
 
146
into warnings.
 
147
</dd>
 
148
 
 
149
<dt><strong>-u</strong>, <strong>--until-failure</strong>
 
150
</dt><dd>Keep looping the tests until one of them raises an error or a failure.
 
151
This is particularly useful for reproducing intermittent failures.
 
152
</dd>
 
153
 
 
154
<dt><strong>--version</strong>
 
155
</dt><dd>Prints the Twisted version number and exit.
 
156
</dd>
 
157
 
 
158
<dt><strong>--without-module &lt;modulenames&gt;</strong>
 
159
</dt><dd>Simulate the lack of the specified comma-separated list of modules. This makes
 
160
it look like the modules are not present in the system, causing tests to check
 
161
the behavior for that configuration.
 
162
</dd>
 
163
 
 
164
<dt><strong>-z</strong>, <strong>--random [&lt;seed&gt;]</strong>
 
165
</dt><dd>Run the tests in random order using the specified seed.
 
166
</dd>
 
167
 
 
168
</dl>
 
169
 
 
170
</p>
 
171
 
 
172
<h2>AUTHOR<a name="auto3"/></h2>
 
173
 
 
174
<p>Written by Jonathan M. Lange
 
175
</p>
 
176
 
 
177
<h2>REPORTING BUGS<a name="auto4"/></h2>
 
178
 
 
179
<p>To report a bug, visit <em>http://twistedmatrix.com/bugs/</em>
 
180
</p>
 
181
 
 
182
<h2>COPYRIGHT<a name="auto5"/></h2>
 
183
 
 
184
<p>Copyright © 2003-2008 Twisted Matrix Laboratories
 
185
This is free software; see the source for copying conditions.  There is NO
 
186
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
187
</p>
 
188
 
 
189
</div>
 
190
 
 
191
    <p><a href="../howto/index.html">Index</a></p>
 
192
    <span class="version">Version: 10.0.0</span>
 
193
  </body>
 
194
</html>
 
 
b'\\ No newline at end of file'