※ 左右のカーソルキーでもページ繰りができます
TOP <<<<
|
BACKWARD <<
|
|
>> FORWARD
|
>>>> END
<div class="title">How to write extension/hook for Mercurial</div> <div class="author">Mercurial 勉強会 2009/03/12<br/> 藤原 克則 <foozy@lares.dti.ne.jp></div> ---- <div class="title">How to write extension<s>/hook</s> for Mercurial</div> <div class="author">Mercurial 勉強会 2009/03/12<br/> 藤原 克則 <foozy@lares.dti.ne.jp></div> ---- <div class="title">How to write extension for Mercurial</div> <div class="author">Mercurial 勉強会 2009/03/12<br/> 藤原 克則 <foozy@lares.dti.ne.jp></div> ---- <div class="header">公式ドキュメント</div> <dl class="nocenterring"> <dt>Developer Basics</dt> <dd><a href="http://www.selenic.com/mercurial/wiki/index.cgi/DeveloperBasics" >http://www.selenic.com/mercurial/wiki/index.cgi/DeveloperBasics</a><br> スタンドアロンでの履歴情報アクセスのサンプル </dd> <dt>The Mercurial API</dt> <dd><a href="http://www.selenic.com/mercurial/wiki/index.cgi/MercurialApi" >http://www.selenic.com/mercurial/wiki/index.cgi/MercurialApi</a><br> 基本クラス群の API 概要 </dd> <dt>Writing Mercurial extensions</dt> <dd><a href="http://www.selenic.com/mercurial/wiki/index.cgi/WritingExtensions" >http://www.selenic.com/mercurial/wiki/index.cgi/WritingExtensions</a><br> extension 実装の概要 </dd> <dt>API Changes</dt> <dd><a href="http://www.selenic.com/mercurial/wiki/index.cgi/API_Changes" >http://www.selenic.com/mercurial/wiki/index.cgi/API_Changes</a><br> 主要 Mercurial API 仕様の変遷 </dd> </dl> ---- <div class="header">extension の用途</div> <dl> <dt>コマンドの追加</dt> <dd>e.g.: "mq"</dd> </dl> ---- <div class="header">extension の用途</div> <dl> <dt>コマンドの追加</dt> <dd>e.g.: "mq"</dd> <dt>関数の定義</dt> <dd>e.g.: "bugzilla"(hook), "win32text"(encoder/decoder)</dd> </dl> ---- <div class="header">extension の用途</div> <dl> <dt>コマンドの追加</dt> <dd>e.g.: "mq"</dd> <dt>関数の定義</dt> <dd>e.g.: "bugzilla"(hook), "win32text"(encoder/decoder)</dd> <dt>現行機能の改変("silently" work)</dt> <dd>e.g.: "graphlog", "win32mbcs"</dd> </dl> ---- <div class="header">Mercurial API 使用時の注意事項</div> <dl> <dt>引数／戻り値の型が不明瞭: 文字列／changectx 型／内部データ形式(node)</dt> <dd> <p>1.0 版以前は、内部データ形式を必要とするケースが多かった</p> <p>現行版では概ね、引数なら文字列／changectx 型が併用可能、 戻り値は changectx/filectx ないし revlog 型になっている (内部データ形式の直接アクセスは隠蔽)ので、 あまり心配する必要は無い(筈)</p> </dd> </ul> ---- <div class="header">Mercurial API 使用時の注意事項</div> <dl> <dt>引数／戻り値の型が不明瞭: 文字列／changectx 型／内部データ形式(node)</dt> <dd> <p>1.0 版以前は、内部データ形式を必要とするケースが多かった</p> <p>現行版では概ね、引数なら文字列／changectx 型が併用可能、 戻り値は changectx/filectx ないし revlog 型になっている (内部データ形式の直接アクセスは隠蔽)ので、 あまり心配する必要は無い(筈)</p> </dd> <dt>undocumented な API が多数残っている</dt> <dd><p>先述した "<a href="http://www.selenic.com/mercurial/wiki/index.cgi/MercurialApi" >The Mercurial API</a>" には主要なクラスの説明は掲載されているが、 実際に履歴情報を参照しようとすると、これだけでは難しい。</p> <p>類似機能を実現しているコマンドのソースを参照するのが最短。</p> <p>通常は commands.py での主要コマンド定義を起点に、 cmdutil.py, localrepo.py あたりを参照すれば、 機能実現に必要な手法は概ね獲得できる筈。</p> </dd> </ul> ---- <div class="chapter">ボトムアップな実装</div> ---- <div class="header">スタンドアロン実行の事前準備</div> <p>"<a href="http://www.selenic.com/mercurial/wiki/index.cgi/DeveloperBasics" >Developer Basics</a>" より引用:</p> <pre> from mercurial import ui from mercurial import hg u = ui.ui() repo = hg.repository(u, ".") </pre> ---- <div class="header">スタンドアロン実行の事前準備</div> <p>"<a href="http://www.selenic.com/mercurial/wiki/index.cgi/DeveloperBasics" >Developer Basics</a>" より引用:</p> <pre> from mercurial import ui from mercurial import hg u = ui.ui() repo = hg.repository(u, ".") </pre> <p>利点:</p> <ul> <li>気軽に試せる <li>try & error の turn around が短くて済む </ul> <p>欠点:</p> <ul> <li>上記の u インスタンス経由で取得できる設定は、<span class="hilite">.hg/hgrc のものを除く</span> <li>複雑な初期化を要するものは、動作確認が難しい </ul> ---- <div class="chapter">基本的な履歴参照</div> ---- <div class="header">特定リビジョンの情報取得</div> <p>特定のリビジョン revname に関する情報取得用オブジェクトの引き当て:</p> <pre> ctx = repo[revname] # Change Context(changectx) </pre> <p>changectx で利用可能な機能の概要は "<a href="http://www.selenic.com/mercurial/wiki/index.cgi/MercurialApi" >The Mercurial API</a>" の "5. Change Contexts" 参照</p> ---- <div class="header">作業領域の情報取得</div> <pre> ctx = repo[None] # 作業領域の changectx(workingctx) </pre> <p>親リビジョンの ctx とは以下の点で異なる</p> <pre> str(ctx) => '<parent hash id>+' ctx.rev() => None ctx.files() => ※ 作業領域の状況を反映 ctx.description() => ※ 空文字列 </pre> ---- <div class="header">作業領域の情報取得</div> <pre> ctx = repo[None] # 作業領域の changectx(workingctx) </pre> <p>親リビジョンの ctx とは以下の点で異なる</p> <pre> str(ctx) => '<parent hash id>+' ctx.rev() => None ctx.files() => ※ 作業領域の状況を反映 ctx.description() => ※ 空文字列 </pre> <p>作業領域の親リビジョンの changectx 取得は:</p> <pre> parent = repo['.'] # 第1親固定 parent1, parent2 = repo[None].parents() </pre> ---- <div class="header">ファイルの情報取得</div> <p>特定のリビジョン revname 時点における、 ファイル filename に関する情報取得用オブジェクトの引き当て:</p> <pre> ctx = repo[revname] fctx = ctx[filename] # File context(filectx) </pre> <p>filectx で利用可能な機能の概要は "<a href="http://www.selenic.com/mercurial/wiki/index.cgi/MercurialApi" >The Mercurial API</a>" の "6. File Contexts" 参照</p> ---- <div class="chapter">履歴参照の実際</div> ---- <div class="header">特定リビジョン時点のスナップショット参照</div> <pre> ctx = repo[revname] patterns = [] matchopts = { 'include': [], 'exclude': [] } matcher = cmdutil.match(repo, patterns, matchopts) for filename in ctx.walk(matcher): fctx = ctx[filename] # File Context(filectx) fctx.data() # content of file at that revision </pre> ---- <div class="header">特定リビジョン時点のスナップショット参照</div> <pre> ctx = repo[revname] patterns = [] matchopts = { 'include': [], 'exclude': [] } matcher = cmdutil.match(repo, patterns, matchopts) for filename in ctx.walk(matcher): fctx = ctx[filename] # File Context(filectx) fctx.data() # content of file at that revision </pre> <p>全ファイルを参照する場合は以下でも可:</p> <pre> for filename in ctx: fctx = ctx[filename] fctx.data() </pre> ---- <div class="header">tests if the file is in the changeset</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <code>filename in changectx</code> - tests if the file is <u>in the changeset</u> </div> <p>そのチェンジセットで、当該ファイルが変更されているか否かの判定</p> ---- <div class="header">tests if the file is in the changeset</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <code>filename in changectx</code> - tests if the file is <u>in the changeset</u> </div> <p><s>そのチェンジセットで、当該ファイルが変更されているか否かの判定</s></p> <p><span class="hilite">そのリビジョン時点において、 当該ファイルが存在するか否かの判定</span></p> ---- <div class="header">tests if the file is XXXX</div> <p>当該リビジョンにおける<span class="hilite" >ファイル存在</span>の有無の判定:</p> <pre> filename in changectx </pre> ---- <div class="header">tests if the file is XXXX</div> <p>当該リビジョンにおける<span class="hilite" >ファイル存在</span>の有無の判定:</p> <pre> filename in changectx </pre> <p>当該チェンジセットにおける<span class="hilite" >ファイル改変</span>の有無の判定:</p> <pre> filename in changectx.files().split() </pre> ---- <div class="header">tests if the file is XXXX</div> <p>当該リビジョンにおける<span class="hilite" >ファイル存在</span>の有無の判定:</p> <pre> filename in changectx </pre> <p>当該チェンジセットにおける<span class="hilite" >ファイル改変</span>の有無の判定:</p> <pre> filename in changectx.files().split() </pre> <p>※ この方法では、ファイル操作の詳細(変更／追加／削除)は判定出来ない</p> ---- <div class="header" >特定<u>リビジョン間</u>におけるファイル更新状況の取得</div> <pre> localrepository#status(self, node1='.', node2=None, match=None, ignored=False, clean=False, unknown=False) 引数: - node1/node2: リビジョン特定用の文字列、ないし changectx - match: ファイル名合致判定用の関数(通常は cmdutil.match() 戻り値) - ignored/clean/unknown: 当該状態ファイルの列挙の有無 戻り値: 以下の tuple (modified, added, removed, deleted, unknown, ignored, clean) </pre> <p>戻り値 tuple の各要素は、 それぞれの status に該当するファイルのリスト</p> <p>"removed" と "deleted" の差は hg status で言うところの "R" と "!" の差</p> ---- <div class="header" >特定<u>リビジョン間</u>におけるファイル更新状況の取得</div> <pre> localrepository#status(self, node1='.', node2=None, match=None, ignored=False, clean=False, unknown=False) 引数: - node1/node2: リビジョン特定用の文字列、ないし changectx - match: ファイル名合致判定用の関数(通常は cmdutil.match() 戻り値) - ignored/clean/unknown: 当該状態ファイルの列挙の有無 戻り値: 以下の tuple (modified, added, removed, deleted, unknown, ignored, clean) </pre> <p>戻り値 tuple の各要素は、 それぞれの status に該当するファイルのリスト</p> <p>"removed" と "deleted" の差は hg status で言うところの "R" と "!" の差</p> <p>※ workingctx/memctx クラスは、 状態に応じたファイル一覧返却メソッドを提供しているが…</p> ---- <div class="header" >特定<u>チェンジセット</u>におけるファイル操作有無の判定</div> <pre> statuses = repo.status(ctx.parents()[0], ctx, <i>clean=True</i>) files = statuses[0] # for "modified" # files = statuses[1] # for "added" # files = statuses[2] # for "removed" # <i>files = statuses[6] # for "clean"</i> filename in files </pre> <p>以下のものは、 作業領域(repo[None])に対する判定の場合にのみ意味を持つ</p> <ul> <li>deleted(statuses[3]) <li>unknown(statuses[4]) ⇒ 要 "unknown=True" 指定 <li>ignored(statuses[5]) ⇒ 要 "ignored=True" 指定 </ul> ---- <div class="header">filectx における識別子</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filectx(id)</code> - the file context for another <span class="hilite">revision</span> of the file <li><code>fctx.filerev()</code> - the <span class="hilite">revision</span> at which this file was last changed <li><code>fctx.rev()</code> - the <span class="hilite" >revision</span> from which this file context was extracted </ul> </div> ---- <div class="header">filectx における識別子</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filectx(id)</code> - the file context for another <span class="hilite">revision</span> of the file <li><code>fctx.filerev()</code> - the <span class="hilite">revision</span> at which this file was last changed <li><code>fctx.rev()</code> - the <span class="hilite" >revision</span> from which this file context was extracted </ul> </div> <p>filectx#rev() における revision は、 changectx 識別子＝所謂 revname のこと</p> ---- <div class="header">filectx における識別子</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filectx(id)</code> - the file context for another <span class="hilite">revision</span> of the file <li><code>fctx.filerev()</code> - the <span class="hilite">revision</span> at which this file was last changed <li><code>fctx.rev()</code> - the <span class="hilite" >revision</span> from which this file context was extracted </ul> </div> <p>filectx#rev() における revision は、 changectx 識別子＝所謂 revname のこと</p> <p>filectx#filectx(id) および filectx#filerev() における revision は、 所謂 revname <span class="hilite">ではなく</span>、 当該ファイルに<span class="hilite">ローカルな通し番号</span></p> ---- <div class="header">特定ファイルの最終更新リビジョン取得</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filerev()</code> - the revision at which this file was <span class="hilite">last changed</span> </ul> </div> ---- <div class="header">特定ファイルの最終更新リビジョン取得</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filerev()</code> - the revision at which this file was <span class="hilite">last changed</span> </ul> </div> <p>"hg parent -r revname filename" 相当の情報は、以下の実装で取得可能</p> <pre> ctx = repo[revname] fctx = ctx[filename] lastchanged_fctx = fctx.filectx(fctx.filerev()) lastchanged_ctx = fctx.changectx() </pre> ---- <div class="header">特定ファイルの最終更新リビジョン取得</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.filerev()</code> - the revision at which this file was <span class="hilite">last changed</span> </ul> </div> <p>"hg parent -r revname filename" 相当の情報は、以下の実装で取得可能</p> <pre> ctx = repo[revname] fctx = ctx[filename] lastchanged_fctx = fctx.filectx(fctx.filerev()) lastchanged_ctx = fctx.changectx() </pre> <p>※ revname 時点で filename ファイルが存在していない場合、 ctx[filename] が失敗してしまう<br/> <span class="hilite">⇒ 次に述べる『履歴全般の走査』を使用する</span> </p> ---- <div class="header">履歴全般の走査 〜 ループ制御</div> <pre> patterns = [ .... ] get = util.cachefunc(lambda r: repo[r].changeset()) walkopts = { 'rev': [] } # default '0:-1' changeiter, matchfn = cmdutil.walkchangerevs(ui, repo, patterns, get, walkopts) for st, rev, fns in changeiter: # 反復実装 </pre> <p>walkopts での 'rev' 指定は必須</p> <p>以下の条件選別を walkopts として指定可能</p> <div class="quote"> <code>follow</code>, <code>follow-first</code>, <code>prune</code>, <code>removed</code>, <code>include</code>, <code>exclude</code> </div> ---- <div class="header">履歴全般の走査 〜 ループ制御</div> <pre> patterns = [ .... ] get = util.cachefunc(lambda r: repo[r].changeset()) walkopts = { 'rev': [] } # default '0:-1' changeiter, matchfn = cmdutil.walkchangerevs(ui, repo, patterns, get, walkopts) for st, rev, fns in changeiter: # 反復実装 </pre> <p>walkopts での 'rev' 指定は必須</p> <p>以下の条件選別を walkopts として指定可能</p> <div class="quote"> <code>follow</code>, <code>follow-first</code>, <code>prune</code>, <code>removed</code>, <code>include</code>, <code>exclude</code> </div> <p>"hg log" は以下の条件選別を反復実装において実施</p> <div class="quote"> <code>copies</code>, <code>date</code>, <code>keyword</code>, <code>no_merges</code>, <code>only_branch</code>, <code>only_merges</code>, <code>user</code> </div> ---- <div class="header">履歴全般の走査 〜 反復実装</div> <pre> for st, rev, fns in changeiter: if 'iter' == st: # 走査順序に沿った、リビジョン番号の繰り返し # tuple is: ("iter", rev, None) print st, rev, fns if 'add' == st: # 走査順序とは関わりの無い、ファイル名の繰り返し # tuple is: ("add", rev, fns) print st, rev, [f for f in fns] if 'window' == st: # 繰り返しにおける区切り(window)の終了 # tuple is: ("window", incrementing, lastrev) # 'lastrev' 部分は、走査全体で見た場合の最終リビジョン print st, rev, fns </pre> ---- <div class="header">特定チェンジセットの差分参照</div> <pre> ctx = repo[rev] parent = str(ctx.parents()[0].rev()) patterns = [] matchopts = {} matcher = cmdutil.match(repo, patterns, matchopts) diffopts = {} chunks = patch.diff(repo, parent, rev, matcher, diffopts) # chunks is list of diff chunks </pre> ---- <div class="header">特定チェンジセットの差分参照</div> <pre> ctx = repo[rev] parent = str(ctx.parents()[0].rev()) patterns = [] matchopts = {} matcher = cmdutil.match(repo, patterns, matchopts) diffopts = {} chunks = patch.diff(repo, parent, rev, matcher, diffopts) # chunks is list of diff chunks </pre> <p>1.1.2 以降であれば、以下の機能を利用可能:</p> <pre> for diffstat in patch.diffstatdata(chunks): # diffstat is tuple of: (filename, add#, remove#) </pre> ---- <div class="header">annotation 情報の取得</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.annotate(follow=False, linenumber=None)</code> - 〜〜 The follow and linenumber parameters are not documented here - <span class="hilite">see the source for details</span> </ul> </div> ---- <div class="header">annotation 情報の取得</div> <p>以下、"Mercurial API" からの抜粋:</p> <div class="cite"> <ul> <li><code>fctx.annotate(follow=False, linenumber=None)</code> - 〜〜 The follow and linenumber parameters are not documented here - <span class="hilite">see the source for details</span> </ul> </div> <p>以下、ソース中のコメントの抜粋:</p> <pre> (This) returns a list of tuples of (<span class="hilite" >ctx</span>, line) for each line in the file, where ctx is the filectx of the node where that line was last changed. This returns tuples of (<span class="hilite" >(ctx, linenumber)</span>, line) for each line, if "linenumber" parameter is <span class="hilite">NOT "None"</span>. In such tuples, linenumber means one at the <span class="hilite" >first appearance in the managed file</span>. To reduce annotation cost, this returns fixed value(False is used) as linenumber, <span class="hilite">if "linenumber" parameter is "False"</span>. </pre> ---- <div class="chapter">設定情報の取得</div> ---- <div class="header">単一値の取得</div> <ul> <li>ui.config(section, name) <li>ui.configbool(section, name) </ul> <pre> >>> ui.ui().config('ui', 'username') 'FUJIWARA Katsunori <foozy@lares.dti.ne.jp>' </pre> ---- <div class="header">リスト値の取得</div> <ul> <li>ui.configlist(section, name) </ul> <pre> >>> ui.ui().configlist('ui', 'username') ['FUJIWARA', 'Katsunori', '<foozy@lares.dti.ne.jp>'] </pre> ---- <div class="header">セクション値の一覧取得</div> <ul> <li>ui.configitems(section) </ul> <pre> >>> ui.ui().configitems('ui') [('merge', 'diff3'), ('ssh', 'w-ssh'), ('username', 'FUJIWARA Katsunori <foozy@lares.dti.ne.jp>')] </pre> ---- <div class="chapter">コマンド定義の作法</div> ---- <div class="header">コマンド定義のシグネチャ</div> <p>コマンド定義のシグネチャの基本形式は以下のもの</p> <pre> def command(ui, repo, a1, a2, ... *rest, **opts): </pre> <p>a1 〜 は必須引数、rest は省略可能引数、opts はオプション</p> ---- <div class="header">コマンド定義のシグネチャ</div> <p>コマンド定義のシグネチャの基本形式は以下のもの</p> <pre> def command(ui, repo, a1, a2, ... *rest, **opts): </pre> <p>a1 〜 は必須引数、rest は省略可能引数、opts はオプション</p> <p>※ e.g.: "hg add" コマンドのシグネチャ</p> <pre> def add(ui, repo, <span class="hilite">*pats, **opts</span>): </pre> <p>対象特定のための全ての引数をリスト形式の pats で、 オプションは辞書形式の opts で受け取る</p> ---- <div class="header">コマンド定義のシグネチャ</div> <p>コマンド定義のシグネチャの基本形式は以下のもの</p> <pre> def command(ui, repo, a1, a2, ... *rest, **opts): </pre> <p>a1 〜 は必須引数、rest は省略可能引数、opts はオプション</p> <p>※ e.g.: "hg add" コマンドのシグネチャ</p> <pre> def add(ui, repo, *pats, **opts</span>): </pre> <p>対象特定のための全ての引数をリスト形式の pats で、 オプションは辞書形式の opts で受け取る</p> <p>※ e.g.: "hg merge" コマンドのシグネチャ</p> <pre> def merge(ui, repo, <span class="hilite">node=None, force=None, rev=None</span>): </pre> <p>node は(省略可能な)第1引数、force/rev はオプション</p> ---- <div class="header">オプション値の取得</div> <ul> <li><code>--optname</code> オプション ⇒ <code>opts['optname']</code> で取得 </ul> ---- <div class="header">オプション値の取得</div> <ul> <li><code>--optname</code> オプション ⇒ <code>opts['optname']</code> で取得 <li><code>--long<span class="hilite">-</span>name</code> オプション ⇒ <code>opts['long<span class="hilite">_</span>name'] </code>で取得 </ul> ---- <div class="header">オプション値の取得</div> <ul> <li><code>--optname</code> オプション ⇒ <code>opts['optname']</code> で取得 <li><code>--long<span class="hilite">-</span>name</code> オプション ⇒ <code>opts['long<span class="hilite">_</span>name'] </code>で取得<br> <span class="hilite">ハイフン⇒アンダースコアの変換に注意！</span> </ul> ---- <div class="chapter">extension の初期化手順</div> ---- <div class="header">1. global code in extension</div> <p>load()@extensions.py によるロード契機で実行</p> ---- <div class="header">2. ui setup</div> <p>load()@extensions.py によるロード後に呼び出される</p> <pre> def uisetup(ui): # do initialization here. </pre> ---- <div class="header">2. ui setup</div> <p>load()@extensions.py によるロード後に呼び出される</p> <pre> def uisetup(ui): # do initialization here. </pre> <p>※ e.g.: "mq" extension</p> <pre> def uisetup(ui): extensions.wrapcommand(commands.table, 'import', mqimport) ※ 既存コマンドに対するラッピング </pre> ---- <div class="header">3. extension setup</div> <p>全ての extension がロードされた時点で、 _dispatch()@dispatch.py から呼び出される</p> ---- <div class="header">3. extension setup</div> <p>全ての extension がロードされた時点で、 _dispatch()@dispatch.py から呼び出される</p> <pre> def extsetup(): # do initialization here. </pre> <p>他の extension に依存している場合などで有用</p> ---- <div class="header">3. extension setup</div> <p>全ての extension がロードされた時点で、 _dispatch()@dispatch.py から呼び出される</p> <pre> def extsetup(): # do initialization here. </pre> <p>他の extension に依存している場合などで有用</p> <p>※ e.g.: "record" extension</p> <pre> def extsetup(): try: mq = extensions.find('mq') except keyerror: return </pre> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: tuple </ul> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: <span class="hilite">tuple</span> <ol> <li>コマンド実装関数のシンボル <li>オプションリスト(list of tuples) <li>synopsis 文字列(i18n 対応) </ol> </ul> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: tuple <ol> <li>コマンド実装関数のシンボル <li>オプションリスト(list of <span class="hilite">tuple</span>s) <ol> <li>short-form(文字列) ※ 「提供無し」なら「空文字列」 <li>long-form(文字列) <li>default value <li>オプション説明(i18n 対応) </ol> <li>synopsis 文字列(i18n 対応) </ol> </ul> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: tuple <ol> <li>コマンド実装関数のシンボル <li>オプションリスト(list of tuples) <ol> <li>short-form(文字列) ※ 「提供無し」なら「空文字列」 <li>long-form(文字列) <li><span class="hilite">default value</span> <ul> <li>フラグオプション(None/False) <li>値オプション(空文字列: ' ') <li>複数値オプション(空リスト: [ ]) </ul> <li>オプション説明(i18n 対応) </ol> <li>synopsis 文字列(i18n 対応) </ol> </ul> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: tuple <ol> <li>コマンド実装関数のシンボル <li>オプションリスト(list of tuples) <ol> <li>short-form(文字列) ※ 「提供無し」なら「空文字列」 <li>long-form(文字列) <li><span class="hilite">default value</span> <ul> <li>フラグオプション(None/False) <li>値オプション(空文字列: ' ') <li>複数値オプション(空リスト: [ ]) </ul> <li>オプション説明(i18n 対応) </ol> <li>synopsis 文字列(i18n 対応) </ol> </ul> <p>※ 既に定義済みのコマンドと名前が被る場合は、警告が表示される</p> ---- <div class="header">4. "cmdtable" の取り込み</div> <p>_dispatch()@dispatch.py による実施</p> <p>以下のような"辞書"形式による定義を "cmdtable" 変数に格納しておくことで、 自動的にコマンドが追加される</p> <ul> <li>key: コマンド名(パターン指定可能: e.g. "^commit|ci") <li>val: tuple <ol> <li>コマンド実装関数のシンボル <li>オプションリスト(list of tuples) <ol> <li>short-form(文字列) ※ 「提供無し」なら「空文字列」 <li>long-form(文字列) <li><span class="hilite">default value</span> <ul> <li>フラグオプション(None/False) <li>値オプション(空文字列: ' ') <li>複数値オプション(空リスト: [ ]) </ul> <li>オプション説明(i18n 対応) </ol> <li>synopsis 文字列(i18n 対応) </ol> </ul> <p>※ 既に定義済みのコマンドと名前が被る場合は、警告が表示される<br> <span class="hilite" >⇒ extensions#wrapcommand() で置き換える</span> </p> ---- <div class="header">5. repository setup</div> <p>リポジトリの初期化(＝ repository オブジェクトの初期化) が完了した時点で、 repository()@hg.py 契機で呼び出される</p> ---- <div class="header">5. repository setup</div> <p>リポジトリの初期化(＝ repository オブジェクトの初期化) が完了した時点で、 repository()@hg.py 契機で呼び出される</p> <pre> def reposetup(ui, repo): # do initialization here. </pre> <p>リポジトリの参照が必要な初期化は、 uisetup() や extsetup() ではなくこちらで実施</p> ---- <div class="header">5. repository setup</div> <p>リポジトリの初期化(＝ repository オブジェクトの初期化) が完了した時点で、 repository()@hg.py 契機で呼び出される</p> <pre> def reposetup(ui, repo): # do initialization here. </pre> <p>リポジトリの参照が必要な初期化は、 extsetup() ではなくこちらで実施</p> <p>※ e.g.: "win32text" extension</p> <pre> def reposetup(ui, repo): if not repo.local(): return for name, fn in _filters.iteritems(): repo.adddatafilter(name, fn) </pre> ---- <div class="chapter">END</div>