How can I find the number of arguments of a Python function?

by

The previously accepted answer has been deprecated as of Python 3.0. Instead of using inspect.getargspec you should now opt for the Signature class which superseded it.

Creating a Signature for the function is easy via the signature function:

from inspect import signature

def someMethod(self, arg1, kwarg1=None):
    pass

sig = signature(someMethod)

Now, you can either view its parameters quickly by string it:

str(sig)  # returns: '(self, arg1, kwarg1=None)'

or you can also get a mapping of attribute names to parameter objects via sig.parameters. 

params = sig.parameters 
print(params['kwarg1']) # prints: kwarg1=20

Additionally, you can call len on sig.parameters to also see the number of arguments this function requires:

print(len(params))  # 3

Each entry in the params mapping is actually a Parameter object that has further attributes making your life easier. For example, grabbing a parameter and viewing its default value is now easily performed with:

kwarg1 = params['kwarg1']
kwarg1.default # returns: None

similarly for the rest of the objects contained in parameters.

As for Python 2.x users, while inspect.getargspec isn’t deprecated, the language will soon be :-). The Signature class isn’t available in the 2.x series and won’t be. So you still need to work with inspect.getargspec.

As for transitioning between Python 2 and 3, if you have code that relies on the interface of getargspec in Python 2 and switching to signature in 3 is too difficult, you do have the valuable option of using inspect.getfullargspec. It offers a similar interface to getargspec (a single callable argument) in order to grab the arguments of a function while also handling some additional cases that getargspec doesn’t:

from inspect import getfullargspec

def someMethod(self, arg1, kwarg1=None):
    pass

args = getfullargspec(someMethod)

As with getargspec, getfullargspec returns a NamedTuple which contains the arguments.

print(args)
FullArgSpec(args=['self', 'arg1', 'kwarg1'], varargs=None, varkw=None, defaults=(None,), kwonlyargs=[], kwonlydefaults=None, annotations={})

More Related Contents:

  1. Python function define: A message will prompt up if missing entering an argument
  2. Function defined correctly?
  3. How can I return two values from a function in Python?
  4. Passing an integer by reference in Python
  5. Python function attributes – uses and abuses [closed]
  6. Ignore python multiple return value
  7. Call a function with argument list in python
  8. Best way to check function arguments? [closed]
  9. How to call function that takes an argument in a Django template?
  10. How are Python in-place operator functions different than the standard operator functions?
  11. Python: return the index of the first element of a list which makes a passed function true
  12. What does a semicolon do?
  13. Basic explanation of python functions
  14. python: how to get information about a function?
  15. Modifying function arguments
  16. How to Open a file through python
  17. In Python, when should I use a function instead of a method?
  18. Python decorator? – can someone please explain this? [duplicate]
  19. How to check whether optional function parameter is set
  20. Is there a function in python to split a word into a list? [duplicate]
  21. what is the difference between return and break in python?
  22. Callback function tkinter button with variable parameter [duplicate]
  23. Reverse a string without using reversed() or [::-1]?
  24. Why doesn’t an import in an exec in a function work?
  25. “unpacking” a passed dictionary into the function’s name space in Python?
  26. Returning tuple with a single item from a function
  27. Finding Combinations to the provided Sum value
  28. Use a string to call function in Python [duplicate]
  29. Are functions objects in Python?
  30. python pandas- apply function with two arguments to columns

Leave a Comment