<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>使用方法とテスト実行</title> <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '2.2.4.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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/translations.js"></script> <link rel="top" title="None" href="index.html" /> <link rel="up" title="基本から始めよう" href="overview.html" /> <link rel="next" title="優れたインテグレーションプラクティス" href="goodpractises.html" /> <link rel="prev" title="インストールして始めよう" href="getting-started.html" /> </head> <body> <div class="related"> <h3>ナビゲーション</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="py-modindex.html" title="Pythonモジュール索引" >モジュール</a></li> <li class="right" > <a href="goodpractises.html" title="優れたインテグレーションプラクティス" accesskey="N">次へ</a> |</li> <li class="right" > <a href="getting-started.html" title="インストールして始めよう" accesskey="P">前へ</a> |</li> <li><a href="contents.html">pytest-2.2.4.0</a> »</li> <li><a href="overview.html" accesskey="U">基本から始めよう</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="contents.html">目次</a></h3> <ul> <li><a class="reference internal" href="#">使用方法とテスト実行</a><ul> <li><a class="reference internal" href="#python-m-pytest-pytest"><tt class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span></tt> による pytest 呼び出し</a></li> <li><a class="reference internal" href="#id2">バージョン、オプション名、環境変数のヘルプを表示</a></li> <li><a class="reference internal" href="#n">最初 (または N 回) 失敗したときにテストを中止</a></li> <li><a class="reference internal" href="#id3">テストの指定と選択</a></li> <li><a class="reference internal" href="#python">Python のトレースバック表示を変更</a></li> <li><a class="reference internal" href="#pdb-python">失敗したときに PDB (Python デバッガー) を起動</a></li> <li><a class="reference internal" href="#set-trace"><tt class="docutils literal"><span class="pre">set_trace()</span></tt> というブレークポイントの設定</a></li> <li><a class="reference internal" href="#durations">テストの実行時間をプロファイリング</a></li> <li><a class="reference internal" href="#junitxml">JUnitXML 形式のファイル作成</a></li> <li><a class="reference internal" href="#resultlog">resultlog 形式のファイル作成</a></li> <li><a class="reference internal" href="#pocoo-pastbin">pocoo pastbin サービスにテスト結果を投稿</a></li> <li><a class="reference internal" href="#python-pytest">Python コードからの pytest 呼び出し</a></li> </ul> </li> </ul> <h4>前のトピックへ</h4> <p class="topless"><a href="getting-started.html" title="前の章へ">インストールして始めよう</a></p> <h4>次のトピックへ</h4> <p class="topless"><a href="goodpractises.html" title="次の章へ">優れたインテグレーションプラクティス</a></p> <div id="searchbox" style="display: none"> <h3>クイック検索</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="検索" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> モジュール、クラス、または関数名を入力してください </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="usage"> <span id="id1"></span><h1>使用方法とテスト実行<a class="headerlink" href="#usage" title="このヘッドラインへのパーマリンク">¶</a></h1> <div class="section" id="python-m-pytest-pytest"> <span id="cmdline"></span><h2><tt class="docutils literal"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span></tt> による pytest 呼び出し<a class="headerlink" href="#python-m-pytest-pytest" title="このヘッドラインへのパーマリンク">¶</a></h2> <p class="versionadded"> <span class="versionmodified">バージョン 2.0 で追加.</span></p> <p>Python 2.5 か、それ以上のバージョンを使っているなら、コマンドラインから Python インタープリターでテストを実行できます:</p> <div class="highlight-python"><pre>python -m pytest [...]</pre> </div> <p>これは直接的にコマンドラインスクリプト <tt class="docutils literal"><span class="pre">py.test</span> <span class="pre">[...]</span></tt> を実行するのと同じです。</p> </div> <div class="section" id="id2"> <h2>バージョン、オプション名、環境変数のヘルプを表示<a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">version</span> <span class="c"># pytest がインポートされた場所を表示</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">fixtures</span> <span class="c"># 利用できる組み込みの関数引数を表示</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">-</span><span class="n">h</span> <span class="o">|</span> <span class="o">--</span><span class="n">help</span> <span class="c"># コマンドラインと設定ファイルオプションのヘルプを表示</span> </pre></div> </div> </div> <div class="section" id="n"> <h2>最初 (または N 回) 失敗したときにテストを中止<a class="headerlink" href="#n" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>最初 (N 回) 失敗したときにテストプロセスを中止するには、次のようにします:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">-</span><span class="n">x</span> <span class="c"># 最初に失敗したときに中止</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">maxfail</span><span class="o">=</span><span class="mi">2</span> <span class="c"># 2 回失敗したときに中止</span> </pre></div> </div> </div> <div class="section" id="id3"> <h2>テストの指定と選択<a class="headerlink" href="#id3" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>次のようなテスト実行のオプションがあります:</p> <div class="highlight-python"><pre>py.test test_mod.py # モジュール内のテストを実行 py.test somepath # 指定したパスの全てのテストを実行 py.test -k string # string を含む名前をもつテストのみを実行</pre> </div> <p>‘pkg’ をインポートして、そのファイルシステム上の位置からテストを探して実行します:</p> <div class="highlight-python"><pre>py.test --pyargs pkg # pkg のディレクトリ配下にある全てのテストを実行</pre> </div> </div> <div class="section" id="python"> <h2>Python のトレースバック表示を変更<a class="headerlink" href="#python" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>トレースバック表示を変更する例です:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">showlocals</span> <span class="c"># トレースバックのローカル変数を表示</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">-</span><span class="n">l</span> <span class="c"># トレースバックのローカル変数を表示 (短いオプション)</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">tb</span><span class="o">=</span><span class="nb">long</span> <span class="c"># デフォルトの詳細なトレースバック形式</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">tb</span><span class="o">=</span><span class="n">native</span> <span class="c"># Python 標準ライブラリの形式</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">tb</span><span class="o">=</span><span class="n">short</span> <span class="c"># 短いトレースバック形式</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">tb</span><span class="o">=</span><span class="n">line</span> <span class="c"># 失敗したテストを1行表示</span> </pre></div> </div> </div> <div class="section" id="pdb-python"> <h2>失敗したときに PDB (Python デバッガー) を起動<a class="headerlink" href="#pdb-python" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>Python には <a class="reference external" href="http://docs.python.org/library/pdb.html">PDB</a> という組み込みの Python デバッガーが付属しています。 <tt class="docutils literal"><span class="pre">py.test</span></tt> は、コマンドラインオプションで PDB プロンプトを起動できます:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">pdb</span> </pre></div> </div> <p>このオプションは、テストが失敗したときに Python デバッガーを起動します。多くの場合、特定のエラー状況を把握するのに最初に失敗したときのみデバッガーを起動したいはずです:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">-</span><span class="n">x</span> <span class="o">--</span><span class="n">pdb</span> <span class="c"># 最初にテストが失敗したときに PDB を起動してテストセッションを終了</span> <span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">pdb</span> <span class="o">--</span><span class="n">maxfail</span><span class="o">=</span><span class="mi">3</span> <span class="c"># 最初の 3 回の失敗に対して PDB を起動</span> </pre></div> </div> </div> <div class="section" id="set-trace"> <h2><tt class="docutils literal"><span class="pre">set_trace()</span></tt> というブレークポイントの設定<a class="headerlink" href="#set-trace" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>ブレークポイントを設定して <tt class="docutils literal"><span class="pre">pdb.set_trace()</span></tt> を行いたいなら、ヘルパー関数を使えます:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">pytest</span> <span class="k">def</span> <span class="nf">test_function</span><span class="p">():</span> <span class="o">...</span> <span class="n">pytest</span><span class="o">.</span><span class="n">set_trace</span><span class="p">()</span> <span class="c"># PDB デバッガーを起動してトレースする</span> </pre></div> </div> <p>以前のバージョンでは、コマンドラインから <tt class="docutils literal"><span class="pre">py.test</span> <span class="pre">-s</span></tt> で標準出力の取得を無効にした場合のみ、PDB トレースが可能でした。</p> </div> <div class="section" id="durations"> <span id="id4"></span><h2>テストの実行時間をプロファイリング<a class="headerlink" href="#durations" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>最も遅い 10 個のテスト一覧を取得するには、次のようにします:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">durations</span><span class="o">=</span><span class="mi">10</span> </pre></div> </div> </div> <div class="section" id="junitxml"> <h2>JUnitXML 形式のファイル作成<a class="headerlink" href="#junitxml" title="このヘッドラインへのパーマリンク">¶</a></h2> <p><a class="reference external" href="http://hudson-ci.org/">Hudson</a> やその他の継続的インテグレーションサーバーで読み込める結果ファイルを作成するには、次のように実行します:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">junitxml</span><span class="o">=</span><span class="n">path</span> </pre></div> </div> <p><tt class="docutils literal"><span class="pre">path</span></tt> に XML ファイルが作成されます。</p> </div> <div class="section" id="resultlog"> <h2>resultlog 形式のファイル作成<a class="headerlink" href="#resultlog" title="このヘッドラインへのパーマリンク">¶</a></h2> <p>コンピューターが読める平文の結果ファイルを作成するには、次のようにします:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">resultlog</span><span class="o">=</span><span class="n">path</span> </pre></div> </div> <p><tt class="docutils literal"><span class="pre">path</span></tt> に作成されたファイルがあります。そういったファイルは、例えば <a class="reference external" href="http://codespeak.net:8099/summary">PyPy-test</a> で複数バージョンでのテスト結果を表示するのに使われます。</p> </div> <div class="section" id="pocoo-pastbin"> <h2>pocoo pastbin サービスにテスト結果を投稿<a class="headerlink" href="#pocoo-pastbin" title="このヘッドラインへのパーマリンク">¶</a></h2> <p><strong>テストが失敗する毎に URL を作成します</strong>:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">pastebin</span><span class="o">=</span><span class="n">failed</span> </pre></div> </div> <p>これはリモートの Paste サービスへテストの実行情報を投稿して、失敗したテスト毎に URL を提供します。特定のエラーのみを投稿したい場合、普通にテストを選択するか、例えば <tt class="docutils literal"><span class="pre">-x</span></tt> を追加します。</p> <p><strong>全てのテストセッションログに対して1つの URL を作成します</strong>:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">pastebin</span><span class="o">=</span><span class="nb">all</span> </pre></div> </div> <p>いまのところは、<a class="reference external" href="http://paste.pocoo.org">http://paste.pocoo.org</a> サービスへのペーストのみが実装されています。</p> </div> <div class="section" id="python-pytest"> <h2>Python コードからの pytest 呼び出し<a class="headerlink" href="#python-pytest" title="このヘッドラインへのパーマリンク">¶</a></h2> <p class="versionadded"> <span class="versionmodified">バージョン 2.0 で追加.</span></p> <p>Python コードから直接 <tt class="docutils literal"><span class="pre">py.test</span></tt> を呼び出せます:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">pytest</span><span class="o">.</span><span class="n">main</span><span class="p">()</span> </pre></div> </div> <p>これはコマンドラインから “py.test” を呼び出すように動作します。 <tt class="docutils literal"><span class="pre">SystemExit</span></tt> を発生させない代わりに終了コードを返します。次のようにオプションと引数を渡します:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">pytest</span><span class="o">.</span><span class="n">main</span><span class="p">([</span><span class="s">'-x'</span><span class="p">,</span> <span class="s">'mytestdir'</span><span class="p">])</span> </pre></div> </div> <p>または、文字列で渡します:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">pytest</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="s">"-x mytestdir"</span><span class="p">)</span> </pre></div> </div> <p><tt class="docutils literal"><span class="pre">pytest.main</span></tt> に追加のプラグインを指定できます:</p> <div class="highlight-python"><div class="highlight"><pre><span class="c"># myinvoke.py の内容</span> <span class="kn">import</span> <span class="nn">pytest</span> <span class="k">class</span> <span class="nc">MyPlugin</span><span class="p">:</span> <span class="k">def</span> <span class="nf">pytest_sessionfinish</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">print</span><span class="p">(</span><span class="s">"*** test run reporting finishing"</span><span class="p">)</span> <span class="n">pytest</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="s">"-qq"</span><span class="p">,</span> <span class="n">plugins</span><span class="o">=</span><span class="p">[</span><span class="n">MyPlugin</span><span class="p">()])</span> </pre></div> </div> <p>このコードを実行すると <tt class="docutils literal"><span class="pre">MyPlugin</span></tt> が追加され、そのフックが実行されたことを表示します:</p> <div class="highlight-python"><pre>$ python myinvoke.py collecting ... collected 0 items in 0.00 seconds *** test run reporting finishing</pre> </div> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>ナビゲーション</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="py-modindex.html" title="Pythonモジュール索引" >モジュール</a></li> <li class="right" > <a href="goodpractises.html" title="優れたインテグレーションプラクティス" >次へ</a> |</li> <li class="right" > <a href="getting-started.html" title="インストールして始めよう" >前へ</a> |</li> <li><a href="contents.html">pytest-2.2.4.0</a> »</li> <li><a href="overview.html" >基本から始めよう</a> »</li> </ul> </div> <div class="footer"> © Copyright 2011, holger krekel et alii. このドキュメントは <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3 で生成しました。 </div> </body> </html>