はじめに
この実験（Lab）では、Python におけるデコレータ（decorators）について包括的に理解を深めます。デコレータは、関数やメソッドを修正または拡張するための強力な機能です。まず、デコレータの基本的な概念を紹介し、実践的な例を通じてその基本的な使い方を探ります。
この基礎の上に立ち、デコレートされた関数の重要なメタデータ（metadata）を保持するために functools.wraps を効果的に使用する方法を学びます。次に、属性アクセスを管理する上での役割を理解するために、property デコレータのような特定のデコレータについて掘り下げます。最後に、インスタンスメソッド、クラスメソッド、および静的メソッド（static methods）の違いを明確にし、クラス内でのメソッドの動作を制御するために、これらのコンテキストでデコレータがどのように使用されるかを示します。
基本的なデコレータの理解
このステップでは、デコレータの概念とその基本的な使い方を紹介します。デコレータとは、別の関数を引数として受け取り、何らかの機能を追加して別の関数を返す関数であり、元の関数のソースコードを変更することなくこれを行います。
まず、WebIDE の左側にあるファイルエクスプローラーでファイル decorator_basics.py を見つけます。ダブルクリックして開いてください。このファイルに最初のデコレータを記述します。
以下のコードを decorator_basics.py にコピー＆ペーストしてください。
import datetime
def log_activity(func):
"""A simple decorator to log function calls."""
def wrapper(*args, **kwargs):
print(f"Calling function '{func.__name__}' at {datetime.datetime.now()}")
result = func(*args, **kwargs)
print(f"Function '{func.__name__}' finished.")
return result
return wrapper
@log_activity
def greet(name):
"""A simple function to greet someone."""
print(f"Hello, {name}!")
## Call the decorated function
greet("Alice")
## Let's inspect the function's metadata
print(f"\nFunction name: {greet.__name__}")
print(f"Function docstring: {greet.__doc__}")
このコードを詳しく見てみましょう。
- 関数
funcを引数として受け取るデコレータ関数log_activityを定義します。 log_activityの内部で、ネストされた関数wrapperを定義します。この関数が新しい振る舞いを保持します。ログメッセージを出力し、元の関数funcを呼び出し、その後別のログメッセージを出力します。log_activity関数はwrapper関数を返します。greet関数の上にある@log_activity構文は、greet = log_activity(greet)のショートカットです。これにより、デコレータがgreet関数に適用されます。
次に、ファイルを保存します（Ctrl+S または Cmd+S を使用できます）。スクリプトを実行するには、WebIDE の下部にある統合ターミナルを開き、次のコマンドを実行します。
python ~/project/decorator_basics.py
以下のような出力が表示されます。日時は実行ごとに異なります。
Calling function 'greet' at 2023-10-27 10:30:00.123456
Hello, Alice!
Function 'greet' finished.
Function name: wrapper
Function docstring: None
出力には 2 つの点に注目してください。第一に、greet 関数がログメッセージでラップされていることです。第二に、関数の名前と docstring が wrapper 関数のものに置き換わってしまっていることです。これはデバッグやイントロスペクション（introspection）において問題となる可能性があります。次のステップでは、これを修正する方法を学びます。
functools.wraps を使用した関数メタデータの保持
前のステップでは、関数をデコレートすると、その元のメタデータ（__name__ や __doc__ など）がラッパー関数のメタデータに置き換えられてしまうことを確認しました。Python の functools モジュールは、これに対する解決策である wraps デコレータを提供します。
wraps デコレータは、独自のデコレータ内で使用され、元の関数からラッパー関数へメタデータをコピーするために利用されます。
decorator_basics.py のコードを変更しましょう。WebIDE でファイルを開き、functools.wraps を使用するように更新してください。
import datetime
from functools import wraps
def log_activity(func):
"""A simple decorator to log function calls."""
@wraps(func)
def wrapper(*args, **kwargs):
print(f"Calling function '{func.__name__}' at {datetime.datetime.now()}")
result = func(*args, **kwargs)
print(f"Function '{func.__name__}' finished.")
return result
return wrapper
@log_activity
def greet(name):
"""A simple function to greet someone."""
print(f"Hello, {name}!")
## Call the decorated function
greet("Alice")
## Let's inspect the function's metadata again
print(f"\nFunction name: {greet.__name__}")
print(f"Function docstring: {greet.__doc__}")
変更点は以下の通りです。
functoolsモジュールからwrapsをインポートしました。wrapper関数の定義の直上に@wraps(func)を追加しました。
ファイルを保存し、ターミナルから再度実行します。
python ~/project/decorator_basics.py
今度は、出力が異なります。
Calling function 'greet' at 2023-10-27 10:35:00.543210
Hello, Alice!
Function 'greet' finished.
Function name: greet
Function docstring: A simple function to greet someone.
ご覧のとおり、関数名は正しく greet として報告され、元の docstring も保持されています。functools.wraps を使用することは、デコレータをより堅牢でプロフェッショナルにするためのベストプラクティスです。
@property を使用した管理対象属性の実装
Python にはいくつかの組み込みデコレータがあります。最も有用なものの一つが @property であり、これによりクラスのメソッドを「管理対象属性（managed attribute）」に変換できます。これは、ユーザーがクラスと対話する方法を変更することなく、属性アクセスに検証や計算などのロジックを追加するのに理想的です。
これを Circle クラスを作成することで探求してみましょう。ファイルエクスプローラーからファイル property_decorator.py を開いてください。
以下のコードを property_decorator.py にコピー＆ペーストしてください。
import math
class Circle:
def __init__(self, radius):
## The actual value is stored in a "private" attribute
self._radius = radius
@property
def radius(self):
"""The radius property."""
print("Getting radius...")
return self._radius
@radius.setter
def radius(self, value):
"""The radius setter with validation."""
print(f"Setting radius to {value}...")
if value < 0:
raise ValueError("Radius cannot be negative")
self._radius = value
@property
def area(self):
"""A read-only computed property for the area."""
print("Calculating area...")
return math.pi * self._radius ** 2
## --- Let's test our Circle class ---
c = Circle(5)
## Access the radius like a normal attribute (triggers the getter)
print(f"Initial radius: {c.radius}\n")
## Change the radius (triggers the setter)
c.radius = 10
print(f"New radius: {c.radius}\n")
## Access the computed area property
print(f"Circle area: {c.area:.2f}\n")
## Try to set an invalid radius (triggers the setter's validation)
try:
c.radius = -2
except ValueError as e:
print(f"Error: {e}")
このコードでは：
radiusメソッド上の@propertyは「ゲッター（getter）」を定義します。これはc.radiusにアクセスしたときに呼び出されます。@radius.setterはradius属性の「セッター（setter）」を定義します。これはc.radius = 10のように値を代入したときに呼び出されます。ここでは、負の値が入るのを防ぐための検証を追加しています。areaメソッドも@propertyを使用していますが、セッターがないため、読み取り専用属性となります。その値はアクセスされるたびに計算されます。
ファイルを保存し、ターミナルから実行します。
python ~/project/property_decorator.py
ゲッター、セッター、および検証ロジックが自動的に呼び出されていることを示す、以下の出力が表示されるはずです。
Getting radius...
Initial radius: 5
Setting radius to 10...
Getting radius...
New radius: 10
Calculating area...
Circle area: 314.16
Setting radius to -2...
Error: Radius cannot be negative
インスタンスメソッド、クラスメソッド、スタティックメソッドの区別
Python クラスにおいて、メソッドはインスタンスにバインドされるか、クラスにバインドされるか、あるいはどちらにもバインドされないかのいずれかになります。これらの異なるメソッドタイプを定義するためにデコレータが使用されます。
- インスタンスメソッド: デフォルトのタイプです。最初の引数としてインスタンスを受け取ります（慣習的に
selfと呼ばれます）。インスタンス固有のデータに対して動作します。 - クラスメソッド:
@classmethodでマークされます。最初の引数としてクラスを受け取ります（慣習的にclsと呼ばれます）。クラスレベルのデータに対して動作し、代替コンストラクタとして使用されることがよくあります。 - スタティックメソッド:
@staticmethodでマークされます。特別な最初の引数を受け取りません。これらは本質的にクラス内に名前空間が設定された通常の関数であり、インスタンス状態やクラス状態にアクセスすることはできません。
これら 3 つすべてがどのように機能するかを見てみましょう。ファイルエクスプローラーからファイル class_methods.py を開いてください。
以下のコードを class_methods.py にコピー＆ペーストしてください。
class MyClass:
class_variable = "I am a class variable"
def __init__(self, instance_variable):
self.instance_variable = instance_variable
## 1. Instance Method
def instance_method(self):
print("\n--- Calling Instance Method ---")
print(f"Can access instance data: self.instance_variable = '{self.instance_variable}'")
print(f"Can access class data: self.class_variable = '{self.class_variable}'")
## 2. Class Method
@classmethod
def class_method(cls):
print("\n--- Calling Class Method ---")
print(f"Can access class data: cls.class_variable = '{cls.class_variable}'")
## Note: Cannot access instance_variable without an instance
print("Cannot access instance data directly.")
## 3. Static Method
@staticmethod
def static_method(a, b):
print("\n--- Calling Static Method ---")
print("Cannot access instance or class data directly.")
print(f"Just a utility function: {a} + {b} = {a + b}")
## --- Let's test the methods ---
## Create an instance of the class
my_instance = MyClass("I am an instance variable")
## Call the instance method (requires an instance)
my_instance.instance_method()
## Call the class method (can be called on the class or an instance)
MyClass.class_method()
my_instance.class_method() ## Also works
## Call the static method (can be called on the class or an instance)
MyClass.static_method(10, 5)
my_instance.static_method(20, 8) ## Also works
ファイルを保存し、ターミナルから実行します。
python ~/project/class_methods.py
出力を注意深く確認してください。各メソッドタイプの機能と制限が明確に示されています。
--- Calling Instance Method ---
Can access instance data: self.instance_variable = 'I am an instance variable'
Can access class data: self.class_variable = 'I am a class variable'
--- Calling Class Method ---
Can access class data: cls.class_variable = 'I am a class variable'
Cannot access instance data directly.
--- Calling Class Method ---
Can access class data: cls.class_variable = 'I am a class variable'
Cannot access instance data directly.
--- Calling Static Method ---
Cannot access instance or class data directly.
Just a utility function: 10 + 5 = 15
--- Calling Static Method ---
Cannot access instance or class data directly.
Just a utility function: 20 + 8 = 28
この例は、インスタンス状態、クラス状態、またはそのいずれも必要とするかどうかに基づいて、各タイプのメソッドを使用すべき場合の明確な参照を提供します。
まとめ
この「実験（Lab）」では、Python におけるデコレータについて実践的な理解を得ました。まず、基本的なデコレータを作成し適用して、関数の機能を追加する方法を学びました。次に、クリーンで保守性の高いデコレータを作成するための重要なベストプラクティスとして、functools.wraps を使用して元の関数のメタデータ（metadata）を保持することの重要性を確認しました。
さらに、強力な組み込みデコレータを探求しました。@property デコレータを使用してカスタムのゲッター（getter）とセッター（setter）ロジックを持つ管理対象属性を作成する方法を学び、入力検証（validation）などの機能を有効にしました。最後に、インスタンスメソッド、クラスメソッド（@classmethod）、およびスタティックメソッド（@staticmethod）を区別し、それぞれがインスタンス状態とクラス状態へのアクセスに基づいてクラス構造内で異なる目的を果たすことを理解しました。
