How to use Python decorators to check function arguments?

by

From the Decorators for Functions and Methods:

Python 2

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

Python 3

In Python 3 func_code has changed to __code__ and func_name has changed to __name__.

def accepts(*types):
    def check_accepts(f):
        assert len(types) == f.__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.__name__ = f.__name__
        return new_f
    return check_accepts

Usage:

@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'>

arg2 can be either int or float

More Related Contents:

  1. Difference between @staticmethod and @classmethod
  2. How to make function decorators and chain them together?
  3. How does the @property decorator work in Python?
  4. What does the “at” (@) symbol do in Python?
  5. Class method decorator with self arguments?
  6. Decorating class methods – how to pass the instance to the decorator?
  7. How do I pass extra arguments to a Python decorator?
  8. How can I decorate an instance method with a decorator class?
  9. Decorator execution order
  10. Real world example about how to use property feature in python?
  11. How to inject variable into scope with a decorator?
  12. How do I make function decorators and chain them together?
  13. How to make function decorators and chain them together in Python?
  14. @classmethod vs @staticmethod in Python
  15. Python decorator? – can someone please explain this? [duplicate]
  16. How to do a conditional decorator in python?
  17. Python functools lru_cache with instance methods: release object
  18. How to create a custom decorator in Django?
  19. Make @lru_cache ignore some of the function arguments
  20. Decorator error: NoneType object is not callable
  21. How to count function calls using decorators?
  22. How to skip a pytest using an external fixture?
  23. Python decorator, self is mixed up [duplicate]
  24. How do I use getattr and setattr properly in Python? [closed]
  25. What is the maximum recursion depth in Python, and how to increase it?
  26. Count number of occurrences of a substring in a string
  27. Understanding string reversal via slicing
  28. Get total physical memory in Python
  29. How to get Python to gracefully format None and non-existing fields [duplicate]
  30. SQLAlchemy classes across files

Leave a Comment