[Tutor] Python decorator to ensure that kwargs are correct
Manuel de la Pena
mandel at themacaque.com
Fri Sep 18 22:08:02 CEST 2009
Hello,
I have done a decorator that I used to ensure that the keyword arguments
passed to a constructor are the correct/expected ones. The code is the
following:
from functools import wraps
def keyargs_check(keywords):
"""
This decorator ensures that the keys passed in kwargs are the onces that
are specified in the passed tuple. When applied this decorate will
check the keywords and will throw an exception if the developer used
one that is not recognized.
@type keywords: tuple
@param keywords: A tuple with all the keywords recognized by the function.
"""
def wrap(f):
@wraps(f)
def newFunction(*args, **kw):
# we are going to add an extra check in kw
for current_key in kw.keys():
if not current_key in keywords:
raise ValueError(
"The key {0} is a not recognized parameters by {1}.".format(
current_key, f.__name__))
return f(*args, **kw)
return newFunction
return wrap
An example use of this decorator would be the following:
class Person(object):
@keyargs_check(("name", "surname", "age"))
def __init__(self, **kwargs):
# perform init according to args
Using the above code if the developer passes a key args like "blah" it
will throw an exception. Unfortunately my implementation has a major
problem with inheritance, if I define the following:
class PersonTest(Person):
@keyargs_check(("test"))
def __init__(self, **kwargs):
Person.__init__(self,**kwargs)
Because I'm passing kwargs to the super class init method, I'm going to
get an exception because "test" is not in the tuple passed to the
decorator of the super class. Is there a way to let the decorator used
in the super class to know about the extra keywords? or event better, is
there a standard way to achieve what I want?
Thanks in advance for any help or input,
kr,
Manuel
More information about the Tutor
mailing list