<!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>フックを利用する — Bazaar 2.6.0 ドキュメント</title>
<link rel="stylesheet" href="../_static/default.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.6.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="shortcut icon" href="../_static/bzr.ico"/>
<link rel="top" title="Bazaar 2.6.0 ドキュメント" href="../index.html" />
<link rel="up" title="Bazaarユーザーガイド" href="index.html" />
<link rel="next" title="バージョンの情報をエクスポートする" href="version_info.html" />
<link rel="prev" title="スマートサーバーを稼働させる" href="server.html" />
</head>
<body>
<div class="related">
<h3>ナビゲーション</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="version_info.html" title="バージョンの情報をエクスポートする"
accesskey="N">次へ</a></li>
<li class="right" >
<a href="server.html" title="スマートサーバーを稼働させる"
accesskey="P">前へ</a> |</li>
<li><a href="../index.html">目次 (2.6.0)</a> »</li>
<li><a href="index.html" accesskey="U">Bazaarユーザーガイド</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="id1">
<h1>フックを利用する<a class="headerlink" href="#id1" title="このヘッドラインへのパーマリンク">¶</a></h1>
<div class="section" id="id2">
<h2>フックとは？<a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>Bazaarのふるまいをカスタマイズする1つの方法は <em>フック(hook)</em> です。
フックによって特定のBazaarの特定のオペレーションの前後でアクションを実行できます。
オペレーションは <tt class="docutils literal"><span class="pre">commit</span></tt>, <tt class="docutils literal"><span class="pre">push</span></tt>, <tt class="docutils literal"><span class="pre">pull</span></tt> と <tt class="docutils literal"><span class="pre">uncommit</span></tt> を含みます。
フックとパラメータの完全なリストに関しては、ユーザーリファレンスの
<a class="reference external" href="../user-reference/index.html#hooks">フック</a> を参照してください。</p>
<p>大抵のフックはクライアントで実行されますが、サーバーで実行されるものもわずかに
あります。
(サーバーサイドのオペレーションの特殊なケースを扱うものは
<a class="reference external" href="http://doc.bazaar.canonical.com/plugins/en/push-and-update-plugin.html">push-and-update plugin</a> も参照。)</p>
</div>
<div class="section" id="id4">
<h2>フックを使用する<a class="headerlink" href="#id4" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>フックを使用するには、 <a class="reference external" href="http://doc.bazaar.canonical.com/plugins/en/plugin-development.html">プラグインを書きます</a> 。
新しいコマンドを作成する代わりに、このプラグインはフックを定義してインストールします。例です:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">bzrlib</span> <span class="kn">import</span> <span class="n">branch</span>
<span class="k">def</span> <span class="nf">post_push_hook</span><span class="p">(</span><span class="n">push_result</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"The new revno is </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="n">push_result</span><span class="o">.</span><span class="n">new_revno</span>
<span class="n">branch</span><span class="o">.</span><span class="n">Branch</span><span class="o">.</span><span class="n">hooks</span><span class="o">.</span><span class="n">install_named_hook</span><span class="p">(</span><span class="s">'post_push'</span><span class="p">,</span> <span class="n">post_push_hook</span><span class="p">,</span>
<span class="s">'My post_push hook'</span><span class="p">)</span>
</pre></div>
</div>
<p>この例を使用するには、 <tt class="docutils literal"><span class="pre">push_hook.py</span></tt> という名前のファイルを作り
<tt class="docutils literal"><span class="pre">plugins</span></tt> サブディレクトリに設置します。
(プラグインをインストールしていなければ、 <tt class="docutils literal"><span class="pre">plugins</span></tt> ディレクトリを作る必要があります)。</p>
<p>以上です！次回にpushすると、”The new revno is...”が表示されます。
もちろん、Pythonのフルパワーを思いとおりにできるので、フックはこれよりもはるかに手が込んでいます。
これでフックの使い方を理解したので、それらで何をするかはあなたしだいです。</p>
<p>プラグインのコードは2つのことを行います。
最初に、これは <tt class="docutils literal"><span class="pre">push</span></tt> が完了した後に実行する関数を定義します。
(代わりにインスタンスメソッドもしくは呼び出し可能なオブジェクトを使用することもできます。)
すべてのpushフックは単独の引数 <tt class="docutils literal"><span class="pre">push_result</span></tt> をとります。</p>
<p>2番目に、プラグインはフックをインストールします。
最初の引数 <tt class="docutils literal"><span class="pre">'post_push'</span></tt> はフックがインストールされている場所を特定します。
2番目の引数はフック自身です。3番目の引数は <tt class="docutils literal"><span class="pre">'My</span> <span class="pre">post_push</span> <span class="pre">hook'</span></tt> という名前で、
これは進行メッセージとエラーメッセージで使用されます。</p>
<p>To reduce the start-up time of Bazaar it is also possible to “lazily” install hooks,
using the <tt class="docutils literal"><span class="pre">bzrlib.hooks.install_lazy_named_hook</span></tt> function. This removes the need
to load the module that contains the hook point just to install the hook. Here’s lazy
version of the example above:</p>
<p>Bazaar のスタートアップ時間を短縮するために、フックを “遅延” インストールすることができます。
遅延インストールには <tt class="docutils literal"><span class="pre">bzrlib.hooks.install_lazy_named_hook</span></tt> 関数を使います。
遅延インストールを使えば、フックをインストールするためだけにフックポイントを含むモジュールを
ロードする必要がなくなります。
次の例は、上の例の遅延バージョンです。</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">bzrlib</span> <span class="kn">import</span> <span class="n">hooks</span>
<span class="k">def</span> <span class="nf">post_push_hook</span><span class="p">(</span><span class="n">push_result</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"The new revno is </span><span class="si">%d</span><span class="s">"</span> <span class="o">%</span> <span class="n">push_result</span><span class="o">.</span><span class="n">new_revno</span>
<span class="n">hooks</span><span class="o">.</span><span class="n">install_lazy_named_hook</span><span class="p">(</span><span class="s">'bzrlib.branch'</span><span class="p">,</span> <span class="s">'Branch.hooks'</span><span class="p">,</span>
<span class="s">'post_push'</span><span class="p">,</span> <span class="n">post_push_hook</span><span class="p">,</span> <span class="s">'My post_push hook'</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id6">
<h2>フックをデバッグする<a class="headerlink" href="#id6" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>インストールされたフックの一覧 (と、利用可能なフックポイントの一覧) を表示するには、
隠しコマンドである <tt class="docutils literal"><span class="pre">hooks</span></tt> コマンドを使います:</p>
<div class="highlight-python"><div class="highlight"><pre>bzr hooks
</pre></div>
</div>
</div>
<div class="section" id="id7">
<h2>例: マージプラグイン<a class="headerlink" href="#id7" title="このヘッドラインへのパーマリンク">¶</a></h2>
<p>次の例は <tt class="docutils literal"><span class="pre">Merger.merge_file_content</span></tt> フックのデモのための、完全なプラグインです。
このプラグインは、 <tt class="docutils literal"><span class="pre">*.xml</span></tt> の名前のファイルに対する全てのマージに着いて、
Bazaar がそのマージがクリーンだと判断しても必ず「衝突」状態にします。</p>
<p><tt class="docutils literal"><span class="pre">merge_xml.py</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="sd">"""Custom 'merge' logic for *.xml files.</span>
<span class="sd">Always conflicts if both branches have changed the file.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">bzrlib.merge</span> <span class="kn">import</span> <span class="n">PerFileMerger</span><span class="p">,</span> <span class="n">Merger</span>
<span class="k">def</span> <span class="nf">merge_xml_files_hook</span><span class="p">(</span><span class="n">merger</span><span class="p">):</span>
<span class="sd">"""Hook to merge *.xml files"""</span>
<span class="k">return</span> <span class="n">AlwaysConflictXMLMerger</span><span class="p">(</span><span class="n">merger</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">AlwaysConflictXMLMerger</span><span class="p">(</span><span class="n">PerFileMerger</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">file_matches</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_filename</span><span class="p">(</span><span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">merger</span><span class="o">.</span><span class="n">this_tree</span><span class="p">)</span>
<span class="k">return</span> <span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">'.xml'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">merge_matching</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'conflicted'</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">this_lines</span>
<span class="n">Merger</span><span class="o">.</span><span class="n">hooks</span><span class="o">.</span><span class="n">install_named_hook</span><span class="p">(</span>
<span class="s">'merge_file_content'</span><span class="p">,</span> <span class="n">merge_xml_files_hook</span><span class="p">,</span> <span class="s">'*.xml file merge'</span><span class="p">)</span>
</pre></div>
</div>
<p><tt class="docutils literal"><span class="pre">merge_file_content</span></tt> hooks are executed for each file to be merged. For
a more a complex example look at the <tt class="docutils literal"><span class="pre">news_merge</span></tt> plugin that’s bundled with
Bazaar in the <tt class="docutils literal"><span class="pre">bzrlib/plugins</span></tt> directory.</p>
<p><tt class="docutils literal"><span class="pre">merge_file_content</span></tt> フックは各ファイルがマージされるたびに呼ばれます。
もっと複雑な例として、 Bazaar の <tt class="docutils literal"><span class="pre">bzrlib/plugins</span></tt> ディレクトリに同梱されている
<tt class="docutils literal"><span class="pre">news_merge</span></tt> プラグインも参照してください。</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">目次</a></h3>
<ul>
<li><a class="reference internal" href="#">フックを利用する</a><ul>
<li><a class="reference internal" href="#id2">フックとは？</a></li>
<li><a class="reference internal" href="#id4">フックを使用する</a></li>
<li><a class="reference internal" href="#id6">フックをデバッグする</a></li>
<li><a class="reference internal" href="#id7">例: マージプラグイン</a></li>
</ul>
</li>
</ul>
<h4>前のトピックへ</h4>
<p class="topless"><a href="server.html"
title="前の章へ">スマートサーバーを稼働させる</a></p>
<h4>次のトピックへ</h4>
<p class="topless"><a href="version_info.html"
title="次の章へ">バージョンの情報をエクスポートする</a></p>
<h3>このページ</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-guide/hooks.txt"
rel="nofollow">ソースコードを表示</a></li>
</ul>
<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="clearer"></div>
</div>
<div class="related">
<h3>ナビゲーション</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="version_info.html" title="バージョンの情報をエクスポートする"
>次へ</a></li>
<li class="right" >
<a href="server.html" title="スマートサーバーを稼働させる"
>前へ</a> |</li>
<li><a href="../index.html">目次 (2.6.0)</a> »</li>
<li><a href="index.html" >Bazaarユーザーガイド</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2011 Canonical Ltd.
このドキュメントは <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3 で生成しました。
</div>
</body>
</html>
