Run Function from the Command Line in Python

Introduction

With a few easy steps, you can run a function in Python from the command line. To begin with, write a Python script (.py file) that calls the desired function. Make sure the function definition is aligned and indented correctly. Next, launch a command-line interface (CLI) and go to the Python script's stored directory. To run your script, use the Python command followed by its name. If your function needs input parameters, use a command-line argument parsing library like argparse or sys.argv within your script to pass the parameters as command-line arguments. Python script.py arg1 arg2 is one example. Lastly, use the script to call your function, supplying any necessary command-line arguments. This allows you to execute your function straight from the command line, making it easy to integrate into different workflows and execute.

Through the use of suitable command-line options during script execution, users can access results directly in their terminal output. This method increases the script's adaptability and makes it possible to integrate it into a range of contexts and workflows.

Example

import sys
def sum_numbers(num1, num2):
    return num1 + num2

if __name__ == "__main__":
    if len(sys.argv) != 3:
        print("Usage: python my_function.py <number1> <number2>")
        sys.exit(1)

    num1 = float(sys.argv[1])
    num2 = float(sys.argv[2])
    
    result = sum_numbers(num1, num2)
    print("Sum:", result)

Open your terminal, go to the directory containing my_function.py, and type the following command to run this script from the command line:

Output:

$ python my_function.py 10 20
Sum: 30.0

Explanation

This sample Python script shows you how to add command-line argument processing to your scripts to make them more flexible and easier to use. The script can access the arguments supplied on the command line by importing the sys module. The reasoning behind adding two integers is contained in the sum_numbers function. The script's main block only runs when it is run directly, not when it is imported as a module, thanks to the conditional check if __name__ == "__main__". Furthermore, the script verifies the quantity of command-line arguments supplied, displaying an inappropriate usage notice upon detection. This validation enhances the user experience by offering precise instructions on utilising the script. After converting them to floating-point numbers, the script uses the sum_numbers function to calculate the total of the proper inputs.

Ultimately, it outputs the outcome to the console, showcasing the efficient incorporation of command-line argument processing to generate easy-to-use Python scripts with a wide range of functionalities.

Conclusion

In conclusion, using Python functions from the command line provides a strong way to carry out particular operations, automate workflows, and improve user engagement with scripts and applications. Through the use of command-line arguments, users can dynamically supply inputs, causing Python scripts containing predefined functions to execute. This feature simplifies development processes and makes it possible to write flexible, approachable scripts that can handle a wide range of use cases. Users can interact with Python applications directly from their terminal or command prompt by calling functions from the command line. This is useful when performing mathematical computations, data processing, or system management duties. Moreover, by offering a uniform interface for running scripts, this method encourages cooperation, streamlines interaction with current systems, and automates repetitive operations.

Hence, using Python's command-line function execution feature not only boosts output and efficiency but also promotes the adoption of best practices in software development, which eventually results in more reliable and scalable solutions catering to the requirements of both users and developers.

Next TopicShutil move method in python

← prev next →