python-pytestqt-doc 2.3.1-1 / usr / share / doc / python-pytestqt-doc / html / wait_until.html

This file is indexed.

/usr/share/doc/python-pytestqt-doc/html/wait_until.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
<!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>waitUntil: Waiting for arbitrary conditions &mdash; 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="Exceptions in virtual methods" href="virtual_methods.html"/>
        <link rel="prev" title="waitSignal: Waiting for threads, processes, etc." href="signals.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"><a class="reference internal" href="intro.html">Introduction</a></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 current"><a class="current reference internal" href="#">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> &raquo;</li>
        
      <li>waitUntil: Waiting for arbitrary conditions</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/wait_until.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="waituntil-waiting-for-arbitrary-conditions">
<h1>waitUntil: Waiting for arbitrary conditions<a class="headerlink" href="#waituntil-waiting-for-arbitrary-conditions" title="Permalink to this headline"></a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 2.0.</span></p>
</div>
<p>Sometimes your tests need to wait a certain condition which does not trigger a signal, for example
that a certain control gained focus or a <code class="docutils literal"><span class="pre">QListView</span></code> has been populated with all items.</p>
<p>For those situations you can use <code class="xref py py-meth docutils literal"><span class="pre">qtbot.waitUntil</span></code> to
wait until a certain condition has been met or a timeout is reached. This is specially important
in X window systems due to their asynchronous nature, where you can’t rely on the fact that the
result of an action will be immediately available.</p>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">test_validate</span><span class="p">(</span><span class="n">qtbot</span><span class="p">):</span>
    <span class="n">window</span> <span class="o">=</span> <span class="n">MyWindow</span><span class="p">()</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setText</span><span class="p">(</span><span class="s1">&#39;not a number&#39;</span><span class="p">)</span>
    <span class="c1"># after focusing, should update status label</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setFocus</span><span class="p">()</span>
    <span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">text</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;Please input a number&#39;</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">window.edit.setFocus()</span></code> may not be processed immediately, only in a future event loop, which
might lead to this test to work sometimes and fail in others (a <em>flaky</em> test).</p>
<p>A better approach in situations like this is to use <code class="docutils literal"><span class="pre">qtbot.waitUntil</span></code> with a callback with your
assertion:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">test_validate</span><span class="p">(</span><span class="n">qtbot</span><span class="p">):</span>
    <span class="n">window</span> <span class="o">=</span> <span class="n">MyWindow</span><span class="p">()</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setText</span><span class="p">(</span><span class="s1">&#39;not a number&#39;</span><span class="p">)</span>
    <span class="c1"># after focusing, should update status label</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setFocus</span><span class="p">()</span>
    <span class="k">def</span> <span class="nf">check_label</span><span class="p">():</span>
        <span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">text</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;Please input a number&#39;</span>
    <span class="n">qtbot</span><span class="o">.</span><span class="n">waitUntil</span><span class="p">(</span><span class="n">check_label</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">qtbot.waitUntil</span></code> will periodically call <code class="docutils literal"><span class="pre">check_label</span></code> until it no longer raises
<code class="docutils literal"><span class="pre">AssertionError</span></code> or a timeout is reached. If a timeout is reached, the last assertion error
re-raised and the test will fail:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span> <span class="n">_</span>
    <span class="k">def</span> <span class="nf">check_label</span><span class="p">():</span>
<span class="o">&gt;</span>       <span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">text</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;Please input a number&#39;</span>
<span class="n">E</span>       <span class="k">assert</span> <span class="s1">&#39;OK&#39;</span> <span class="o">==</span> <span class="s1">&#39;Please input a number&#39;</span>
<span class="n">E</span>         <span class="o">-</span> <span class="n">OK</span>
<span class="n">E</span>         <span class="o">+</span> <span class="n">Please</span> <span class="nb">input</span> <span class="n">a</span> <span class="n">number</span>
</pre></div>
</div>
<p>A second way to use <code class="docutils literal"><span class="pre">qtbot.waitUntil</span></code> is to pass a callback which returns <code class="docutils literal"><span class="pre">True</span></code> when the
condition is met or <code class="docutils literal"><span class="pre">False</span></code> otherwise. It is usually terser than using a separate callback with
<code class="docutils literal"><span class="pre">assert</span></code> statement, but it produces a generic message when it fails because it can’t make
use of <code class="docutils literal"><span class="pre">pytest</span></code>’s assertion rewriting:</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">test_validate</span><span class="p">(</span><span class="n">qtbot</span><span class="p">):</span>
    <span class="n">window</span> <span class="o">=</span> <span class="n">MyWindow</span><span class="p">()</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setText</span><span class="p">(</span><span class="s1">&#39;not a number&#39;</span><span class="p">)</span>
    <span class="c1"># after focusing, should update status label</span>
    <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">setFocus</span><span class="p">()</span>
    <span class="n">qtbot</span><span class="o">.</span><span class="n">waitUntil</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">window</span><span class="o">.</span><span class="n">edit</span><span class="o">.</span><span class="n">hasFocus</span><span class="p">())</span>
    <span class="k">assert</span> <span class="n">window</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">text</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;Please input a number&#39;</span>
</pre></div>
</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="virtual_methods.html" class="btn btn-neutral float-right" title="Exceptions in virtual methods" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="signals.html" class="btn btn-neutral" title="waitSignal: Waiting for threads, processes, etc." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; 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>

APT Browse - Built by Thomas Orozco.