"tokenize" --- Pythonソースのためのトークナイザ
***********************************************

**ソースコード:** Lib/tokenize.py

======================================================================

"tokenize" モジュールでは、Python で実装された Python ソースコードの字
句解析器を提供します。さらに、このモジュールの字句解析器はコメントもト
ークンとして返します。このため、このモジュールはスクリーン上で表示する
際の色付け機能 (colorizers) を含む "清書出力器 (pretty-printer)" を実
装する上で便利です。

トークン・ストリームの扱いをシンプルにするために、全ての operator と
delimiter トークンおよび "Ellipsis" はジェネリックな "OP" トークンタイ
プとして返されます。正確な型は "tokenize.tokenize()" が返す *named
tuple* の "exact_type" プロパティをチェックすれば解ります。

警告:

  Note that the functions in this module are only designed to parse
  syntactically valid Python code (code that does not raise when
  parsed using "ast.parse()").  The behavior of the functions in this
  module is **undefined** when providing invalid Python code and it
  can change at any point.


入力のトークナイズ
==================

第一のエントリポイントは *ジェネレータ* です:

tokenize.tokenize(readline)

   "tokenize()" ジェネレータは一つの引数 *readline* を必要とします。こ
   の引数は呼び出し可能オブジェクトで、ファイルオブジェクトの
   "io.IOBase.readline()" メソッドと同じインタフェースを提供している必
   要があります。この関数は呼び出しのたびに入力の一行を bytes で返さな
   ければなりません。

   このジェネレータは次の5要素のタプルを返します; トークンタイプ; トー
   クン文字列; ソース内でそのトークンがどの行、列で開始するかを示す
   int の "(srow, scol)" タプル; どの行、列で終了するかを示す int の
   "(erow, ecol)" タプル; トークンが見つかった行。 (タプルの最後の要素
   にある) 行は *物理* 行です。この5要素のタプルは *named tuple* とし
   て返され、フィールド名は "type string start end line" になります。

   返される *named tuple* は追加のプロパティ "exact_type" を持ちます。
   このプロパティは "OP" トークンに対して正確な演算子のタイプを持ちま
   す。それ以外のトークンタイプについては、 "exact_type" は "type" フ
   ィールドと同じ値を持ちます。

   バージョン 3.1 で変更: named tuple のサポートを追加。

   バージョン 3.3 で変更: "exact_type" のサポートを追加。

   "tokenize()" は **PEP 263** にしたがって、ソースのエンコーディング
   を UTF-8 BOM か encoding cookie を見つけて決定します。

tokenize.generate_tokens(readline)

   Tokenize a source reading unicode strings instead of bytes.

   Like "tokenize()", the *readline* argument is a callable returning
   a single line of input. However, "generate_tokens()" expects
   *readline* to return a str object rather than bytes.

   The result is an iterator yielding named tuples, exactly like
   "tokenize()". It does not yield an "ENCODING" token.

"token" モジュールの全ての定数は "tokenize" モジュールからも公開されて
います。

もう一つの関数がトークン化プロセスを逆転するために提供されています。こ
れは、スクリプトを字句解析し、トークンのストリームに変更を加え、変更さ
れたスクリプトを書き戻すようなツールを作成する際に便利です。

tokenize.untokenize(iterable)

   トークンの列を Python ソースコードに変換します。 *iterable* は少な
   くとも二つの要素、トークンタイプおよびトークン文字列、からなるシー
   ケンスを返さなければいけません。 その他のシーケンスの要素は無視され
   ます。

   再構築されたスクリプトは一つの文字列として返されます。得られる結果
   はもう一度字句解析すると入力と一致することが保証されるので、変換が
   ロスレスでありラウンドトリップできることは間違いありません。この保
   証はトークン型およびトークン文字列に対してのものでトークン間のスペ
   ース (コラム位置)のようなものは変わることがあり得ます。

   It returns bytes, encoded using the "ENCODING" token, which is the
   first token sequence output by "tokenize()". If there is no
   encoding token in the input, it returns a str instead.

"tokenize()" はトークナイズしようとしているソースファイルのエンコーデ
ィングを検出する必要があります。これを行うために使っている関数が公開さ
れています:

tokenize.detect_encoding(readline)

   "detect_encoding()" 関数は Python のソースファイルをデコードするの
   に使うエンコーディングを検出するために使われます。 "tokenize()" ジ
   ェネレータと同じ readline を引数として取ります。

   readline を最大2回呼び出し、利用するエンコーディング (文字列として)
   と、読み込んだ行を (bytes からデコードされないままの状態で) 返しま
   す。

   UTF-8 BOM か **PEP 263** で定義されている encoding cookie からエン
   コーディングを検出します。BOMと cookie の両方が存在し、一致していな
   い場合、"SyntaxError" が送出されます。 BOM が見つかった場合はエンコ
   ーディングとして "'utf-8-sig'" が返されます。

   エンコーディングが指定されていない場合、デフォルトの "'utf-8'" が返
   されます。

   Python のソースファイルを開くには "open()" を使ってください。これは
   "detect_encoding()" を利用してファイルエンコーディングを検出します
   。

tokenize.open(filename)

   "detect_encoding()" を使って検出したエンコーディングを利用して、フ
   ァイルを読み出し専用モードで開きます。

   バージョン 3.2 で追加.

exception tokenize.TokenError

   docstring や複数行にわたることが許される式がファイル内のどこかで終
   わっていない場合に送出されます。例えば:

      """Beginning of
      docstring

   もしくは:

      [1,
       2,
       3

閉じていないシングルクォート文字列は送出されるべきエラーの原因とならな
いことに注意してください。それらは "ERRORTOKEN" とトークン化され、続い
てその内容がトークン化されます。


コマンドラインからの使用
========================

バージョン 3.3 で追加.

"tokenize" モジュールはコマンドラインからスクリプトとして実行すること
ができます。次のようにシンプルに利用できます:

   python -m tokenize [-e] [filename.py]

以下のオプションが使用できます:

-h, --help

   このヘルプメッセージを出力して終了します

-e, --exact

   exact type を使ってトークン名を表示します

"filename.py" が指定された場合、その内容がトークナイズされ stdout に出
力されます。指定されなかった場合は stdin からトークナイズします。


使用例
======

スクリプト書き換えの例で、浮動小数点数リテラルを Decimal オブジェクト
に変換します:

   from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
   from io import BytesIO

   def decistmt(s):
       """Substitute Decimals for floats in a string of statements.

       >>> from decimal import Decimal
       >>> s = 'print(+21.3e-5*-.1234/81.7)'
       >>> decistmt(s)
       "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"

       The format of the exponent is inherited from the platform C library.
       Known cases are "e-007" (Windows) and "e-07" (not Windows).  Since
       we're only showing 12 digits, and the 13th isn't close to 5, the
       rest of the output should be platform-independent.

       >>> exec(s)  #doctest: +ELLIPSIS
       -3.21716034272e-0...7

       Output from calculations with Decimal should be identical across all
       platforms.

       >>> exec(decistmt(s))
       -3.217160342717258261933904529E-7
       """
       result = []
       g = tokenize(BytesIO(s.encode('utf-8')).readline)  # tokenize the string
       for toknum, tokval, _, _, _ in g:
           if toknum == NUMBER and '.' in tokval:  # replace NUMBER tokens
               result.extend([
                   (NAME, 'Decimal'),
                   (OP, '('),
                   (STRING, repr(tokval)),
                   (OP, ')')
               ])
           else:
               result.append((toknum, tokval))
       return untokenize(result).decode('utf-8')

コマンドラインからトークナイズする例。次のスクリプトが:

   def say_hello():
       print("Hello, World!")

   say_hello()

トークナイズされて次のような出力になります。最初のカラムはトークンが現
れた行／カラム、次のカラムはトークンの名前、最後のカラムは (あれば) ト
ークンの値です

   $ python -m tokenize hello.py
   0,0-0,0:            ENCODING       'utf-8'
   1,0-1,3:            NAME           'def'
   1,4-1,13:           NAME           'say_hello'
   1,13-1,14:          OP             '('
   1,14-1,15:          OP             ')'
   1,15-1,16:          OP             ':'
   1,16-1,17:          NEWLINE        '\n'
   2,0-2,4:            INDENT         '    '
   2,4-2,9:            NAME           'print'
   2,9-2,10:           OP             '('
   2,10-2,25:          STRING         '"Hello, World!"'
   2,25-2,26:          OP             ')'
   2,26-2,27:          NEWLINE        '\n'
   3,0-3,1:            NL             '\n'
   4,0-4,0:            DEDENT         ''
   4,0-4,9:            NAME           'say_hello'
   4,9-4,10:           OP             '('
   4,10-4,11:          OP             ')'
   4,11-4,12:          NEWLINE        '\n'
   5,0-5,0:            ENDMARKER      ''

トークンの exact_type 名は "-e" オプションで表示できます:

   $ python -m tokenize -e hello.py
   0,0-0,0:            ENCODING       'utf-8'
   1,0-1,3:            NAME           'def'
   1,4-1,13:           NAME           'say_hello'
   1,13-1,14:          LPAR           '('
   1,14-1,15:          RPAR           ')'
   1,15-1,16:          COLON          ':'
   1,16-1,17:          NEWLINE        '\n'
   2,0-2,4:            INDENT         '    '
   2,4-2,9:            NAME           'print'
   2,9-2,10:           LPAR           '('
   2,10-2,25:          STRING         '"Hello, World!"'
   2,25-2,26:          RPAR           ')'
   2,26-2,27:          NEWLINE        '\n'
   3,0-3,1:            NL             '\n'
   4,0-4,0:            DEDENT         ''
   4,0-4,9:            NAME           'say_hello'
   4,9-4,10:           LPAR           '('
   4,10-4,11:          RPAR           ')'
   4,11-4,12:          NEWLINE        '\n'
   5,0-5,0:            ENDMARKER      ''

Example of tokenizing a file programmatically, reading unicode strings
instead of bytes with "generate_tokens()":

   import tokenize

   with tokenize.open('hello.py') as f:
       tokens = tokenize.generate_tokens(f.readline)
       for token in tokens:
           print(token)

Or reading bytes directly with "tokenize()":

   import tokenize

   with open('hello.py', 'rb') as f:
       tokens = tokenize.tokenize(f.readline)
       for token in tokens:
           print(token)
