compile関数とは？

compile関数は、Pythonでソースコードをバイトコードに変換するための組み込み関数です。ソースコードは通常、人間が読める形式のテキスト（文字列）で記述されますが、Pythonインタプリタが実行する際には、これを内部的にバイトコードに変換して実行します。compile関数は、この変換プロセスを明示的に行うための関数です。 具体的には、compileを使うことで、文字列形式のコードや抽象構文木（AST）をバイトコードに変換し、その後にevalやexecで実行できる形に変換することができます。

使い方の構文

compile(source, filename, mode)
  • source: コンパイルしたいソースコード（文字列、ファイル、またはAST）。
  • filename: エラーメッセージで使用されるファイル名（コンパイル対象が文字列の場合も指定）。
  • mode: 実行モード。以下の3つから選べます。
    • 'exec'
      複数の文を含むコードブロックを実行します。
    • 'eval'
      式を評価します。
    • 'single'
      1つの文を実行し、結果を返します。

compile関数の基本的な使い方

evalモードで式を評価する

evalモードでは、1つの式をコンパイルして、その評価結果を得ることができます。

code = "2 + 3 * 4"
compiled_code = compile(code, '<string>', 'eval')
result = eval(compiled_code)
print(result)  # 出力: 14

この例では、文字列として与えた計算式をcompileしてバイトコードに変換し、それをevalで実行して結果を得ています。

execモードで複数の文を実行する

execモードでは、複数の文からなるコードを実行できます。関数の定義や制御構造など、Pythonの通常のプログラムと同様に記述されたコードを扱えます。

code = """
def greet():
    print("Hello, world!")
greet()
"""
compiled_code = compile(code, '<string>', 'exec')
exec(compiled_code)  # 出力: Hello, world!

この例では、greet()という関数を定義し、その関数を呼び出すコードをcompileしてexecで実行しています。

singleモードで1行のコードを実行する

singleモードは、1つの文を実行します。特に対話型シェルのような環境で、1行ずつコードを実行する際に役立ちます。

code = "print('Hello from single mode!')"
compiled_code = compile(code, '<string>', 'single')
exec(compiled_code)  # 出力: Hello from single mode!

この例では、singleモードで1行のコードを実行しています。

evalやexec関数との関係

compile関数自体はソースコードをバイトコードに変換するだけで、そのコードを直接実行するわけではありません。実際にコードを実行するには、evalやexec関数と組み合わせて使用します。

eval関数との組み合わせ

evalは、1つの式を評価してその結果を返す関数です。compileでコンパイルしたコードをevalで実行することで、動的にコードを評価することができます。

code = "3 + 5"
compiled_code = compile(code, '<string>', 'eval')
result = eval(compiled_code)
print(result)  # 出力: 8

exec関数との組み合わせ

execは、複数の文を含むコードを実行するための関数です。compileでバイトコードに変換したコードをexecで実行することで、関数定義や制御構造を含む複雑なコードも処理できます。

code = """
x = 10
y = 20
print(x + y)
"""
compiled_code = compile(code, '<string>', 'exec')
exec(compiled_code)  # 出力: 30

このように、compileはevalやexecと組み合わせることで、コードの評価や実行が行われます。

compile関数の応用例

ファイルからソースコードをコンパイルして実行

compile関数を使うことで、ファイル内のソースコードを読み込み、動的に実行することが可能です。

# example.py というファイルを読み込んで実行
with open('example.py', 'r') as f:
    code = f.read()
compiled_code = compile(code, 'example.py', 'exec')
exec(compiled_code)

この例では、example.pyというファイルからコードを読み込み、それをコンパイルして実行しています。

動的コードの安全な実行

動的に生成したコードを実行する際、直接execやevalを使うのはセキュリティ上のリスクがありますが、compileを使って一度コードをバイトコードに変換することで、事前にコードをチェックしたり、エラーメッセージを提供する際に役立ちます。

user_input = "print('User generated code')"
try:
    compiled_code = compile(user_input, '<user-input>', 'exec')
    exec(compiled_code)
except Exception as e:
    print(f"エラー: {e}")

このように、ユーザーからの入力をコンパイルする際には、エラーを事前にキャッチする仕組みを用意しておくことが重要です。

抽象構文木（AST）を使ったコンパイル

compile関数は、Pythonの抽象構文木（AST）からもコードをコンパイルできます。ASTは、Pythonのソースコードを解析し、構造を表現するために使用されるデータ形式です。

import ast
# `Python`コードをASTにパース
source = "x = 10 + 20"
tree = ast.parse(source)
# ASTからバイトコードにコンパイルして実行
compiled_code = compile(tree, '<string>', 'exec')
exec(compiled_code)
print(x)  # 出力: 30

この例では、ast.parseでコードをASTに変換し、そのASTをcompileでコンパイルして実行しています。

compile関数の使用上の注意点

  • セキュリティリスク: ユーザーからの入力を直接compileでコンパイルして 実行する場合、セキュリティ上のリスクがあります。未検証のコードを実行するのは避けるか、適切なフィルタリングとエラーハンドリングを行う必要があります。
  • 実行環境の制御: compile関数で生成したバイトコードはexecやevalで実行されますが、実行される環境（変数のスコープなど）を適切に制御することが重要です。

まとめ

Pythonのcompile関数は、文字列やAST形式のソースコードをバイトコードに変換するための非常に強力なツールです。このバイトコードをevalやexec関数で実行することで、動的にコードを実行したり、ユーザー入力に基づくコードの実行が可能になります。また、セキュリティやエラーチェックのためにも事前にコードをコンパイルすることで、コードの正確性を確保することができます。 compile関数を活用して、動的コード実行や高度なスクリプト処理を効率的に行いましょう。

参照:

compile関数 - `Python`公式ドキュメント