web-dev-qa-db-ja.com

Pythonデコレータを使用して関数の引数をチェックする方法は？

いくつかの関数を呼び出す前に引数をチェックするために、いくつかの汎用デコレータを定義したいと思います。

何かのようなもの：

@checkArguments(types = ['int', 'float'])
def myFunction(thisVarIsAnInt, thisVarIsAFloat)
    ''' Here my code '''
    pass

サイドノート：

  1. 型チェックは例を示すためだけにここにあります
  2. 私はPython 2.7を使用していますが、Python 3.0
pythonpython-decorators
27
AsTeR

関数とメソッドの装飾 から：

def accepts(*types):
    def check_accepts(f):
        assert len(types) == f.func_code.co_argcount
        def new_f(*args, **kwds):
            for (a, t) in Zip(args, types):
                assert isinstance(a, t), \
                       "arg %r does not match %s" % (a,t)
            return f(*args, **kwds)
        new_f.func_name = f.func_name
        return new_f
    return check_accepts

使用法：

@accepts(int, (int,float))
def func(arg1, arg2):
    return arg1 * arg2

func(3, 2) # -> 6
func('3', 2) # -> AssertionError: arg '3' does not match <type 'int'>
29
jfs

Python 3.3では、関数の注釈を使用して検査できます。

import inspect

def validate(f):
    def wrapper(*args):
        fname = f.__name__
        fsig = inspect.signature(f)
        vars = ', '.join('{}={}'.format(*pair) for pair in Zip(fsig.parameters, args))
        params={k:v for k,v in Zip(fsig.parameters, args)}
        print('wrapped call to {}({})'.format(fname, params))
        for k, v in fsig.parameters.items():
            p=params[k]
            msg='call to {}({}): {} failed {})'.format(fname, vars, k, v.annotation.__name__)
            assert v.annotation(params[k]), msg
        ret = f(*args)
        print('  returning {} with annotation: "{}"'.format(ret, fsig.return_annotation))
        return ret
    return wrapper

@validate
def xXy(x: lambda _x: 10<_x<100, y: lambda _y: isinstance(_y,float)) -> ('x times y','in X and Y units'):
    return x*y

xy = xXy(10,3)
print(xy)

検証エラーがある場合は、次を出力します。

AssertionError: call to xXy(x=12, y=3): y failed <lambda>)

検証エラーがない場合は、次を出力します。

wrapped call to xXy({'y': 3.0, 'x': 12})
  returning 36.0 with annotation: "('x times y', 'in X and Y units')"

アサーションエラーで名前を取得するには、ラムダではなく関数を使用できます。

15
dawg

確かに知っているように、引数の型のみに基づいて引数を拒否するのはPythonicではありません。
Pythonのアプローチは、「最初に対処する」ことです。
だからデコレーターを使って引数を変換したい

def enforce(*types):
    def decorator(f):
        def new_f(*args, **kwds):
            #we need to convert args into something mutable   
            newargs = []        
            for (a, t) in Zip(args, types):
               newargs.append( t(a)) #feel free to have more elaborated convertion
            return f(*newargs, **kwds)
        return new_f
    return decorator

このように、関数には期待する型が与えられますが、パラメーターがフロートのように振れる場合は受け入れられます

@enforce(int, float)
def func(arg1, arg2):
    return arg1 * arg2

print (func(3, 2)) # -> 6.0
print (func('3', 2)) # -> 6.0
print (func('three', 2)) # -> ValueError: invalid literal for int() with base 10: 'three'

vectors を扱うために、このトリックを（適切な変換方法で）使用します。
多くの機能を備えているMyVectorクラスを期待しています。しかし、いつかあなたはただ書きたい

transpose ((2,4))
9
Madlozoz

非文字列入力が提供されたときに暗号化エラーをスローするパーサーに文字列引数を適用するために、割り当てと関数呼び出しを回避しようとする次のコードを書きました。

from functools import wraps

def argtype(**decls):
    """Decorator to check argument types.

    Usage:

    @argtype(name=str, text=str)
    def parse_rule(name, text): ...
    """

    def decorator(func):
        code = func.func_code
        fname = func.func_name
        names = code.co_varnames[:code.co_argcount]

        @wraps(func)
        def decorated(*args,**kwargs):
            for argname, argtype in decls.iteritems():
                try:
                    argval = args[names.index(argname)]
                except ValueError:
                    argval = kwargs.get(argname)
                if argval is None:
                    raise TypeError("%s(...): arg '%s' is null"
                                    % (fname, argname))
                if not isinstance(argval, argtype):
                    raise TypeError("%s(...): arg '%s': type is %s, must be %s"
                                    % (fname, argname, type(argval), argtype))
            return func(*args,**kwargs)
        return decorated

    return decorator
2
jbouwman

これらの投稿はすべて時代遅れのようです-パイントは現在、この機能を組み込みで提供しています。 here を参照してください。後世のためにここにコピーされました：

次元のチェックパイント数量を関数への入力として使用する場合、パイントは、ユニットが正しいタイプであることを確認するためのラッパーを提供します。より正確には、物理​​量の予想されるディメンションと一致します。

Wraps（）と同様に、Noneを渡して一部のパラメーターのチェックをスキップできますが、戻りパラメーターのタイプはチェックされません。

>>> mypp = ureg.check('[length]')(pendulum_period)

デコレータ形式で：

>>> @ureg.check('[length]')
... def pendulum_period(length):
...     return 2*math.pi*math.sqrt(length/G)
1
Ethan Keller
def decorator(function):
    def validation(*args):
        if type(args[0]) == int and \
        type(args[1]) == float:
            return function(*args)
        else:
            print('Not valid !')
    return validation
0
mujad

pythonデコレータモジュールを使用して、デコレータを完全に透明にし、署名だけでなくdocstringsも保持し、最もエレガントな使用方法になる可能性がある@jbouwmans sollutionのわずかに改善されたバージョンがあります。デコレータ

from decorator import decorator

def check_args(**decls):
    """Decorator to check argument types.

    Usage:

    @check_args(name=str, text=str)
    def parse_rule(name, text): ...
    """
    @decorator
    def wrapper(func, *args, **kwargs):
        code = func.func_code
        fname = func.func_name
        names = code.co_varnames[:code.co_argcount]
        for argname, argtype in decls.iteritems():
            try:
                argval = args[names.index(argname)]
            except IndexError:
                argval = kwargs.get(argname)
            if argval is None:
                raise TypeError("%s(...): arg '%s' is null"
                            % (fname, argname))
            if not isinstance(argval, argtype):
                raise TypeError("%s(...): arg '%s': type is %s, must be %s"
                            % (fname, argname, type(argval), argtype))
    return func(*args, **kwargs)
return wrapper
0
MaxFragg

Python 3.5この質問に対する答えは beartype です。これで説明されているように post 便利な機能が付属しています。こんな風に見える

from beartype import beartype
@beartype
def sprint(s: str) -> None:
   print(s)

そして結果

>>> sprint("s")
s
>>> sprint(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<string>", line 13, in func_beartyped
TypeError: sprint() parameter s=3 not of <class 'str'>
0
Iwan LD