Forced naming of parameters in Python

by

In Python 3 – Yes, you can specify * in the argument list.

From docs:

Parameters after “*” or “*identifier” are keyword-only parameters and
may only be passed used keyword arguments.

>>> def foo(pos, *, forcenamed):
...   print(pos, forcenamed)
... 
>>> foo(pos=10, forcenamed=20)
10 20
>>> foo(10, forcenamed=20)
10 20
>>> foo(10, 20)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() takes exactly 1 positional argument (2 given)

This can also be combined with **kwargs:

def foo(pos, *, forcenamed, **kwargs):

To complete example:

def foo(pos, *, forcenamed ):
    print(pos, forcenamed)

foo(pos=10, forcenamed=20)
foo(10, forcenamed=20)
# basically you always have to give the value!
foo(10)

output:

Traceback (most recent call last):
  File "/Users/brando/anaconda3/envs/metalearning/lib/python3.9/site-packages/IPython/core/interactiveshell.py", line 3444, in run_code
    exec(code_obj, self.user_global_ns, self.user_ns)
  File "<ipython-input-12-ab74191b3e9e>", line 7, in <module>
    foo(10)
TypeError: foo() missing 1 required keyword-only argument: 'forcenamed'

So you are forced to always give the value. If you don’t call it you don’t have to do anything else named argument forced.

More Related Contents:

  1. How can we force naming of parameters when calling a function?
  2. In Python, when should I use a function instead of a method?
  3. How function is getting called without defining in python [closed]
  4. How to call functions in python
  5. Passing an integer by reference in Python
  6. Run function from the command line
  7. Is there a math nCr function in python? [duplicate]
  8. Styling multi-line conditions in ‘if’ statements? [closed]
  9. Call a function with argument list in python
  10. Best way to check function arguments? [closed]
  11. How are Python in-place operator functions different than the standard operator functions?
  12. Builtin function not working with Spyder
  13. How do Python functions handle the types of parameters that you pass in?
  14. How do I define a function with optional arguments?
  15. How to break a line of chained methods in Python?
  16. Is it possible to run function in a subprocess without threading or writing a separate file/script.
  17. Run PowerShell function from Python script
  18. Set function signature in Python
  19. python close file descriptor question
  20. Alternatives for returning multiple values from a Python function [closed]
  21. How can I use `return` to get back multiple values from a loop? Can I put them in a list?
  22. What do the * (star) and ** (double star) operators mean in a function call?
  23. Python Turtle.Terminator even after using exitonclick()
  24. Tkinter PIL image not displaying inside of a function
  25. Passing variables, creating instances, self, The mechanics and usage of classes: need explanation [closed]
  26. Returning multiple values from pandas apply on a DataFrame
  27. Is making in-place operations return the object a bad idea?
  28. Python: Name resolution; order of function def’s
  29. In Python, what determines the order while iterating through kwargs?
  30. Do python’s variable length arguments (*args) expand a generator at function call time?

Leave a Comment