There is a new function parameter syntax / to indicate that some function parameters must be specified positionally and cannot be used as keyword arguments.[This is new in Python 3.8]
Documentation specifies some of the use cases/benefits of positional-only parameters.
It allows pure Python functions to fully emulate behaviors of
existing C coded functions. For example, the built-inpow()
function does not accept keyword arguments:def pow(x, y, z=None, /): "Emulate the built in pow() function" r = x ** y return r if z is None else r%zAnother use case is to preclude keyword arguments when the parameter
name is not helpful. For example, the builtinlen()function has
the signaturelen(obj, /). This precludes awkward calls such as:len(obj='hello') # The "obj" keyword argument impairs readabilityA further benefit of marking a parameter as positional-only is that
it allows the parameter name to be changed in the future without
risk of breaking client code. For example, in the statistics module,
the parameter name dist may be changed in the future. This was made
possible with the following function specification:def quantiles(dist, /, *, n=4, method='exclusive') ...
Where as * is used to force the caller to use named arguments. Django documentation contains a section which clearly explains a usecase of named arguments.
Form fields no longer accept optional arguments as positional
argumentsTo help prevent runtime errors due to incorrect ordering of
form field arguments, optional arguments of built-in form fields are
no longer accepted as positional arguments. For example:
forms.IntegerField(25, 10)raises an exception and should be replaced
with:
forms.IntegerField(max_value=25, min_value=10)
Suppose we have a method called func,
def func(self, param1, param2, /, param3, *, param4, param5):
print(param1, param2, param3, param4, param5)
It must called with
obj.func(10, 20, 30, param4=50, param5=60)
or
obj.func(10, 20, param3=30, param4=50, param5=60)
ie,
param1,param2must be specified positionally.param3can be called either with positional or keyword argument.param4andparam5must be called with keyword argument.
DEMO:
>>> class MyClass(object):
... def func(self, param1, param2, /, param3, *, param4, param5):
... return param1, param2, param3, param4, param5
...
>>> obj = MyClass()
>>>
>>> assert obj.func(10, 20, 30, param4=40, param5=50), obj.func(
... 10, 20, param3=30, param4=40, param5=50
... )