/usr/share/doc/python-pytestqt-doc/html/intro.html is in python-pytestqt-doc 2.3.1-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 | <!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>Introduction — pytest-qt 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="pytest-qt documentation" href="index.html"/>
<link rel="next" title="Tutorial" href="tutorial.html"/>
<link rel="prev" title="pytest-qt" href="index.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"> pytest-qt
</a>
<div class="version">
2.3.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 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#development">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="#versioning">Versioning</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging.html">Qt Logging Capture</a></li>
<li class="toctree-l1"><a class="reference internal" href="signals.html">waitSignal: Waiting for threads, processes, etc.</a></li>
<li class="toctree-l1"><a class="reference internal" href="wait_until.html">waitUntil: Waiting for arbitrary conditions</a></li>
<li class="toctree-l1"><a class="reference internal" href="virtual_methods.html">Exceptions in virtual methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="modeltester.html">Model Tester</a></li>
<li class="toctree-l1"><a class="reference internal" href="app_exit.html">A note about QApplication.exit()</a></li>
<li class="toctree-l1"><a class="reference internal" href="note_pyqt4v2.html">A note about <code class="docutils literal"><span class="pre">pyqt4v2</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></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">pytest-qt</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>Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/intro.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="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p><cite>pytest-qt</cite> is a <a class="reference external" href="http://www.pytest.org">pytest</a> plugin that provides fixtures to help programmers write tests for
<a class="reference external" href="https://pypi.python.org/pypi/PySide">PySide</a> and <a class="reference external" href="http://www.riverbankcomputing.com/software/pyqt">PyQt</a>.</p>
<p>The main usage is to use the <code class="docutils literal"><span class="pre">qtbot</span></code> fixture, which provides methods to simulate user
interaction, like key presses and mouse clicks:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">test_hello</span><span class="p">(</span><span class="n">qtbot</span><span class="p">):</span>
<span class="n">widget</span> <span class="o">=</span> <span class="n">HelloWidget</span><span class="p">()</span>
<span class="n">qtbot</span><span class="o">.</span><span class="n">addWidget</span><span class="p">(</span><span class="n">widget</span><span class="p">)</span>
<span class="c1"># click in the Greet button and make sure it updates the appropriate label</span>
<span class="n">qtbot</span><span class="o">.</span><span class="n">mouseClick</span><span class="p">(</span><span class="n">window</span><span class="o">.</span><span class="n">button_greet</span><span class="p">,</span> <span class="n">QtCore</span><span class="o">.</span><span class="n">Qt</span><span class="o">.</span><span class="n">LeftButton</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">greet_label</span><span class="o">.</span><span class="n">text</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'Hello!'</span>
</pre></div>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>Python 2.7 or later, including Python 3.4+.</p>
<p>Requires pytest version 2.7 or later.</p>
<p>Works with either <code class="docutils literal"><span class="pre">PyQt5</span></code>, <code class="docutils literal"><span class="pre">PyQt4</span></code>, <code class="docutils literal"><span class="pre">PySide</span></code> or <code class="docutils literal"><span class="pre">PySide2</span></code>, picking whichever
is available on the system giving preference to the first one installed in
this order:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">PySide2</span></code></li>
<li><code class="docutils literal"><span class="pre">PyQt5</span></code></li>
<li><code class="docutils literal"><span class="pre">PySide</span></code></li>
<li><code class="docutils literal"><span class="pre">PyQt4</span></code></li>
</ul>
<p>To force a particular API, set the configuration variable <code class="docutils literal"><span class="pre">qt_api</span></code> in your <code class="docutils literal"><span class="pre">pytest.ini</span></code> file to
<code class="docutils literal"><span class="pre">pyqt5</span></code>, <code class="docutils literal"><span class="pre">pyside</span></code>, <code class="docutils literal"><span class="pre">pyside2</span></code>, <code class="docutils literal"><span class="pre">pyqt4</span></code> or <code class="docutils literal"><span class="pre">pyqt4v2</span></code>. <code class="docutils literal"><span class="pre">pyqt4v2</span></code> sets the <code class="docutils literal"><span class="pre">PyQt4</span></code>
API to <a class="reference external" href="http://pyqt.sourceforge.net/Docs/PyQt4/incompatible_apis.html">version 2</a>.</p>
<div class="highlight-ini"><div class="highlight"><pre><span></span><span class="k">[pytest]</span>
<span class="na">qt_api</span><span class="o">=</span><span class="s">pyqt5</span>
</pre></div>
</div>
<p>Alternatively, you can set the <code class="docutils literal"><span class="pre">PYTEST_QT_API</span></code> environment variable to the
same values described above (the environment variable wins over the
configuration if both are set).</p>
<p>From <code class="docutils literal"><span class="pre">pytest-qt</span></code> version 2 the behaviour of <code class="docutils literal"><span class="pre">pyqt4v2</span></code> has changed, as
explained in <a class="reference internal" href="note_pyqt4v2.html"><span class="doc">A note about pyqt4v2</span></a>.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>The package may be installed by running:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pytest</span><span class="o">-</span><span class="n">qt</span>
</pre></div>
</div>
<p>Or alternatively, download the package from <a class="reference external" href="http://pypi.python.org/pypi/pytest-qt/">pypi</a>, extract and execute:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
<p>Both methods will automatically register it for usage in <code class="docutils literal"><span class="pre">pytest</span></code>.</p>
</div>
<div class="section" id="development">
<h2>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h2>
<p>If you intend to develop <code class="docutils literal"><span class="pre">pytest-qt</span></code> itself, use <a class="reference external" href="https://virtualenv.readthedocs.io/">virtualenv</a> to
activate a new fresh environment and execute:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">pytest</span><span class="o">-</span><span class="n">dev</span><span class="o">/</span><span class="n">pytest</span><span class="o">-</span><span class="n">qt</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">pytest</span><span class="o">-</span><span class="n">qt</span>
<span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span> <span class="c1"># or python setup.py develop</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">pyside</span> <span class="c1"># or pyqt4/pyqt5</span>
</pre></div>
</div>
<p>If you also intend to build the documentation locally, you can make sure to have
all the needed dependences executing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span><span class="p">[</span><span class="n">doc</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="versioning">
<h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline">¶</a></h2>
<p>This projects follows <a class="reference external" href="http://semver.org/">semantic versioning</a>.</p>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="tutorial.html" class="btn btn-neutral float-right" title="Tutorial" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="pytest-qt" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Bruno Oliveira.
</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:'',
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>
|