python-nose2-doc 0.7.4-1 / usr / share / doc / python-nose2 / html / index.html

This file is indexed.

/usr/share/doc/python-nose2/html/index.html is in python-nose2-doc 0.7.4-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Welcome to nose2 &mdash; nose2 0.6.0 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="nose2 0.6.0 documentation" href="#"/>
        <link rel="next" title="Getting started with nose2" href="getting_started.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="#" class="icon icon-home"> nose2
          

          
          </a>

          
            
            
              <div class="version">
                0.6
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started with nose2</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using nose2</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuring nose2</a></li>
<li class="toctree-l1"><a class="reference internal" href="differences.html">Differences: nose2 vs nose vs unittest2</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins for nose2</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools and Helpers</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/writing_plugins.html">Writing Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/documenting_plugins.html">Documenting plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/event_reference.html">Event reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/hook_reference.html">Hook reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/session_reference.html">Session reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/plugin_class_reference.html">Plugin class reference</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/contributing.html">Contributing to nose2</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/internals.html">Internals</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">nose2</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="#">Docs</a> &raquo;</li>
        
      <li>Welcome to nose2</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="welcome-to-nose2">
<h1>Welcome to nose2<a class="headerlink" href="#welcome-to-nose2" title="Permalink to this headline"></a></h1>
<p><strong>Note</strong>: As of 0.7.0 we no longer support 2.6, 3.2, or 3.3. We also removed <code class="docutils literal"><span class="pre">nose2.compat</span></code>.</p>
<p><code class="docutils literal"><span class="pre">nose2</span></code> aims to improve on nose by:</p>
<blockquote>
<div><ul class="simple">
<li>providing a better plugin api</li>
<li>being easier for users to configure</li>
<li>simplifying internal interfaces and processes</li>
<li>supporting Python 2 and 3 from the same codebase, without translation</li>
<li>encouraging greater community involvement in its development</li>
</ul>
</div></blockquote>
<p>In service of some those goals, some features of <code class="docutils literal"><span class="pre">nose</span></code> <em>are not</em>
supported in <code class="docutils literal"><span class="pre">nose2</span></code>. See <a class="reference external" href="https://nose2.readthedocs.io/en/latest/differences.html">differences</a> for a thorough rundown.</p>
<div class="section" id="workflow">
<h2>Workflow<a class="headerlink" href="#workflow" title="Permalink to this headline"></a></h2>
<p>If you want to make contributions, you can use the <code class="docutils literal"><span class="pre">Makefile</span></code> to get started
quickly and easily:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># All you need is a supported version of python and virtualenv installed</span>
<span class="n">make</span> <span class="n">test</span>
</pre></div>
</div>
<p>tox will run our full test suite
against all supported version of python that you have installed locally.
Don’t worry if you don’t have all supported versions installed.
Your changes will get tested automatically when you make a PR.</p>
<p>Use <code class="docutils literal"><span class="pre">make</span> <span class="pre">help</span></code> to see other options.</p>
</div>
<div class="section" id="original-mission-present-goals">
<h2>Original Mission &amp; Present Goals<a class="headerlink" href="#original-mission-present-goals" title="Permalink to this headline"></a></h2>
<p>When <code class="docutils literal"><span class="pre">nose2</span></code> was first written, the plan for its future was to wait for
<code class="docutils literal"><span class="pre">unittest2</span></code> plugins to be released (<code class="docutils literal"><span class="pre">nose2</span></code> is actually based on the
plugins branch of <code class="docutils literal"><span class="pre">unittest2</span></code>).
Once that was done, <code class="docutils literal"><span class="pre">nose2</span></code> was to become a set of plugins and default
configuration for <code class="docutils literal"><span class="pre">unittest2</span></code>.</p>
<p>However, based on the current status of <code class="docutils literal"><span class="pre">unittest2</span></code>, it is doubtful that this
plan will ever be carried out.</p>
<div class="section" id="current-goals">
<h3>Current Goals<a class="headerlink" href="#current-goals" title="Permalink to this headline"></a></h3>
<p>Even though <code class="docutils literal"><span class="pre">unittest2</span></code> plugins never arrived, <code class="docutils literal"><span class="pre">nose2</span></code> is still being
maintained!
We have a small community interested in continuing to work on and use <code class="docutils literal"><span class="pre">nose2</span></code></p>
<p>However, given the current climate, with much more interest accruing around
<a class="reference external" href="http://pytest.readthedocs.io/en/latest/">pytest</a>, <code class="docutils literal"><span class="pre">nose2</span></code> is prioritizing bugfixes and maintenance ahead of new
feature development.</p>
</div>
</div>
</div>
<div class="section" id="user-s-guide">
<h1>User’s Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started with nose2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#running-tests">Running tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using nose2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#naming-tests">Naming Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#running-tests">Running Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#getting-help">Getting Help</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuring nose2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#configuration-files">Configuration Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#configuring-plugins">Configuring Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#test-runner-tips-and-tweaks">Test Runner Tips and Tweaks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="differences.html">Differences: nose2 vs nose vs unittest2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="differences.html#nose2-is-not-nose">nose2 is not nose</a></li>
<li class="toctree-l2"><a class="reference internal" href="differences.html#nose2-is-not-exactly-unittest2-plugins">nose2 is not (exactly) unittest2/plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins for nose2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#built-in-and-loaded-by-default">Built in and Loaded by Default</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#built-in-but-not-loaded-by-default">Built in but <em>not</em> Loaded by Default</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html#third-party-plugins">Third-party Plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Tools and Helpers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tools.html#tools-for-test-authors">Tools for Test Authors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.7.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.7.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.7.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.7.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.7.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.6.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.6.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">0.6.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">0.4.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id10">0.4.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">0.4.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id12">0.4.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">0.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id14">0.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id15">0.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id17">0.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id18">0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id19">0.1</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="plugin-developer-s-guide">
<h1>Plugin Developer’s Guide<a class="headerlink" href="#plugin-developer-s-guide" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/writing_plugins.html">Writing Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#hello-world">Hello World</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#loading-plugins">Loading plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#command-line-options">Command-line Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#config-file-options">Config File Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#guidelines">Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/writing_plugins.html#recipes">Recipes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dev/documenting_plugins.html">Documenting plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/event_reference.html">Event reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev/hook_reference.html">Hook reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/hook_reference.html#pre-registration-hooks">Pre-registration Hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/hook_reference.html#standard-hooks">Standard Hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/hook_reference.html#user-interaction-hooks">User Interaction Hooks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dev/session_reference.html">Session reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/session_reference.html#session">Session</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/session_reference.html#config">Config</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dev/plugin_class_reference.html">Plugin class reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/plugin_class_reference.html#plugin-base-class">Plugin base class</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/plugin_class_reference.html#plugin-interface-classes">Plugin interface classes</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="developer-s-guide">
<h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev/contributing.html">Contributing to nose2</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/contributing.html#the-basics">The Basics</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/contributing.html#coding-guidelines">Coding Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/contributing.html#workflow-branching-and-pull-requests">Workflow, Branching and Pull Requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/contributing.html#reporting-bugs">Reporting Bugs</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/contributing.html#requesting-enhancements">Requesting Enhancements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dev/internals.html">Internals</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev/main.html">nose2.main</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/exceptions.html">nose2.exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/loader.html">nose2.loader</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/result.html">nose2.result</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/runner.html">nose2.runner</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev/utils.html">nose2.util</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="getting_started.html" class="btn btn-neutral float-right" title="Getting started with nose2" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Jason Pellerin.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.6.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.