How can you make a Python function that accepts any number of positional arguments?
Here's a function (called
greet) that accepts a single argument (
>>> def greet(name): ... print("Hello", name) ...
We can pass that argument in positionally:
>>> greet("Trey") Hello Trey
Or as a keyword argument:
>>> greet(name="Trey") Hello Trey
If we pass in 2 names or 3 names to this function, we'll get an error:
>>> greet("Trey", "Jo") Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: greet() takes 1 positional argument but 2 were given >>> greet("Trey", "Jo", "Ian") Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: greet() takes 1 positional argument but 3 were given
We'd like to modify this function to accept any number of names (and to greet each name given).
To accept any number of positional arguments we're going to need to use the
* operator when defining this function.
>>> def greet(*names): ... for name in names: ... print("Hello", name) ...
*names in our arguments tells Python that we want to capture all positional arguments given to this function, into a tuple, point the
names variable to that tuple.
Now when we call
greet with just one name, it works the same as before:
>>> greet("Trey") Hello Trey
But we can also call it with multiple names to greet multiple people:
>>> greet("Trey", "Jo") Hello Trey Hello Jo >>> greet("Trey", "Jo", "Ian") Hello Trey Hello Jo Hello Ian
In fact, we can even call it with no names:
>>> greet() >>>
names tuple in the
greet function is empty in this case so the loop does nothing.
It's not an error to give zero arguments when you're using
What are examples of functions that accept any number of positional arguments?
>>> help(zip) class zip(object) | zip(*iterables) --> zip object
*iterables in the definition of the
zip function (
zip class technically) means it accepts any number of iterables.
When you give
zip loop over all of those iterables at the same time.
max functions, also accept any number of positional arguments:
min(arg1, arg2, *args, *[, key=func]) -> value
Note in that in the
min documentation that
arg2 are before
It's possible to define your own functions like this.
We can put other (required) positional arguments before all the remaining (optional) positional arguments that we're capturing.
You can also pass any number of arguments to the
>>> help(print) print(...) print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
The documentation is a little bit different with
* operator (instead it shows
... to indicate that any number of values are accepted).
You can give any number of arguments to
>>> print(1, 2, 3, 4) 1 2 3 4
To make a function that accepts any number of arguments, you can use the
* operator and then some variable name when defining your function's arguments.
This lets Python know that when that function is called with any position arguments, they should all be captured into a tuple (which that variable will point to).
So if you'd like to make a function that accepts any number of positional arguments, use the
Python, like many programming languages, has functions. A function is a block of code you can call to run that code.
Python's functions have a lot of "wait I didn't know that" features. Functions can define default argument values, functions can be called with keyword arguments, and functions can be written to accept any number of arguments.
Need to fill-in gaps in your Python skills? I send regular emails designed to do just that.
Sign up for my Python tips emails and I'll share my favorite Python insights with you every couple weeks.
Need to fill-in gaps in your Python skills? I send weekly emails designed to do just that.