CODEWITHSUNDEEP
pythonfunctiondefault-valuearguments
Ryan C. Thompson
Ryan C. Thompson

Reputation: 42090

In Python, can I specify a function argument's default in terms of other arguments?

Suppose I have a python function that takes two arguments, but I want the second arg to be optional, with the default being whatever was passed as the first argument. So, I want to do something like this:

def myfunc(arg1, arg2=arg1):
    print (arg1, arg2)

Except that doesn't work. The only workaround I can think of is this:

def myfunc(arg1, arg2=None):
    if arg2 is None:
        arg2 = arg1
    print (arg1, arg2)

Is there a better way to do this?

Upvotes: 44

Views: 19554

Answers (4)

Faelin
Faelin

Reputation: 79

In addition to the working example you included, this can also be done using **kwargs:

def myfunc(arg1, **kwargs):
    arg2 = kwargs.get('arg2', arg1)
    print (arg1, arg2)

myfunc("foo")           # Prints 'foo foo'
myfunc("foo", "bar")    # Prints 'foo bar'
myfunc("foo", None)     # Prints 'foo foo'

This is, in my opinion, more Pythonic than using a placeholder-default (such as suggested in @moinudin's answer). However, using kwargs hides the existence of args2 from consumers of the function, unless you provide extra documentation.

Upvotes: 0

moinudin
moinudin

Reputation: 138497

As @Ignacio says, you can't do this. In your latter example, you might have a situation where None is a valid value for arg2. If this is the case, you can use a sentinel value:

sentinel = object()
def myfunc(arg1, arg2=sentinel):
    if arg2 is sentinel:
        arg2 = arg1
    print (arg1, arg2)

myfunc("foo")           # Prints 'foo foo'
myfunc("foo", None)     # Prints 'foo None'

Upvotes: 30

Inca
Inca

Reputation: 1911

The second way is fine in my opinion: it is exactly clear what you do, and for all those who will come after you and read the code. While there is a slight overhead in documenting the default behavior, the use of 'None' or any other to make your function generate a default value is very common. Putting logic inside the function calls would certainly not be commendable in my opinion, it could become very complex very soon. So just leave it in the function body, where all the code is.

Upvotes: 4

Ignacio Vazquez-Abrams
Ignacio Vazquez-Abrams

Reputation: 799520

Not really. The other argument names don't exist until the function is actually entered.

Upvotes: 8

Related Questions