ホームページ バックエンド開発 Python チュートリアル パラメータを備えた完全に型指定された Python デコレータ

パラメータを備えた完全に型指定された Python デコレータ

Apr 13, 2023 pm 05:58 PM
python デコレータ

パラメータを備えた完全に型指定された Python デコレータ

この短い記事に示されているコードは、契約によって設計された私の小さなオープンソース プロジェクトから抜粋されたもので、型付きデコレーターを提供します。デコレータは非常に便利な概念であり、オンラインで多くの情報を見つけることができます。簡単に言えば、装飾された関数が呼び出されるたびに (前後に) コードを実行できるようになります。このようにして、関数のパラメーターや戻り値の変更、実行時間の測定、ログの追加、実行時の型チェックの実行などを行うことができます。デコレータはクラス用に作成することもでき、別のメタプログラミング アプローチ (attrs パッケージで行われるような) を提供することもできることに注意してください。

最も単純な形式では、デコレータ定義は次のコードのようになります。

def my_first_decorator(func):
 def wrapped(*args, **kwargs):
 # do something before
 result = func(*args, **kwargs)
 # do something after
 return result
 return wrapped
@my_first_decorator
def func(a):
 return a
ログイン後にコピー

上記のコードは、ラップされた入れ子関数が定義されると、その関数がどこかで使用されている限り、周囲の変数に関数内でアクセスしてメモリに保存できるためです (関数型プログラミング言語ではこれをクロージャと呼びます)。 )。

シンプルですが、これにはいくつかの欠点があります。最大の問題は、装飾された関数が以前の関数名 (inspect.signature で確認できます)、ドキュメント文字列、さらにはその名前さえも失うことです。これらはソース コード ドキュメント ツール (sphinx など) の問題ですが、場合によっては、これは、標準ライブラリの functools.wraps デコレータを使用すると簡単に解決できます。

from functools import wraps
from typing import Any, Callable, TypeVar, ParamSpec
P = ParamSpec("P") # 需要python >= 3.10
R = TypeVar("R")
def my_second_decorator(func: Callable[P, R]) -> Callable[P, R]:
 @wraps(func)
 def wrapped(*args: Any, **kwargs: Any) -> R:
 # do something before
 result = func(*args, **kwargs)
 # do something after
 return result
 return wrapped
@my_second_decorator
def func2(a: int) -> int:
 """Does nothing"""
 return a
print(func2.__name__)
# 'func2'
print(func2.__doc__)
# 'Does nothing'
ログイン後にコピー

この例では、型アノテーションを追加しました。アノテーションと型ヒントは Python に対して行われます。追加。可読性の向上、IDE でのコード補完、大規模なコード ベースの保守性はほんの一例です。上記のコードはほとんどのユースケースをすでにカバーしているはずですが、デコレータをパラメータ化することはできません。関数の実行時間を、一定の秒数を超えた場合にのみ記録するデコレータを作成することを検討してください。この数値は、装飾された関数ごとに個別に構成できる必要があります。指定しない場合は、デフォルト値を使用し、使いやすくするためにデコレーターを括弧なしで使用する必要があります。

@time(threshold=2)
def func1(a):
...
# No paranthesis when using default threshold
@time
def func2(b):
...
ログイン後にコピー

2 番目のケースで括弧を使用できる場合、または指定しないでください。パラメータのデフォルト値がまったくない場合は、このレシピで十分です:

from functools import wraps
from typing import Any, Callable, TypeVar, ParamSpec
P = ParamSpec("P") # 需要python >= 3.10
R = TypeVar("R")
def my_third_decorator(threshold: int = 1) -> Callable[[Callable[P, R]], Callable[P, R]]:
 def decorator(func: Callable[P, R]) -> Callable[P, R]:
 @wraps(func)
 def wrapper(*args: Any, **kwargs: Any) -> R:
 # do something before you can use `threshold`
 result = func(*args, **kwargs)
 # do something after
 return result
 return wrapper
 return decorator
@my_third_decorator(threshold=2)
def func3a(a: int) -> None:
...
# works
@my_third_decorator()
def func3b(a: int) -> None:
...
# Does not work!
@my_third_decorator
def func3c(a: int) -> None:
...
ログイン後にコピー

3 番目のケースをカバーするには、使用可能な Select パラメータを追加するだけでなく、実際にはそれ以上のことを実行できるパッケージ、つまりラップとデコレータがあります。品質は非常に高いですが、かなりの複雑さが追加されます。 Wrapt で装飾された関数を使用すると、リモート クラスターで関数を実行するときにシリアル化の問題がさらに発生しました。私の知る限り、どちらも完全に型指定されていないため、静的型チェッカー/リンター (mypy など) は厳密モードでは失敗します。

私が独自のパッケージに取り組み、独自のソリューションを作成することにしたとき、これらの問題を解決する必要がありました。再利用はしやすいがライブラリ化が難しいパターンとなります。

標準ライブラリのオーバーロードされたデコレータを使用します。このようにして、同じデコレータをパラメータのないデコレータで使用するように指定できます。それ以外は、上記の 2 つのスニペットを組み合わせたものです。このアプローチの欠点の 1 つは、すべてのパラメーターをキーワード引数として指定する必要があることです (これにより、最終的に読みやすさが向上します)

from typing import Callable, TypeVar, ParamSpec
from functools import partial, wraps
P = ParamSpec("P") # requires python >= 3.10
R = TypeVar("R
@overload
def typed_decorator(func: Callable[P, R]) -> Callable[P, R]:
...
@overload
def typed_decorator(*, first: str = "x", second: bool = True) -> Callable[[Callable[P, R]], Callable[P, R]]:
...
def typed_decorator(
 func: Optional[Callable[P, R]] = None, *, first: str = "x", second: bool = True
) -> Union[Callable[[Callable[P, R]], Callable[P, R]], Callable[P, R]]:
 """
Describe what the decorator is supposed to do!
Parameters
----------
first : str, optional
First argument, by default "x".
This is a keyword-only argument!
second : bool, optional
Second argument, by default True.
This is a keyword-only argument!
"""
 def wrapper(func: Callable[P, R], *args: Any, **kw: Any) -> R:
 """The actual logic"""
 # Do something with first and second and produce a `result` of type `R`
 return result
 # Without arguments `func` is passed directly to the decorator
 if func is not None:
 if not callable(func):
 raise TypeError("Not a callable. Did you use a non-keyword argument?")
 return wraps(func)(partial(wrapper, func))
 # With arguments, we need to return a function that accepts the function
 def decorator(func: Callable[P, R]) -> Callable[P, R]:
 return wraps(func)(partial(wrapper, func))
 return decorator
ログイン後にコピー

後で、パラメーターのデコレーターなしで個別に使用できるようになります。

@typed_decorator
def spam(a: int) -> int:
 return a
@typed_decorator(first = "y
def eggs(a: int) -> int:
 return a
ログイン後にコピー
このパターンには確かにある程度のオーバーヘッドがありますが、メリットはコストを上回ります。

原文:

https://www.php.cn/link/d0f82e1046ccbd597c7f2a7bfba9e7dd

以上がパラメータを備えた完全に型指定された Python デコレータの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

ホットAIツール

Undresser.AI Undress

Undresser.AI Undress

リアルなヌード写真を作成する AI 搭載アプリ

AI Clothes Remover

AI Clothes Remover

写真から衣服を削除するオンライン AI ツール。

Undress AI Tool

Undress AI Tool

脱衣画像を無料で

Clothoff.io

Clothoff.io

AI衣類リムーバー

AI Hentai Generator

AI Hentai Generator

AIヘンタイを無料で生成します。

ホットツール

メモ帳++7.3.1

メモ帳++7.3.1

使いやすく無料のコードエディター

SublimeText3 中国語版

SublimeText3 中国語版

中国語版、とても使いやすい

ゼンドスタジオ 13.0.1

ゼンドスタジオ 13.0.1

強力な PHP 統合開発環境

ドリームウィーバー CS6

ドリームウィーバー CS6

ビジュアル Web 開発ツール

SublimeText3 Mac版

SublimeText3 Mac版

神レベルのコード編集ソフト(SublimeText3)

ランプアーキテクチャの下でnode.jsまたはPythonサービスを効率的に統合する方法は? ランプアーキテクチャの下でnode.jsまたはPythonサービスを効率的に統合する方法は? Apr 01, 2025 pm 02:48 PM

多くのウェブサイト開発者は、ランプアーキテクチャの下でnode.jsまたはPythonサービスを統合する問題に直面しています:既存のランプ(Linux Apache MySQL PHP)アーキテクチャWebサイトのニーズ...

Scapy Crawlerを使用するときにパイプラインの永続的なストレージファイルを書き込めない理由は何ですか? Scapy Crawlerを使用するときにパイプラインの永続的なストレージファイルを書き込めない理由は何ですか? Apr 01, 2025 pm 04:03 PM

Scapy Crawlerを使用する場合、パイプラインの永続的なストレージファイルを書くことができない理由は?ディスカッションデータクローラーにScapy Crawlerを使用することを学ぶとき、あなたはしばしば...

Pythonクロスプラットフォームデスクトップアプリケーション開発:どのGUIライブラリが最適ですか? Pythonクロスプラットフォームデスクトップアプリケーション開発:どのGUIライブラリが最適ですか? Apr 01, 2025 pm 05:24 PM

Pythonクロスプラットフォームデスクトップアプリケーション開発ライブラリの選択多くのPython開発者は、WindowsシステムとLinuxシステムの両方で実行できるデスクトップアプリケーションを開発したいと考えています...

PythonプロセスプールがTCPリクエストを同時に処理し、クライアントが立ち往生する理由は何ですか? PythonプロセスプールがTCPリクエストを同時に処理し、クライアントが立ち往生する理由は何ですか? Apr 01, 2025 pm 04:09 PM

Python Process Poolは、クライアントが立ち往生する原因となる同時TCP要求を処理します。ネットワークプログラミングにPythonを使用する場合、同時のTCP要求を効率的に処理することが重要です。 ...

Python functools.partialオブジェクトによって内部的にカプセル化された元の関数を表示する方法は? Python functools.partialオブジェクトによって内部的にカプセル化された元の関数を表示する方法は? Apr 01, 2025 pm 04:15 PM

python functools.partialオブジェクトのpython functools.partialを使用してPythonを使用する視聴方法を深く探索します。

Python hourglassグラフ図面:可変未定義エラーを避ける方法は? Python hourglassグラフ図面:可変未定義エラーを避ける方法は? Apr 01, 2025 pm 06:27 PM

Python:Hourglassグラフィック図面と入力検証この記事では、Python NoviceがHourglass Graphic Drawingプログラムで遭遇する可変定義の問題を解決します。コード...

Pythonの高解像度画像の処理を最適化して、正確な白い円形領域を見つける方法は? Pythonの高解像度画像の処理を最適化して、正確な白い円形領域を見つける方法は? Apr 01, 2025 pm 06:12 PM

白い領域を見つけるためにPythonで高解像度の画像を処理する方法は? 9000x7000ピクセルの高解像度画像の処理、2つの写真を正確に見つける方法...

Pythonで大規模な製品データセットを効率的にカウントしてソートするにはどうすればよいですか? Pythonで大規模な製品データセットを効率的にカウントしてソートするにはどうすればよいですか? Apr 01, 2025 pm 08:03 PM

データの変換と統計:大規模なデータセットの効率的な処理この記事では、製品情報を含むデータリストを別の含有しているものに変換する方法を詳細に紹介します...

See all articles