<!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="py.test リファレンスドキュメント" href="apiref.html" />
<link rel="next" title="モンキーパッチ／モックのモジュールと環境" href="monkeypatch.html" />
<link rel="prev" title="拡張された xUnit スタイルのセットアップフィクスチャ" href="xunit_setup.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="monkeypatch.html" title="モンキーパッチ／モックのモジュールと環境"
accesskey="N">次へ</a> |</li>
<li class="right" >
<a href="xunit_setup.html" title="拡張された xUnit スタイルのセットアップフィクスチャ"
accesskey="P">前へ</a> |</li>
<li><a href="contents.html">pytest-2.2.4.0</a> »</li>
<li><a href="apiref.html" accesskey="U">py.test リファレンスドキュメント</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="#stdout-stderr-stdin">デフォルトの stdout/stderr/stdin のキャプチャ処理</a></li>
<li><a class="reference internal" href="#id2">メソッドをキャプチャする、または無効にする設定</a></li>
<li><a class="reference internal" href="#print">デバッグに print 文を使う</a></li>
<li><a class="reference internal" href="#id3">テスト関数からキャプチャされた出力へのアクセス</a></li>
</ul>
</li>
</ul>
<h4>前のトピックへ</h4>
<p class="topless"><a href="xunit_setup.html"
title="前の章へ">拡張された xUnit スタイルのセットアップフィクスチャ</a></p>
<h4>次のトピックへ</h4>
<p class="topless"><a href="monkeypatch.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="captures">
<span id="id1"></span><h1>標準出力/標準エラーのキャプチャ<a class="headerlink" href="#captures" title="このヘッドラインへのパーマリンク">¶</a></h1>
<div class="section" id="stdout-stderr-stdin">
<h2>デフォルトの stdout/stderr/stdin のキャプチャ処理<a class="headerlink" href="#stdout-stderr-stdin" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>テストの実行中 <tt class="docutils literal"><span class="pre">stdout</span></tt> と <tt class="docutils literal"><span class="pre">stderr</span></tt> へ送られる全ての出力内容はキャプチャされます。テストまたはセットアップメソッドが失敗した場合、そこでキャプチャされた出力は、通常、エラートレースバックと一緒に表示されます。</p>
<p>加えて <tt class="docutils literal"><span class="pre">stdin</span></tt> は、その読み込みに失敗する “null” オブジェクトがセットされます。その理由は自動テストを実行するときに対話式の入力を待つのを考慮することはほとんどないからです。</p>
<p>デフォルトのキャプチャは、低レベルのファイルディスクリプタへの書き込みを横取りします。単純な print 文からの出力も、あるテストが生成したサブプロセスからの出力も同じようにキャプチャできます。</p>
</div>
<div class="section" id="id2">
<h2>メソッドをキャプチャする、または無効にする設定<a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">py.test</span></tt> でキャプチャを実行する方法が2つあります:</p>
<ul class="simple">
<li>ファイルディスクリプタ (FD) レベルのキャプチャ (デフォルト): オペレーティングシステムのファイルディスクリプタ1と2への全ての書き込みをキャプチャする</li>
</ul>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">sys</span></tt> レベルのキャプチャ: Python ファイル <tt class="docutils literal"><span class="pre">sys.stdout</span></tt> と <tt class="docutils literal"><span class="pre">sys.stderr</span></tt> への書き込みのみキャプチャする、ファイルディスクリプタへの書き込みはキャプチャしない</li>
</ul>
<p id="disable-capturing">コマンドラインから出力内容のキャプチャ設定を制御できます:</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">s</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">capture</span><span class="o">=</span><span class="n">sys</span> <span class="c"># sys.stdout/stderr を in-mem ファイルに置き換える</span>
<span class="n">py</span><span class="o">.</span><span class="n">test</span> <span class="o">--</span><span class="n">capture</span><span class="o">=</span><span class="n">fd</span> <span class="c"># ファイルディスクリプタ1と2を一時ファイルに差し向ける</span>
</pre></div>
</div>
</div>
<div class="section" id="print">
<span id="printdebugging"></span><h2>デバッグに print 文を使う<a class="headerlink" href="#print" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>デフォルトで stdout/stderr の出力をキャプチャする主な利点の1つとして、デバッグに print 文が使えます:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># test_module.py の内容</span>
<span class="k">def</span> <span class="nf">setup_function</span><span class="p">(</span><span class="n">function</span><span class="p">):</span>
<span class="k">print</span> <span class="p">(</span><span class="s">"setting up </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">function</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">test_func1</span><span class="p">():</span>
<span class="k">assert</span> <span class="bp">True</span>
<span class="k">def</span> <span class="nf">test_func2</span><span class="p">():</span>
<span class="k">assert</span> <span class="bp">False</span>
</pre></div>
</div>
<p>このモジュールを実行すると、失敗するテスト関数の出力を適切に表示して、成功するもう1つのテストを非表示にします:</p>
<div class="highlight-python"><pre>$ py.test
=========================== test session starts ============================
platform linux2 -- Python 2.7.1 -- pytest-2.2.4
collecting ... collected 2 items
test_module.py .F
================================= FAILURES =================================
________________________________ test_func2 ________________________________
def test_func2():
> assert False
E assert False
test_module.py:9: AssertionError
----------------------------- Captured stdout ------------------------------
setting up <function test_func2 at 0x20160c8>
==================== 1 failed, 1 passed in 0.01 seconds ====================</pre>
</div>
</div>
<div class="section" id="id3">
<h2>テスト関数からキャプチャされた出力へのアクセス<a class="headerlink" href="#id3" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p><a class="reference internal" href="funcargs.html#funcarg-mechanism"><em>関数の引数を使った依存性の注入</em></a> により、テスト関数のシグネチャに <tt class="docutils literal"><span class="pre">capsys</span></tt> または <tt class="docutils literal"><span class="pre">capfd</span></tt> という名前を使うだけで、簡単にキャプチャされた出力へアクセスできます。次に関連する値の確認を行うテスト関数のサンプルを紹介します:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">test_myoutput</span><span class="p">(</span><span class="n">capsys</span><span class="p">):</span> <span class="c"># または fd レベルの "capfd" を使う</span>
<span class="k">print</span> <span class="p">(</span><span class="s">"hello"</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">"world</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
<span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">capsys</span><span class="o">.</span><span class="n">readouterr</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">out</span> <span class="o">==</span> <span class="s">"hello</span><span class="se">\n</span><span class="s">"</span>
<span class="k">assert</span> <span class="n">err</span> <span class="o">==</span> <span class="s">"world</span><span class="se">\n</span><span class="s">"</span>
<span class="k">print</span> <span class="s">"next"</span>
<span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">capsys</span><span class="o">.</span><span class="n">readouterr</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">out</span> <span class="o">==</span> <span class="s">"next</span><span class="se">\n</span><span class="s">"</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">readouterr()</span></tt> 呼び出しは、その時点での出力内容のスナップショットを返し、その後もキャプチャが続行されます。テスト関数が終了した後、元のストリームが復元されます。 <tt class="docutils literal"><span class="pre">capsys</span></tt> を使うことで、テスト内で出力ストリームをセット/リセットすることに注意を払わなくてよくなります。また、pytest が保持するテスト単位のキャプチャも扱えます。</p>
<p><tt class="docutils literal"><span class="pre">fd</span></tt> レベルのキャプチャを行う場合も全く同じインターフェースを提供する <tt class="docutils literal"><span class="pre">capfd</span></tt> という関数の引数を使います。</p>
</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="monkeypatch.html" title="モンキーパッチ／モックのモジュールと環境"
>次へ</a> |</li>
<li class="right" >
<a href="xunit_setup.html" title="拡張された xUnit スタイルのセットアップフィクスチャ"
>前へ</a> |</li>
<li><a href="contents.html">pytest-2.2.4.0</a> »</li>
<li><a href="apiref.html" >py.test リファレンスドキュメント</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>
