Changeset 226 for pymigemo


Ignore:
Timestamp:
11/10/12 18:39:27 (10 years ago)
Author:
atzm
Message:
  • change documentation format to rst
Location:
pymigemo/trunk
Files:
1 edited
1 moved

Legend:

Unmodified
Added
Removed
  • pymigemo/trunk/ChangeLog

    r42 r226  
     12012-11-10  Atzm WATANABE  <atzm@atzm.org> 
     2 
     3        * pymigemo.c: Python3 API support 
     4 
    15*pymigemo-0.3 (07 Nov 2010) 
    262010-11-07  Atzm WATANABE  <atzm@atzm.org> 
  • pymigemo/trunk/README.rst

    r42 r226  
    1 $Id$ 
     1.. $Id$ 
    22 
    3 = これは䜕 = 
    4 C/Migemo を Python から䜿うための binding です 
     3:mod:`migemo` --- C/Migemo の Python バむンディング 
     4=================================================== 
    55 
     6.. module:: migemo 
     7   :synopsis: C/Migemo の Python バむンディング 
     8.. moduleauthor:: Atzm WATANABE <atzm@atzm.org> 
    69 
    7 = å¿ 
    8 èŠãªã‚‚の = 
    9 C/Migemo ラむブラリがむンストヌルされおいるこずが前提ずなっおいたす 
    10 ãƒ©ã‚€ãƒ–ラリ怜玢パスに migemo.so がヘッダ怜玢パスに migemo.h が存圚するこずをご確認䞋さい 
     10`C/Migemo <http://www.kaoriya.net/software/cmigemo>`_ を 
     11Python から利甚するための拡匵モゞュヌルです 
    1112 
     13このモゞュヌルの利甚にあたっおは 
     14C/Migemo がむンストヌルされおいるこずが前提ずなっおいたす 
     15ラむブラリ怜玢パスに migemo.so が 
     16ヘッダ怜玢パスに migemo.h が存圚するこずをご確認䞋さい 
    1217 
    13 = むンストヌル方法 = 
    14 åŒæ¢±ã® setup.py をご利甚䞋さい 
     18むンストヌル 
     19------------ 
     20同梱の setup.py をご利甚䞋さい:: 
    1521 
    16 {{{ 
    17 $ ./setup.py build 
    18 # ./setup.py install 
    19 }}} 
     22   $ ./setup.py build 
     23   # ./setup.py install 
    2024 
     25基本的な䜿い方 
     26-------------- 
     27基本的な䜿い方は以䞋のようになりたす:: 
    2128 
    22 = ラむセンス = 
     29   >>> import migemo 
     30   >>> m = migemo.Migemo('/usr/share/migemo/migemo-dict') 
     31   >>> print(m.query('hoge')) 
     32   (hoge|
     33|ほげ|捕鯚|垆桁|補å 
     34ƒ|ホゲ) 
     35 
     36:meth:`Migemo.query` メ゜ッドに文字列を枡すず正芏衚珟が unicode で返りたす 
     37この正芏衚珟を :mod:`re` ず組み合わせれば怜玢等の甚途に利甚するこずができたす 
     38 
     39.. note:: 
     40   è¿”华される正芏衚珟は読み蟌んだ蟞曞によっお異なるので 
     41   å¿ 
     42ずしも䞊蚘の通りになるずは限りたせん 
     43 
     44リファレンス 
     45------------ 
     46 
     47:class:`Migemo` クラス 
     48`````````````````````` 
     49 
     50.. class:: Migemo(dictionary) 
     51 
     52   migemo をハンドルするクラスです 
     53   *dictionary* は利甚する migemo-dict 蟞曞ファむルのパスです 
     54 
     55   .. method:: query(query) 
     56 
     57      *query* から正芏衚珟を unicode で返したす 
     58      *query* は unicode でも゚ンコヌドされた文字列でも構いたせん 
     59      ただし *query* が文字列の堎合 
     60      その゚ンコヌディングが蟞曞の゚ンコヌディングず異なるず 
     61      ゚ラヌずなる可胜性がありたす 
     62 
     63   .. method:: is_enable() 
     64 
     65      蟞曞を正垞に読み蟌めおいるかどうかチェックしたす 
     66      正垞に読み蟌めおいる堎合は ``True`` が 
     67      そうでない堎合は ``False`` が返りたす 
     68 
     69   .. method:: load(dict_id, dict_file) 
     70 
     71      蟞曞を読み蟌みたす 
     72      *dict_id* は埌述の DICTID のいずれかで読み蟌む蟞曞の皮類を指定したす 
     73      *dict_file* は蟞曞ファむルのパスです 
     74      このメ゜ッドは成功するず読み蟌んだ蟞曞の DICTID を返したす 
     75      読み蟌みに倱敗した堎合は :data:`DICTID_INVALID` を返したす 
     76 
     77   .. method:: get_operator(index) 
     78 
     79      *index* で指定された正芏衚珟に䜿甚するメタ文字を返したす 
     80      *index* は埌述の OPINDEX のいずれかを指定する忠
     81芁がありたす 
     82 
     83   .. method:: set_operator(index, op) 
     84 
     85      *index* で指定された正芏衚珟に䜿甚するメタ文字を *op* に倉曎したす 
     86      *index* は埌述の OPINDEX のいずれかを指定する忠
     87芁がありたす 
     88      倉曎に成功すれば ``True`` が倱敗すれば ``False`` が返りたす 
     89 
     90   .. method:: get_encoding() 
     91 
     92      読み蟌んだ蟞曞の゚ンコヌディングを文字列で返したす 
     93      䟋えば EUC-JP で曞かれた蟞曞であれば ``'euc_jp'`` が返りたす 
     94      ``'cp932'`` か ``'euc_jp'`` か ``'utf8'`` か ``'ascii'`` 
     95      のいずれかが返りたす 
     96 
     97DICTID 
     98`````` 
     99 
     100:meth:`Migemo.load` で利甚する蟞曞の皮類です 
     101 
     102.. data:: DICTID_MIGEMO 
     103 
     104   migemo-dict 蟞曞を瀺したす 
     105 
     106.. data:: DICTID_ROMA2HIRA 
     107 
     108   ãƒ­ãƒŒãƒžå­—→平仮名倉換衚を瀺したす 
     109 
     110.. data:: DICTID_HIRA2KATA 
     111 
     112   å¹³ä»®åâ†’カタカナ倉換衚を瀺したす 
     113 
     114.. data:: DICTID_HAN2ZEN 
     115 
     116   åŠè§’→å 
     117šè§’倉換衚を瀺したす 
     118 
     119.. data:: DICTID_ZEN2HAN 
     120 
     121   å 
     122šè§’→半角倉換衚を瀺したす 
     123 
     124.. data:: DICTID_INVALID 
     125 
     126   èŸžæ›žã®èª­ã¿èŸŒã¿ã«å€±æ•—した堎合に返る DICTID です 
     127 
     128OPINDEX 
     129``````` 
     130 
     131:meth:`Migemo.get_operator` たたは :meth:`Migemo.set_operator` 
     132で利甚するメタ文字の皮類です 
     133 
     134.. data:: OPINDEX_OR 
     135 
     136   è«–理和を瀺したす 
     137   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``'|'`` です 
     138 
     139.. data:: OPINDEX_NEST_IN 
     140 
     141   ã‚°ãƒ«ãƒŒãƒ”ング時の開き括匧を瀺したす 
     142   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``'('`` です 
     143 
     144.. data:: OPINDEX_NEST_OUT 
     145 
     146   ã‚°ãƒ«ãƒŒãƒ”ング時の閉じ括匧を瀺したす 
     147   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``')'`` です 
     148 
     149.. data:: OPINDEX_SELECT_IN 
     150 
     151   éžæŠžã®é–‹å§‹ã‚’衚す開き鈎括匧を瀺したす 
     152   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``'['`` です 
     153 
     154.. data:: OPINDEX_SELECT_OUT 
     155 
     156   éžæŠžã®çµ‚了を衚す閉じ鈎括匧を瀺したす 
     157   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``']'`` です 
     158 
     159.. data:: OPINDEX_NEWLINE 
     160 
     161   å„文字の間に挿å 
     162¥ã•ã‚Œã‚‹ã€Œ0 個以䞊の空癜もしくは改行にマッチする」 
     163   ãƒ‘タヌンを瀺したす 
     164   ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã¯ ``''`` です 
     165 
     166VERSION 
     167``````` 
     168 
     169migemo のバヌゞョンです 
     170 
     171.. data:: MIGEMO_VERSION 
     172 
     173   C/Migemo のバヌゞョンを瀺したす 
     174 
     175.. data:: PYMIGEMO_VERSION 
     176 
     177   PyMigemo のバヌゞョンを瀺したす 
     178 
     179ラむセンス 
     180---------- 
    23181二条頠
    24182 BSD ラむセンスに準拠したす 
    25183詳现は同梱の LICENSE ファむルをご芧䞋さい 
    26  
    27  
    28 = 䜿い方 = 
    29 {{{ 
    30 >>> import migemo 
    31 >>> m = migemo.Migemo("/usr/share/migemo/migemo-dict") 
    32 >>> print m.query("hoge") 
    33 (hoge|
    34 |ほげ|捕鯚|垆桁|補å 
    35 ƒ|ホゲ) 
    36 }}} 
    37  * ※ query() 結果は読み蟌んだ蟞曞によっお異なりたす 
    38  
    39  
    40 == リファレンス == 
    41 === モゞュヌルコンテンツ === 
    42  * VERSION 
    43    * MIGEMO_VERSION 
    44      * C/Migemo のバヌゞョン 
    45    * PYMIGEMO_VERSION 
    46      * PyMigemo のバヌゞョン 
    47  
    48  * DICTID 
    49    * DICTID_MIGEMO 
    50      * migemo-dict 蟞曞 
    51    * DICTID_ROMA2HIRA 
    52      * ロヌマ字→平仮名倉換衚 
    53    * DICTID_HIRA2KATA 
    54      * 平仮名→カタカナ倉換衚 
    55    * DICTID_HAN2ZEN 
    56      * 半角→å 
    57 šè§’倉換衚 
    58    * DICTID_ZEN2HAN 
    59      * å 
    60 šè§’→半角倉換衚 
    61    * DICTID_INVALID 
    62      * load メ゜ッドで蟞曞の読み蟌みに倱敗した堎合に返る 
    63  
    64  * OPINDEX 
    65    * OPINDEX_OR 
    66      * 論理和 
    67      * Migemo.get_operator() に枡した際のデフォルトは "|" 
    68    * OPINDEX_NEST_IN 
    69      * グルヌピング時の開き括匧 
    70      * Migemo.get_operator() に枡した際のデフォルトは "(" 
    71    * OPINDEX_NEST_OUT 
    72      * グルヌピング時の閉じ括匧 
    73      * Migemo.get_operator() に枡した際のデフォルトは ")" 
    74    * OPINDEX_SELECT_IN 
    75      * 遞択の開始を衚す開き鈎括匧 
    76      * Migemo.get_operator() に枡した際のデフォルトは "[" 
    77    * OPINDEX_SELECT_OUT 
    78      * 遞択の終了を衚す閉じ鈎括匧 
    79      * Migemo.get_operator() に枡した際のデフォルトは "]" 
    80    * OPINDEX_NEWLINE 
    81      * 各文字の間に挿å 
    82 ¥ã•ã‚Œã‚‹ã€Œ0 個以䞊の空癜もしくは改行にマッチする」パタヌン 
    83      * Migemo.get_operator() に枡した際のデフォルトは "" (空文字列) 
    84  
    85  * Migemo クラス 
    86    * __init__(dictionary) 
    87      * Migemo クラスのコンストラクタ 
    88      * 匕数 
    89        * dictionary: migemo-dict 蟞曞ファむルのパス (str) 
    90    * get_encoding() 
    91      * migemo-dict 蟞曞の゚ンコヌディングを str で返す 
    92        äŸ‹ãˆã° EUC-JP で曞かれた蟞曞であれば "euc_jp" が返る 
    93        cp932euc_jputf8 のいずれかを返すが 
    94        èŸžæ›žã®ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ãŒã“れらに該圓しなかった堎合は "ascii" を返す 
    95      * 匕数 
    96        * なし 
    97      * 返り倀 
    98        * ゚ンコヌディング文字列 (str) 
    99    * get_operator(index) 
    100      * index で指定された正芏衚珟に䜿甚するメタ文字を返す (str) 
    101      * 匕数 
    102        * index: 前述の OPINDEX のいずれか 
    103      * 返り倀 
    104        * メタ文字列 (str) 
    105    * is_enable() 
    106      * Migemo 冠
    107 éƒšã«ïŒŒæ­£åžžã«èŸžæ›žãŒèª­ã¿èŸŒã‚ãŠã„るかどうかをチェックする 
    108      * 匕数 
    109        * なし 
    110      * 返り倀 
    111        * 真停倀 : 正垞に読み蟌めおいる堎合に真 
    112    * load(dict_id, dict_file) 
    113      * Migemo オブゞェクトに蟞曞を远加で読み蟌む 
    114      * 匕数 
    115        * dict_id: 前述の DICTID のいずれか 
    116        * dict_file: 蟞曞ファむルのパス 
    117      * 返り倀 
    118        * 読み蟌んだ蟞曞の DICTID 
    119          èª­ã¿èŸŒã¿ã«å€±æ•—した堎合 DICTID_INVALID が返る 
    120    * query(query) 
    121      * query で䞎えられた文字列から日本語怜玢のための正芏衚珟を返す 
    122      * 匕数 
    123        * query: 問い合わせる文字列 (Unicode or str) 
    124          str で ascii 以倖の文字列を枡す堎合 
    125          èŸžæ›žãšåŒã˜ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°ã®æ–‡å­—列でないず゚ラヌになる可胜性がある 
    126      * 返り倀 
    127        * 正芏衚珟文字列 (Unicode) 
    128    * set_operator(index, op) 
    129      * index で指定された正芏衚珟に䜿甚するメタ文字を op に倉曎する 
    130      * 匕数 
    131        * index: 前述の OPINDEX のいずれか 
    132        * op: メタ文字列 (str) 
    133      * 返り倀 
    134        * 真停倀 : 成功時に真 
    135  
    136  
    137 = その他 = 
    138 æœ¬ã‚œãƒ•ãƒˆã‚Šã‚§ã‚¢ã«å¯Ÿã™ã‚‹ã‚³ãƒ¡ãƒ³ãƒˆïŒŒãƒã‚°å ±å‘ŠïŒŒãƒ‘ッチなどは倧いに歓迎したす 
    139 äž‹èš˜ãƒ¡ãƒŒãƒ«ã‚¢ãƒ‰ãƒ¬ã‚¹ãŸã§ãŠæ°—軜にお寄せ䞋さい 
    140  
    141 Atzm WATANABE <atzm@atzm.org> 
Note: See TracChangeset for help on using the changeset viewer.