python-hypothesis-doc 3.44.1-2ubuntu1 / usr / share / doc / python-hypothesis / html / healthchecks.html

This file is indexed.

/usr/share/doc/python-hypothesis/html/healthchecks.html is in python-hypothesis-doc 3.44.1-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
<!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>Health checks &mdash; Hypothesis 3.44.1 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="Hypothesis 3.44.1 documentation" href="index.html"/>
        <link rel="next" title="The Hypothesis Example Database" href="database.html"/>
        <link rel="prev" title="Hypothesis for the Scientific Stack" href="numpy.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"> Hypothesis
          

          
          </a>

          
            
            
              <div class="version">
                3.44.1
              </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="quickstart.html">Quick start guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="details.html">Details and advanced features</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">What you can generate and how</a></li>
<li class="toctree-l1"><a class="reference internal" href="extras.html">Additional packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="django.html">Hypothesis for Django users</a></li>
<li class="toctree-l1"><a class="reference internal" href="numpy.html">Hypothesis for the Scientific Stack</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Health checks</a></li>
<li class="toctree-l1"><a class="reference internal" href="database.html">The Hypothesis Example Database</a></li>
<li class="toctree-l1"><a class="reference internal" href="stateful.html">Stateful testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="supported.html">Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Some more examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="community.html">Community</a></li>
<li class="toctree-l1"><a class="reference internal" href="manifesto.html">The Purpose of Hypothesis</a></li>
<li class="toctree-l1"><a class="reference internal" href="endorsements.html">Testimonials</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Open Source Projects using Hypothesis</a></li>
<li class="toctree-l1"><a class="reference internal" href="strategies.html">Projects extending Hypothesis</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Ongoing Hypothesis Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="support.html">Help and Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="packaging.html">Packaging Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="reproducing.html">Reproducing Failures</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">Hypothesis</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>Health checks</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/healthchecks.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="health-checks">
<h1>Health checks<a class="headerlink" href="#health-checks" title="Permalink to this headline"></a></h1>
<p>Hypothesis tries to detect common mistakes and things that will cause difficulty
at run time in the form of a number of ‘health checks’.</p>
<p>These include detecting and warning about:</p>
<ul class="simple">
<li>Strategies with very slow data generation</li>
<li>Strategies which filter out too much</li>
<li>Recursive strategies which branch too much</li>
<li>Tests that are unlikely to complete in a reasonable amount of time.</li>
</ul>
<p>If any of these scenarios are detected, Hypothesis will emit a warning about them.</p>
<p>The general goal of these health checks is to warn you about things that you are doing that might
appear to work but will either cause Hypothesis to not work correctly or to perform badly.</p>
<p>To selectively disable health checks, use the suppress_health_check setting.
The argument for this parameter is a list with elements drawn from any of
the class-level attributes of the HealthCheck class.</p>
<p>To disable all health checks, set the perform_health_check settings parameter
to False.</p>
<span class="target" id="module-hypothesis"></span><dl class="class">
<dt id="hypothesis.HealthCheck">
<em class="property">class </em><code class="descclassname">hypothesis.</code><code class="descname">HealthCheck</code><a class="reference internal" href="_modules/hypothesis/_settings.html#HealthCheck"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hypothesis.HealthCheck" title="Permalink to this definition"></a></dt>
<dd><p>Arguments for <a class="reference internal" href="settings.html#hypothesis.settings.suppress_health_check" title="hypothesis.settings.suppress_health_check"><code class="xref py py-attr docutils literal"><span class="pre">suppress_health_check</span></code></a>.</p>
<p>Each member of this enum is a type of health check to suppress.</p>
<dl class="attribute">
<dt id="hypothesis.HealthCheck.exception_in_generation">
<code class="descname">exception_in_generation</code><em class="property"> = 0</em><a class="headerlink" href="#hypothesis.HealthCheck.exception_in_generation" title="Permalink to this definition"></a></dt>
<dd><p>Deprecated and no longer does anything. It used to convert errors in
data generation into FailedHealthCheck error.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.data_too_large">
<code class="descname">data_too_large</code><em class="property"> = 1</em><a class="headerlink" href="#hypothesis.HealthCheck.data_too_large" title="Permalink to this definition"></a></dt>
<dd><p>Check for when the typical size of the examples you are generating
exceeds the maximum allowed size too often.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.filter_too_much">
<code class="descname">filter_too_much</code><em class="property"> = 2</em><a class="headerlink" href="#hypothesis.HealthCheck.filter_too_much" title="Permalink to this definition"></a></dt>
<dd><p>Check for when the test is filtering out too many examples, either
through use of <a class="reference internal" href="details.html#hypothesis.assume" title="hypothesis.assume"><code class="xref py py-func docutils literal"><span class="pre">assume()</span></code></a> or <a class="reference internal" href="data.html#filtering"><span class="std std-ref">filter()</span></a>,
or occasionally for Hypothesis internal reasons.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.too_slow">
<code class="descname">too_slow</code><em class="property"> = 3</em><a class="headerlink" href="#hypothesis.HealthCheck.too_slow" title="Permalink to this definition"></a></dt>
<dd><p>Check for when your data generation is extremely slow and likely to hurt
testing.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.random_module">
<code class="descname">random_module</code><em class="property"> = 4</em><a class="headerlink" href="#hypothesis.HealthCheck.random_module" title="Permalink to this definition"></a></dt>
<dd><p>Deprecated and no longer does anything. It used to check for whether
your tests used the global random module. Now &#64;given tests automatically
seed random so this is no longer an error.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.return_value">
<code class="descname">return_value</code><em class="property"> = 5</em><a class="headerlink" href="#hypothesis.HealthCheck.return_value" title="Permalink to this definition"></a></dt>
<dd><p>Checks if your tests return a non-None value (which will be ignored and
is unlikely to do what you want).</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.hung_test">
<code class="descname">hung_test</code><em class="property"> = 6</em><a class="headerlink" href="#hypothesis.HealthCheck.hung_test" title="Permalink to this definition"></a></dt>
<dd><p>Checks if your tests have been running for a very long time.</p>
</dd></dl>

<dl class="attribute">
<dt id="hypothesis.HealthCheck.large_base_example">
<code class="descname">large_base_example</code><em class="property"> = 7</em><a class="headerlink" href="#hypothesis.HealthCheck.large_base_example" title="Permalink to this definition"></a></dt>
<dd><p>Checks if the natural example to shrink towards is very large.</p>
</dd></dl>

</dd></dl>

</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="database.html" class="btn btn-neutral float-right" title="The Hypothesis Example Database" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="numpy.html" class="btn btn-neutral" title="Hypothesis for the Scientific Stack" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2013-2018, David R. MacIver.

    </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:'3.44.1',
            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.