exec を使ってコードを作成する

はじめに

この実験では、Python の exec() 関数について学びます。この関数を使用すると、文字列として表される Python コードを動的に実行することができます。これは強力な機能で、実行時にコードを生成して実行することができ、プログラムをより柔軟で適応性の高いものにします。

この実験の目的は、exec() 関数の基本的な使い方を学び、クラスメソッドを動的に作成するためにこの関数を使用し、Python の標準ライブラリが内部で exec() をどのように使用しているかを調べることです。

exec() の基本を理解する

Python では、exec() 関数は実行時に動的に作成されたコードを実行することができる強力なツールです。これは、特定の入力や設定に基づいてコードを即座に生成できることを意味し、多くのプログラミングシナリオで非常に有用です。

まずは、exec() 関数の基本的な使い方を探ってみましょう。これを行うには、Python シェルを開きます。ターミナルを開き、python3 と入力します。このコマンドにより、Python コードを直接実行できる対話型 Python インタープリターが起動します。

python3

ここで、Python コードの一部を文字列として定義し、exec() 関数を使ってそれを実行します。以下はその動作方法です。

>>> code = '''
for i in range(n):
    print(i, end=' ')
'''
>>> n = 10
>>> exec(code)
0 1 2 3 4 5 6 7 8 9

この例では：

まず、code という名前の文字列を定義しました。この文字列には Python の for ループが含まれています。このループは n 回繰り返され、各繰り返しの番号を出力するように設計されています。
次に、変数 n を定義し、値 10 を割り当てました。この変数は、ループ内の range() 関数の上限として使用されます。
その後、exec() 関数を呼び出し、引数として code 文字列を渡しました。exec() 関数はこの文字列を受け取り、それを Python コードとして実行します。
最後に、ループが実行され、0 から 9 までの数字が出力されました。

exec() 関数の本当の威力は、関数やメソッドなど、より複雑なコード構造を作成する際により明らかになります。クラスの __init__() メソッドを動的に作成する、より高度な例を試してみましょう。

>>> class Stock:
...     _fields = ('name', 'shares', 'price')
...
>>> argstr = ','.join(Stock._fields)
>>> code = f'def __init__(self, {argstr}):\n'
>>> for name in Stock._fields:
...     code += f'    self.{name} = {name}\n'
...
>>> print(code)
def __init__(self, name,shares,price):
    self.name = name
    self.shares = shares
    self.price = price

>>> locs = { }
>>> exec(code, locs)
>>> Stock.__init__ = locs['__init__']

>>> ## Now try the class
>>> s = Stock('GOOG', 100, 490.1)
>>> s.name
'GOOG'
>>> s.shares
100
>>> s.price
490.1

このより複雑な例では：

まず、_fields 属性を持つ Stock クラスを定義しました。この属性は、クラスの属性名を含むタプルです。
次に、__init__ メソッドの Python コードを表す文字列を作成しました。このメソッドは、オブジェクトの属性を初期化するために使用されます。
その後、exec() 関数を使ってコード文字列を実行しました。また、空の辞書 locs を exec() に渡しました。実行結果の関数はこの辞書に格納されます。
その後、辞書に格納された関数を Stock クラスの __init__ メソッドとして割り当てました。
最後に、Stock クラスのインスタンスを作成し、オブジェクトの属性にアクセスすることで __init__ メソッドが正しく動作することを確認しました。

この例は、exec() 関数が実行時に利用可能なデータに基づいてメソッドを動的に作成するためにどのように使用できるかを示しています。

動的な `init()` メソッドの作成

ここでは、exec() 関数について学んだことを実際のプログラミングシナリオに適用します。Python では、exec() 関数を使うと文字列に格納された Python コードを実行することができます。このステップでは、Structure クラスを修正して、__init__() メソッドを動的に作成します。__init__() メソッドは Python クラスの特殊なメソッドで、クラスのオブジェクトがインスタンス化されるときに呼び出されます。このメソッドの作成は、クラスのフィールド名のリストを含む _fields クラス変数に基づいて行います。

まず、既存の structure.py ファイルを見てみましょう。このファイルには、Structure クラスの現在の実装と、それを継承した Stock クラスが含まれています。ファイルの内容を表示するには、以下のコマンドを使用して WebIDE で開きます。

cat /home/labex/project/structure.py

出力を見ると、現在の実装ではオブジェクトの初期化を手動で行っていることがわかります。つまり、オブジェクトの属性を初期化するコードは明示的に書かれており、動的に生成されていません。

次に、Structure クラスを修正します。__init__() メソッドを動的に生成する create_init() クラスメソッドを追加します。これらの変更を行うには、WebIDE エディタで structure.py ファイルを開き、以下の手順に従います。

Structure クラスから既存の _init() と set_fields() メソッドを削除します。これらのメソッドは手動での初期化アプローチの一部であり、動的なアプローチを使用するため、もう必要ありません。
Structure クラスに create_init() クラスメソッドを追加します。以下はこのメソッドのコードです。

@classmethod
def create_init(cls):
    """Dynamically create an __init__ method based on _fields."""
    ## Create argument string from field names
    argstr = ','.join(cls._fields)

    ## Create the function code as a string
    code = f'def __init__(self, {argstr}):\n'
    for name in cls._fields:
        code += f'    self.{name} = {name}\n'

    ## Execute the code and get the generated function
    locs = {}
    exec(code, locs)

    ## Set the function as the __init__ method of the class
    setattr(cls, '__init__', locs['__init__'])

このメソッドでは、まずフィールド名をカンマで区切った文字列 argstr を作成します。この文字列は __init__() メソッドの引数リストとして使用されます。次に、__init__() メソッドのコードを文字列として作成します。フィールド名をループし、各引数を対応するオブジェクト属性に割り当てる行をコードに追加します。その後、exec() 関数を使ってコードを実行し、生成された関数を locs 辞書に格納します。最後に、setattr() 関数を使って生成された関数をクラスの __init__() メソッドとして設定します。

Stock クラスを修正して、この新しいアプローチを使用するようにします。

class Stock(Structure):
    _fields = ('name', 'shares', 'price')

## Create the __init__ method for Stock
Stock.create_init()

ここでは、Stock クラスの _fields を定義し、create_init() メソッドを呼び出して Stock クラスの __init__() メソッドを生成します。

完成した structure.py ファイルは次のようになります。

class Structure:
    ## Restrict attribute assignment
    def __setattr__(self, name, value):
        if name.startswith('_') or name in self._fields:
            super().__setattr__(name, value)
        else:
            raise AttributeError(f"No attribute {name}")

    ## String representation for debugging
    def __repr__(self):
        args = ', '.join(repr(getattr(self, name)) for name in self._fields)
        return f"{type(self).__name__}({args})"

    @classmethod
    def create_init(cls):
        """Dynamically create an __init__ method based on _fields."""
        ## Create argument string from field names
        argstr = ','.join(cls._fields)

        ## Create the function code as a string
        code = f'def __init__(self, {argstr}):\n'
        for name in cls._fields:
            code += f'    self.{name} = {name}\n'

        ## Execute the code and get the generated function
        locs = {}
        exec(code, locs)

        ## Set the function as the __init__ method of the class
        setattr(cls, '__init__', locs['__init__'])

class Stock(Structure):
    _fields = ('name', 'shares', 'price')

## Create the __init__ method for Stock
Stock.create_init()

では、実装が正しく動作することを確認するためにテストを行いましょう。ユニットテストファイルを実行して、すべてのテストがパスするかどうかを確認します。以下のコマンドを使用します。

cd /home/labex/project
python3 -m unittest test_structure.py

実装が正しければ、すべてのテストがパスするはずです。これは、動的に生成された __init__() メソッドが期待通りに動作していることを意味します。

また、Python シェルで手動でクラスをテストすることもできます。以下のようにします。

>>> from structure import Stock
>>> s = Stock('GOOG', 100, 490.1)
>>> s
Stock('GOOG', 100, 490.1)
>>> s.shares = 50
>>> s.share = 50  ## This should raise an AttributeError
Traceback (most recent call last):
  ...
AttributeError: No attribute share

Python シェルでは、まず structure.py ファイルから Stock クラスをインポートします。次に、Stock クラスのインスタンスを作成して表示します。オブジェクトの shares 属性を変更することもできます。ただし、_fields リストに存在しない属性を設定しようとすると、AttributeError が発生するはずです。

おめでとうございます！exec() 関数を使って、クラス属性に基づいて __init__() メソッドを動的に作成することに成功しました。このアプローチは、特に属性の数が可変のクラスを扱う場合に、コードをより柔軟で保守しやすくすることができます。

Python の標準ライブラリが `exec()` をどのように使用しているかを調べる

Python では、標準ライブラリは様々な便利な関数やモジュールを提供する、事前に書かれたコードの強力な集合体です。そのような関数の 1 つが exec() で、これは Python コードを動的に生成して実行するために使用できます。動的にコードを生成するとは、プログラムの実行中に即座にコードを作成することを意味し、ハードコードされたものではありません。

collections モジュールの namedtuple 関数は、標準ライブラリの中で exec() を使用する有名な例です。namedtuple は特殊なタプルで、属性名とインデックスの両方で要素にアクセスすることができます。完全なクラス定義を書かずに、単純なデータ保持クラスを作成するのに便利なツールです。

namedtuple がどのように動作し、内部で exec() をどのように使用しているかを調べてみましょう。まず、Python シェルを開きます。ターミナルで以下のコマンドを実行することで、Python コードを直接実行できる Python インタープリターを起動できます。

python3

では、namedtuple 関数の使い方を見てみましょう。以下のコードは、namedtuple を作成して要素にアクセスする方法を示しています。

>>> from collections import namedtuple
>>> Stock = namedtuple('Stock', ['name', 'shares', 'price'])
>>> s = Stock('GOOG', 100, 490.1)
>>> s.name
'GOOG'
>>> s.shares
100
>>> s[1]  ## namedtuples also support indexing
100

上記のコードでは、まず collections モジュールから namedtuple 関数をインポートしています。次に、name、shares、price というフィールドを持つ Stock という新しい namedtuple 型を作成しています。Stock namedtuple のインスタンス s を作成し、属性名 (s.name、s.shares) とインデックス (s[1]) の両方で要素にアクセスしています。

では、namedtuple がどのように実装されているかを見てみましょう。inspect モジュールを使ってそのソースコードを表示することができます。inspect モジュールは、モジュール、クラス、メソッドなどのライブオブジェクトに関する情報を取得するための便利な関数をいくつか提供しています。

>>> import inspect
>>> from collections import namedtuple
>>> print(inspect.getsource(namedtuple))

このコードを実行すると、大量のコードが出力されます。よく見ると、namedtuple は exec() 関数を使ってクラスを動的に作成していることがわかります。具体的には、クラス定義の Python コードを含む文字列を構築し、その文字列を Python コードとして exec() で実行しています。

このアプローチは非常に強力で、namedtuple が実行時にカスタムフィールド名を持つクラスを作成できるようにします。フィールド名は、namedtuple 関数に渡す引数によって決まります。これは、exec() が動的にコードを生成するためにどのように使用できるかの実際の例です。

namedtuple の実装に関するいくつかの重要なポイントを以下に示します。

クラス定義を構築するために文字列フォーマットを使用しています。文字列フォーマットは、文字列テンプレートに値を挿入する方法です。namedtuple の場合、正しいフィールド名を持つクラス定義を作成するためにこれを使用しています。
フィールド名の検証を行っています。つまり、提供されたフィールド名が有効な Python 識別子であるかどうかをチェックします。有効でない場合は、適切なエラーを発生させます。
ドキュメント文字列 (docstring) やメソッドなどの追加機能を提供しています。ドキュメント文字列は、クラスや関数の目的や使い方を文書化する文字列です。namedtuple は、作成するクラスに有用なドキュメント文字列やメソッドを追加します。
exec() を使用して生成されたコードを実行しています。これは、クラス定義を含む文字列を実際の Python クラスに変える核心的なステップです。

このパターンは、私たちが create_init() メソッドで実装したものと似ていますが、より洗練されたレベルです。namedtuple の実装では、より複雑なシナリオやエッジケースを処理して、堅牢で使いやすいインターフェースを提供する必要があります。

まとめ

この実験では、Python の exec() 関数を使って実行時にコードを動的に作成し実行する方法を学びました。重要なポイントとしては、文字列ベースのコード断片を実行するための exec() の基本的な使い方、属性に基づいてクラスメソッドを動的に作成するための高度な使い方、そして Python の標準ライブラリの namedtuple での実際のアプリケーションがあります。

コードを動的に生成する能力は、より柔軟で適応性の高いプログラムを可能にする強力な機能です。セキュリティや可読性の問題から注意して使用する必要がありますが、API の作成、デコレータの実装、またはドメイン固有言語の構築などの特定のシナリオでは、Python プログラマにとって貴重なツールです。実行時の条件に適応するコードを作成する際や、設定に基づいてコードを生成するフレームワークを構築する際に、これらの技術を適用することができます。

exec を使ってコードを作成する

はじめに

exec() の基本を理解する

動的な __init__() メソッドの作成

Python の標準ライブラリが exec() をどのように使用しているかを調べる

まとめ

動的な `init()` メソッドの作成

Python の標準ライブラリが `exec()` をどのように使用しているかを調べる