source: pymigemo/trunk/README.rst @ 227

.. $Id$

:mod:`migemo` --- C/Migemo の Python バむンディング
===================================================

.. module:: migemo
   :synopsis: C/Migemo の Python バむンディング
.. moduleauthor:: Atzm WATANABE <atzm@atzm.org>

`C/Migemo <http://www.kaoriya.net/software/cmigemo>`_ を
Python から利甚するための拡匵モゞュヌルです

このモゞュヌルの利甚にあたっおは
C/Migemo がむンストヌルされおいるこずが前提ずなっおいたす
ラむブラリ怜玢パスに migemo.so が
ヘッダ怜玢パスに migemo.h が存圚するこずをご確認䞋さい

むンストヌル
------------
同梱の setup.py をご利甚䞋さい::

   $ ./setup.py build
   # ./setup.py install

基本的な䜿い方
--------------
基本的な䜿い方は以䞋のようになりたす::

   >>> import migemo
   >>> m = migemo.Migemo('/usr/share/migemo/migemo-dict')
   >>> print(m.query('hoge'))
   (hoge||ほげ|捕鯚|垆桁|補元|ホゲ)

migemo-dict 蟞曞ファむルず共に :class:`Migemo` クラスのオブゞェクトを生成し
:meth:`Migemo.query` メ゜ッドに文字列を枡すず正芏衚珟が返りたす
この正芏衚珟を :mod:`re` ず組み合わせれば怜玢等の甚途に利甚するこずができたす

.. note::
   返华される正芏衚珟は読み蟌んだ蟞曞によっお異なるので
   必ずしも䞊蚘の通りになるずは限りたせん

リファレンス
------------

:class:`Migemo` クラス
``````````````````````

.. class:: Migemo(dictionary)

   migemo をハンドルするクラスです
   *dictionary* は利甚する migemo-dict 蟞曞ファむルのパスです

   .. method:: query(query)

      *query* から正芏衚珟を返したす
      *query* は unicode でも゚ンコヌドされた文字列でも構いたせん
      ただし *query* ãŒã‚šãƒ³ã‚³ãƒŒãƒ‰ã•ã‚ŒãŸæ–‡å­—åˆ—ã®å ŽåˆïŒŒ
      その゚ンコヌディングが蟞曞の゚ンコヌディングず異なるず
      ゚ラヌずなる可胜性がありたす

   .. method:: is_enable()

      蟞曞を正垞に読み蟌めおいるかどうかチェックしたす
      æ­£åžžã«èª­ã¿èŸŒã‚ãŠã„ã‚‹å Žåˆã¯ ``True`` が
      ãã†ã§ãªã„å Žåˆã¯ ``False`` が返りたす

   .. method:: load(dict_id, dict_file)

      蟞曞を読み蟌みたす
      *dict_id* は埌述の DICTID のいずれかで読み蟌む蟞曞の皮類を指定したす
      *dict_file* は蟞曞ファむルのパスです
      このメ゜ッドは成功するず読み蟌んだ蟞曞の DICTID を返したす
      èª­ã¿èŸŒã¿ã«å€±æ•—ã—ãŸå Žåˆã¯ :data:`DICTID_INVALID` を返したす

   .. method:: get_operator(index)

      *index* で指定された正芏衚珟に䜿甚するメタ文字を返したす
      *index* は埌述の OPINDEX のいずれかを指定する必芁がありたす

   .. method:: set_operator(index, op)

      *index* で指定された正芏衚珟に䜿甚するメタ文字を *op* に倉曎したす
      *index* は埌述の OPINDEX のいずれかを指定する必芁がありたす
      倉曎に成功すれば ``True`` が倱敗すれば ``False`` が返りたす

   .. method:: get_encoding()

      読み蟌んだ蟞曞の゚ンコヌディングを返したす
      䟋えば EUC-JP で曞かれた蟞曞であれば ``'euc_jp'`` が返りたす
      ``'cp932'`` か ``'euc_jp'`` か ``'utf8'`` か ``'ascii'``
      のいずれかが返りたす

DICTID
``````

:meth:`Migemo.load` で利甚する蟞曞の皮類です

.. data:: DICTID_MIGEMO

   migemo-dict 蟞曞を瀺したす

.. data:: DICTID_ROMA2HIRA

   ロヌマ字→平仮名倉換衚を瀺したす

.. data:: DICTID_HIRA2KATA

   平仮名→カタカナ倉換衚を瀺したす

.. data:: DICTID_HAN2ZEN

   半角→党角倉換衚を瀺したす

.. data:: DICTID_ZEN2HAN

   党角→半角倉換衚を瀺したす

.. data:: DICTID_INVALID

   èŸžæ›žã®èª­ã¿èŸŒã¿ã«å€±æ•—ã—ãŸå Žåˆã«è¿”ã‚‹ DICTID です

OPINDEX
```````

:meth:`Migemo.get_operator` たたは :meth:`Migemo.set_operator`
で利甚するメタ文字の皮類です

.. data:: OPINDEX_OR

   論理和を瀺したす
   デフォルトは ``'|'`` です

.. data:: OPINDEX_NEST_IN

   グルヌピング時の開き括匧を瀺したす
   デフォルトは ``'('`` です

.. data:: OPINDEX_NEST_OUT

   グルヌピング時の閉じ括匧を瀺したす
   デフォルトは ``')'`` です

.. data:: OPINDEX_SELECT_IN

   遞択の開始を衚す開き鈎括匧を瀺したす
   デフォルトは ``'['`` です

.. data:: OPINDEX_SELECT_OUT

   遞択の終了を衚す閉じ鈎括匧を瀺したす
   デフォルトは ``']'`` です

.. data:: OPINDEX_NEWLINE

   各文字の間に挿入される「0 個以䞊の空癜もしくは改行にマッチする」
   パタヌンを瀺したす
   デフォルトは ``''`` です

VERSION
```````

migemo のバヌゞョンです

.. data:: MIGEMO_VERSION

   C/Migemo のバヌゞョンを瀺したす

.. data:: PYMIGEMO_VERSION

   PyMigemo のバヌゞョンを瀺したす

ラむセンス
----------
äºŒæ¡é … BSD ãƒ©ã‚€ã‚»ãƒ³ã‚¹ã«æº–æ‹ ã—ãŸã™ïŒŽ
詳现は同梱の LICENSE ファむルをご芧䞋さい