/usr/share/doc/python-hypothesis/html/extras.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 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 | <!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>Additional packages — 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="Hypothesis for Django users" href="django.html"/>
<link rel="prev" title="What you can generate and how" href="data.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 current"><a class="current reference internal" href="#">Additional packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-hypothesis.extra.pytz">hypothesis[pytz]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-hypothesis.extra.datetime">hypothesis[datetime]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#hypothesis-fakefactory">hypothesis[fakefactory]</a></li>
</ul>
</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"><a class="reference internal" href="healthchecks.html">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> »</li>
<li>Additional packages</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/extras.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="additional-packages">
<h1>Additional packages<a class="headerlink" href="#additional-packages" title="Permalink to this headline">¶</a></h1>
<p>Hypothesis itself does not have any dependencies, but there are some packages that
need additional things installed in order to work.</p>
<p>You can install these dependencies using the setuptools extra feature as e.g.
<code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">hypothesis[django]</span></code>. This will check installation of compatible versions.</p>
<p>You can also just install hypothesis into a project using them, ignore the version
constraints, and hope for the best.</p>
<p>In general “Which version is Hypothesis compatible with?” is a hard question to answer
and even harder to regularly test. Hypothesis is always tested against the latest
compatible version and each package will note the expected compatibility range. If
you run into a bug with any of these please specify the dependency version.</p>
<p>There are seperate pages for <a class="reference internal" href="django.html"><span class="doc">Hypothesis for Django users</span></a> and <a class="reference internal" href="numpy.html"><span class="doc">Hypothesis for the Scientific Stack</span></a>.</p>
<div class="section" id="module-hypothesis.extra.pytz">
<span id="hypothesis-pytz"></span><h2>hypothesis[pytz]<a class="headerlink" href="#module-hypothesis.extra.pytz" title="Permalink to this headline">¶</a></h2>
<p>This module provides <code class="docutils literal"><span class="pre">pytz</span></code> timezones.</p>
<p>You can use this strategy to make
<a class="reference internal" href="data.html#hypothesis.strategies.datetimes" title="hypothesis.strategies.datetimes"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.datetimes()</span></code></a> and
<a class="reference internal" href="data.html#hypothesis.strategies.times" title="hypothesis.strategies.times"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.times()</span></code></a> produce timezone-aware values.</p>
<dl class="function">
<dt id="hypothesis.extra.pytz.timezones">
<code class="descclassname">hypothesis.extra.pytz.</code><code class="descname">timezones</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/hypothesis/extra/pytz.html#timezones"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hypothesis.extra.pytz.timezones" title="Permalink to this definition">¶</a></dt>
<dd><p>Any timezone in the Olsen database, as a pytz tzinfo object.</p>
<p>This strategy minimises to UTC, or the smallest possible fixed
offset, and is designed for use with
<a class="reference internal" href="data.html#hypothesis.strategies.datetimes" title="hypothesis.strategies.datetimes"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.datetimes()</span></code></a>.</p>
</dd></dl>
</div>
<div class="section" id="module-hypothesis.extra.datetime">
<span id="hypothesis-datetime"></span><h2>hypothesis[datetime]<a class="headerlink" href="#module-hypothesis.extra.datetime" title="Permalink to this headline">¶</a></h2>
<p>This module provides deprecated time and date related strategies.</p>
<p>It depends on the <code class="docutils literal"><span class="pre">pytz</span></code> package, which is stable enough that almost any
version should be compatible - most updates are for the timezone database.</p>
<dl class="function">
<dt id="hypothesis.extra.datetime.datetimes">
<code class="descclassname">hypothesis.extra.datetime.</code><code class="descname">datetimes</code><span class="sig-paren">(</span><em>allow_naive=None</em>, <em>timezones=None</em>, <em>min_year=None</em>, <em>max_year=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hypothesis/extra/datetime.html#datetimes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hypothesis.extra.datetime.datetimes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a strategy for generating datetimes.</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.9.0: </span>use <a class="reference internal" href="data.html#hypothesis.strategies.datetimes" title="hypothesis.strategies.datetimes"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.datetimes()</span></code></a> instead.</p>
</div>
<p>allow_naive=True will cause the values to sometimes be naive.
timezones is the set of permissible timezones. If set to an empty
collection all datetimes will be naive. If set to None all timezones
available via pytz will be used.</p>
<p>All generated datetimes will be between min_year and max_year, inclusive.</p>
</dd></dl>
<dl class="function">
<dt id="hypothesis.extra.datetime.dates">
<code class="descclassname">hypothesis.extra.datetime.</code><code class="descname">dates</code><span class="sig-paren">(</span><em>min_year=None</em>, <em>max_year=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hypothesis/extra/datetime.html#dates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hypothesis.extra.datetime.dates" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a strategy for generating dates.</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.9.0: </span>use <a class="reference internal" href="data.html#hypothesis.strategies.dates" title="hypothesis.strategies.dates"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.dates()</span></code></a> instead.</p>
</div>
<p>All generated dates will be between min_year and max_year, inclusive.</p>
</dd></dl>
<dl class="function">
<dt id="hypothesis.extra.datetime.times">
<code class="descclassname">hypothesis.extra.datetime.</code><code class="descname">times</code><span class="sig-paren">(</span><em>allow_naive=None</em>, <em>timezones=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hypothesis/extra/datetime.html#times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hypothesis.extra.datetime.times" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a strategy for generating times.</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.9.0: </span>use <a class="reference internal" href="data.html#hypothesis.strategies.times" title="hypothesis.strategies.times"><code class="xref py py-func docutils literal"><span class="pre">hypothesis.strategies.times()</span></code></a> instead.</p>
</div>
<p>The allow_naive and timezones arguments act the same as the datetimes
strategy above.</p>
</dd></dl>
</div>
<div class="section" id="hypothesis-fakefactory">
<span id="faker-extra"></span><h2>hypothesis[fakefactory]<a class="headerlink" href="#hypothesis-fakefactory" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>This extra package is deprecated. We strongly recommend using native
Hypothesis strategies, which are more effective at both finding and
shrinking failing examples for your tests.</p>
<p class="last">The <a class="reference internal" href="data.html#hypothesis.strategies.from_regex" title="hypothesis.strategies.from_regex"><code class="xref py py-func docutils literal"><span class="pre">from_regex()</span></code></a>,
<a class="reference internal" href="data.html#hypothesis.strategies.text" title="hypothesis.strategies.text"><code class="xref py py-func docutils literal"><span class="pre">text()</span></code></a> (with some specific alphabet), and
<a class="reference internal" href="data.html#hypothesis.strategies.sampled_from" title="hypothesis.strategies.sampled_from"><code class="xref py py-func docutils literal"><span class="pre">sampled_from()</span></code></a> strategies may be particularly
useful.</p>
</div>
<p><a class="reference external" href="https://pypi.python.org/pypi/Faker">Faker</a> (previously <a class="reference external" href="https://pypi.python.org/pypi/fake-factory">fake-factory</a>) is a Python package that
generates fake data for you. It’s great for bootstraping your database,
creating good-looking XML documents, stress-testing a database, or anonymizing
production data. However, it’s not designed for automated testing - data from
Hypothesis looks less realistic, but produces minimal bug-triggering examples
and uses coverage information to check more cases.</p>
<p><code class="docutils literal"><span class="pre">hypothesis.extra.fakefactory</span></code> lets you use Faker generators to parametrize
Hypothesis tests. This was only ever meant to ease your transition to
Hypothesis, but we’ve improved Hypothesis enough since then that we no longer
recommend using Faker for automated tests under any circumstances.</p>
<p>hypothesis.extra.fakefactory defines a function fake_factory which returns a
strategy for producing text data from any Faker provider.</p>
<p>So for example the following will parametrize a test by an email address:</p>
<div class="highlight-pycon"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'email'</span><span class="p">)</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'tnader@prosacco.info'</span>
<span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'name'</span><span class="p">)</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'Zbyněk Černý CSc.'</span>
</pre></div>
</div>
<p>You can explicitly specify the locale (otherwise it uses any of the available
locales), either as a single locale or as several:</p>
<div class="highlight-pycon"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="s1">'en_GB'</span><span class="p">)</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'Antione Gerlach'</span>
<span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="n">locales</span><span class="o">=</span><span class="p">[</span><span class="s1">'en_GB'</span><span class="p">,</span> <span class="s1">'cs_CZ'</span><span class="p">])</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'Miloš Šťastný'</span>
<span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="n">locales</span><span class="o">=</span><span class="p">[</span><span class="s1">'en_GB'</span><span class="p">,</span> <span class="s1">'cs_CZ'</span><span class="p">])</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'Harm Sanford'</span>
</pre></div>
</div>
<p>You can use custom Faker providers via the <code class="docutils literal"><span class="pre">providers</span></code> argument:</p>
<div class="highlight-pycon"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">faker.providers</span> <span class="kn">import</span> <span class="n">BaseProvider</span>
<span class="gp">>>> </span><span class="k">class</span> <span class="nc">KittenProvider</span><span class="p">(</span><span class="n">BaseProvider</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">meows</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="s1">'meow </span><span class="si">%d</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">random_number</span><span class="p">(</span><span class="n">digits</span><span class="o">=</span><span class="mi">10</span><span class="p">),)</span>
<span class="gp">>>> </span><span class="n">fake_factory</span><span class="p">(</span><span class="s1">'meows'</span><span class="p">,</span> <span class="n">providers</span><span class="o">=</span><span class="p">[</span><span class="n">KittenProvider</span><span class="p">])</span><span class="o">.</span><span class="n">example</span><span class="p">()</span>
<span class="go">'meow 9139348419'</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="django.html" class="btn btn-neutral float-right" title="Hypothesis for Django users" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="data.html" class="btn btn-neutral" title="What you can generate and how" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© 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>
|