How do I create a Python function with optional arguments?

PythonFunctionArgumentsOptional Arguments

Python Problem Overview

I have a Python function which takes several arguments. Some of these arguments could be omitted in some scenarios.

def some_function (self, a, b, c, d = None, e = None, f = None, g = None, h = None):

The arguments d through h are strings which each have different meanings. It is important that I can choose which optional parameters to pass in any combination. For example, (a, b, C, d, e), or (a, b, C, g, h), or (a, b, C, d, e, f, or all of them (these are my choices).

It would be great if I could overload the function - but I read that Python does not support overloading. I tried to insert some of the required int arguments in the list - and got an argument mismatch error.

Right now I am sending empty strings in place of the first few missing arguments as placeholders. I would like to be able to call a function just using actual values.

Is there any way to do this? Could I pass a list instead of the argument list?

Right now the prototype using ctypes looks something like:

_fdll.some_function.argtypes = [c_void_p, c_char_p, c_int, c_char_p, c_char_p, c_char_p, c_char_p, c_char_p]

Python Solutions

Solution 1 - Python

Just use the *args parameter, which allows you to pass as many arguments as you want after your a,b,c. You would have to add some logic to map args->c,d,e,f but its a "way" of overloading.

def myfunc(a,b, *args, **kwargs):
   for ar in args:
      print ar

And it will print values of c,d,e,f

Similarly you could use the kwargs argument and then you could name your parameters.

def myfunc(a,b, *args, **kwargs):
      c = kwargs.get('c', None)
      d = kwargs.get('d', None)
myfunc(a,b, c='nick', d='dog', ...)

And then kwargs would have a dictionary of all the parameters that are key valued after a,b

Solution 2 - Python

Try calling it like: obj.some_function( '1', 2, '3', g="foo", h="bar" ). After the required positional arguments, you can specify specific optional arguments by name.

Solution 3 - Python

It is very easy just do this

def foo(a = None):

Instead of None you can type anything that should be in place if there was no argument for example if you will not write value of the parameter like this foo() then it will print None because no argument is given and if you will GIVE it a argument like foo("hello world") then it will print hello world, OH YES i forgot to tell y'all that when these types of paramters i.e optional parameters, THESE ARGUMENTS NEEDS TO FOLLOW THE DEFAULT ARGUMENTS this means that, lets take the previous function and add another parameter b

def foo(a = None, b): 

Now if you'll execute your python file it is going to raise an exception saying that Non-default arguments follows default arguments,

SyntaxError: non-default argument follows default argument

so you gotta put the optional or non-default argument after the arguments which are required

which means

def foo (a, b=None): ... #This one is right(these threee dots are ellipsis which are somewhat like pass

def foo(b=None, a): ... #and this isn't

Solution 4 - Python

Required parameters first, optional parameters after. Optional parameters always with a =None.

Easy and fast example:

def example_function(param1, param2, param3=None, param4=None):

# Doesn't work, param2 missing

# Works
example_function("hello", "bye")

# Works. Both the same
example_function("hello", "bye", "hey")
example_function("hello", "bye", param3="hey")

# Works. Both the same
example_function("hello", "bye", "hey", "foo")
example_function("hello", "bye", param3="hey", param4="foo")

Solution 5 - Python

as in more proper way:

import Optional from typing

def foo(a: str, b: Optional[str]) -> str or None:

which is equalevent to:

def foo(a: str, b: str or None = None) -> str or None

For more information:

Solution 6 - Python

To get a better sense of what's possible when passing parameters it's really helpful to refer to the various options: positional-or-keyword (arg or arg="default_value"), positional-only (before /, in the parameter list), keyword-only (after *, in the parameter list), var-positional (typically *args) or var-keyword (typically **kwargs). See the Python documentation for an excellent summary; the various other answers to the question make use of most of these variations.

Since you always have parameters a, b, c in your example and you appear to call them in a positional manner, you could make this more explicit by adding /,,

def some_function (self, a, b, c, /, d = None, e = None, f = None, g = None, h = None):


All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionThaliaView Question on Stackoverflow
Solution 1 - PythonNixView Answer on Stackoverflow
Solution 2 - PythonRussell BorogoveView Answer on Stackoverflow
Solution 3 - PythonPrabhavDevoView Answer on Stackoverflow
Solution 4 - PythonAviónView Answer on Stackoverflow
Solution 5 - PythoncemView Answer on Stackoverflow
Solution 6 - PythonAndrew RichardsView Answer on Stackoverflow