Pythonのアットマーク演算子について

Pythonのアットマーク(@)は、デコレータと呼ばれる特殊な機能を表します。デコレータは、既存の関数やクラスに新たな機能を追加するための機能です。

アットマーク演算子とは

関数定義の先頭にアットマーク演算子(@)がついていることがあります。これはデコレータと呼ばれ、既存の編集できない関数に「機能を追加」する機能を持ちます。一般的な使用シーンとしては、ライブラリの関数に機能を追加したいシーンが挙げられます。

アットマーク演算子の使い方

デコレータは以下のように記述します。

@デコレータ名
def デコレートされる関数名:
    ・・・

デコレータは、関数を修飾するwrapperとも考えられます。

実際に書いてみよう

それでは実際に、デコレータを使ったコードを書いてみましょう。今回は “I am here” という文字列を返すget_message関数を作成し、デコレータで機能を追加してみましょう。追加する機能としては、シンプルにget_message関数の返す文字列 “I am here” を [] で囲ってみましょう。

# デコレータ
def bird(func):
    def wrap(*args, **kwargs):
        rslt = func(*args, **kwargs)
        rslt = '[' + rslt + ']' # 文字列をカッコで囲う
        return rslt
    return wrap

# デコレートされる関数
@bird
def get_message():
    return 'I am here'

print(get_message()) # 関数を実行し機能の追加を確認

実行結果は [I am here] となります。

この記事では、アットマーク演算子・デコレータを使って、関数に機能を追加する方法を紹介しました。使う場所は局所的かもしれませんが、知ってて損はない機能だと思います。「既存の編集不可能な関数やクラスに機能を追加する機能」とざっくり覚えておきましょう。