Python functions with default arguments
Let us say, we are writing a function that takes multiple parameters. Often, there are common values for some of these parameters. In such cases, we would like to be able to call the function without explicitly specifying every parameter. In other words, we would like some parameters to have default values that will be used when they are not specified in the function call.
To define a Python function with a default argument value, we need to assign a value to the parameter of interest while defining a function.
def power(number, pow=2):
“””Returns the value of number to the power of pow.”””
Notice that the above python function computes the first argument to the power of the second argument. The default value of the latter is 2. So now when we call the python function
power only with a single argument, it will be assigned to the
number parameter and the return value will be obtained by squaring
# Calling the power function only with required argument
In other words, the argument value to the second parameter
pow became optional. If we want to calculate the number for a different power, we can obviously provide a value for it and the python function will return the corresponding value.
# Calling the power function with both arguments
We can have any number of default value parameters in a python function. Note however that they must follow non-default value parameters in the definition. Otherwise, Python will throw an error as shown below:
# Calling the power function that will throw an error
def power(pow=2, number):
“””Returns the raised number to the power of pow.”””
def power(pow=2, number):
SyntaxError: non-default argument follows default argument
In the next installment, the author will discuss Python functions with variable length arguments.
Visit https://www.quantinsti.com/ for ready-to-use Python functions as applied in trading and data analysis.
Disclosure: Interactive Brokers
Information posted on IBKR Traders’ Insight that is provided by third-parties and not by Interactive Brokers does NOT constitute a recommendation by Interactive Brokers that you should contract for the services of that third party. Third-party participants who contribute to IBKR Traders’ Insight are independent of Interactive Brokers and Interactive Brokers does not make any representations or warranties concerning the services offered, their past or future performance, or the accuracy of the information provided by the third party. Past performance is no guarantee of future results.
This material is from QuantInsti and is being posted with permission from QuantInsti. The views expressed in this material are solely those of the author and/or QuantInsti and IBKR is not endorsing or recommending any investment or trading discussed in the material. This material is not and should not be construed as an offer to sell or the solicitation of an offer to buy any security. To the extent that this material discusses general market activity, industry or sector trends or other broad based economic or political conditions, it should not be construed as research or investment advice. To the extent that it includes references to specific securities, commodities, currencies, or other instruments, those references do not constitute a recommendation to buy, sell or hold such security. This material does not and is not intended to take into account the particular financial conditions, investment objectives or requirements of individual customers. Before acting on this material, you should consider whether it is suitable for your particular circumstances and, as necessary, seek professional advice.