python-pyregion-doc 2.0-2ubuntu1 / usr / share / doc / python-pyregion / html / api / pyregion.test.html

This file is indexed.

/usr/share/doc/python-pyregion/html/api/pyregion.test.html is in python-pyregion-doc 2.0-2ubuntu1.

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
<!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>test &mdash; pyregion v2.0</title>
  

  
  
    <link rel="shortcut icon" href="../_static/astropy_logo.ico"/>
  
  
  

  

  
  
    

  

  
  
    <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="pyregion v2.0" href="../index.html"/>
        <link rel="up" title="Reference/API" href="../api.html"/>
        <link rel="next" title="Shape" href="pyregion.Shape.html"/>
        <link rel="prev" title="parse" href="pyregion.parse.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="../index.html" class="icon icon-home"> pyregion
          

          
          </a>

          
            
            
              <div class="version">
                2.0
              </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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">Reference/API</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../api.html#functions">Functions</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="pyregion.get_mask.html">get_mask</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyregion.open.html">open</a></li>
<li class="toctree-l3"><a class="reference internal" href="pyregion.parse.html">parse</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">test</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#classes">Classes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</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="../index.html">pyregion</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="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../api.html">Reference/API</a> &raquo;</li>
        
      <li>test</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/api/pyregion.test.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="test">
<h1>test<a class="headerlink" href="#test" title="Permalink to this headline"></a></h1>
<dl class="function">
<dt id="pyregion.test">
<code class="descclassname">pyregion.</code><code class="descname">test</code><span class="sig-paren">(</span><em>package=None</em>, <em>test_path=None</em>, <em>args=None</em>, <em>plugins=None</em>, <em>verbose=False</em>, <em>pastebin=None</em>, <em>remote_data=False</em>, <em>pep8=False</em>, <em>pdb=False</em>, <em>coverage=False</em>, <em>open_files=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyregion/_astropy_init.html#test"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyregion.test" title="Permalink to this definition"></a></dt>
<dd><p>Run the tests using <a class="reference external" href="http://pytest.org/latest">py.test</a>. A proper set
of arguments is constructed and passed to <a class="reference external" href="http://pytest.org/latest/builtin.html#pytest.main">pytest.main</a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>package</strong> : str, optional</p>
<blockquote>
<div><p>The name of a specific package to test, e.g. ‘io.fits’ or ‘utils’.
If nothing is specified all default tests are run.</p>
</div></blockquote>
<p><strong>test_path</strong> : str, optional</p>
<blockquote>
<div><p>Specify location to test by path. May be a single file or
directory. Must be specified absolutely or relative to the
calling directory.</p>
</div></blockquote>
<p><strong>args</strong> : str, optional</p>
<blockquote>
<div><p>Additional arguments to be passed to <a class="reference external" href="http://pytest.org/latest/builtin.html#pytest.main">pytest.main</a> in the <code class="docutils literal"><span class="pre">args</span></code>
keyword argument.</p>
</div></blockquote>
<p><strong>plugins</strong> : list, optional</p>
<blockquote>
<div><p>Plugins to be passed to <a class="reference external" href="http://pytest.org/latest/builtin.html#pytest.main">pytest.main</a> in the <code class="docutils literal"><span class="pre">plugins</span></code> keyword
argument.</p>
</div></blockquote>
<p><strong>verbose</strong> : bool, optional</p>
<blockquote>
<div><p>Convenience option to turn on verbose output from <a class="reference external" href="http://pytest.org/latest/">py.test</a>. Passing
True is the same as specifying <code class="docutils literal"><span class="pre">'-v'</span></code> in <code class="docutils literal"><span class="pre">args</span></code>.</p>
</div></blockquote>
<p><strong>pastebin</strong> : {‘failed’,’all’,None}, optional</p>
<blockquote>
<div><p>Convenience option for turning on <a class="reference external" href="http://pytest.org/latest/">py.test</a> pastebin output. Set to
<code class="docutils literal"><span class="pre">'failed'</span></code> to upload info for failed tests, or <code class="docutils literal"><span class="pre">'all'</span></code> to upload
info for all tests.</p>
</div></blockquote>
<p><strong>remote_data</strong> : bool, optional</p>
<blockquote>
<div><p>Controls whether to run tests marked with &#64;remote_data. These
tests use online data and are not run by default. Set to True to
run these tests.</p>
</div></blockquote>
<p><strong>pep8</strong> : bool, optional</p>
<blockquote>
<div><p>Turn on PEP8 checking via the <a class="reference external" href="http://pypi.python.org/pypi/pytest-pep8">pytest-pep8 plugin</a> and disable normal
tests. Same as specifying <code class="docutils literal"><span class="pre">'--pep8</span> <span class="pre">-k</span> <span class="pre">pep8'</span></code> in <code class="docutils literal"><span class="pre">args</span></code>.</p>
</div></blockquote>
<p><strong>pdb</strong> : bool, optional</p>
<blockquote>
<div><p>Turn on PDB post-mortem analysis for failing tests. Same as
specifying <code class="docutils literal"><span class="pre">'--pdb'</span></code> in <code class="docutils literal"><span class="pre">args</span></code>.</p>
</div></blockquote>
<p><strong>coverage</strong> : bool, optional</p>
<blockquote>
<div><p>Generate a test coverage report.  The result will be placed in
the directory htmlcov.</p>
</div></blockquote>
<p><strong>open_files</strong> : bool, optional</p>
<blockquote>
<div><p>Fail when any tests leave files open.  Off by default, because
this adds extra run time to the test suite.  Works only on
platforms with a working <code class="docutils literal"><span class="pre">lsof</span></code> command.</p>
</div></blockquote>
<p><strong>parallel</strong> : int, optional</p>
<blockquote>
<div><p>When provided, run the tests in parallel on the specified
number of CPUs.  If parallel is negative, it will use the all
the cores on the machine.  Requires the
<a class="reference external" href="https://pypi.python.org/pypi/pytest-xdist">pytest-xdist</a> plugin
installed. Only available when using Astropy 0.3 or later.</p>
</div></blockquote>
<p><strong>kwargs</strong></p>
<blockquote class="last">
<div><p>Any additional keywords passed into this function will be passed
on to the astropy test runner.  This allows use of test-related
functionality implemented in later versions of astropy without
explicitly updating the package template.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="pyregion.Shape.html" class="btn btn-neutral float-right" title="Shape" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="pyregion.parse.html" class="btn btn-neutral" title="parse" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
      Last updated on April 05, 2018.

    </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:'2.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="file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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.