Python: What does if __name__ == “__main__”: do?

The if __name__ == "__main__": statement in Python is a common idiom used to determine if the Python script is being run as the main program or if it is being imported as a module into another script. Let’s break down its purpose and functionality:

if __name__ == "__main__":
    # Code to execute when the script is run as the main program

Here’s what happens:

1. __name__ Variable:
   • In Python, the __name__ variable is a special variable that is automatically set by the Python interpreter.
   • When a Python script is executed, __name__ is set to "__main__" if the script is the main program being run.
2. Main Program Execution:
   • The if __name__ == "__main__": statement checks if the script is being run as the main program.
   • If true, the indented code block beneath it is executed.
3. Importing as a Module:
   • When a Python script is imported as a module into another script, __name__ is set to the name of the module, not "__main__".
   • In this case, the code block beneath if __name__ == "__main__": is not executed.

Use Cases:

1. Script Execution:
   • The code inside the if __name__ == "__main__": block is typically where you place the main functionality of your script that you want to execute when the script is run directly.
   • This allows you to have reusable modules that can also be used as standalone scripts.
2. Avoiding Unintended Execution:
   • It prevents the unintended execution of code when the script is imported as a module.
   • Without this condition, any code outside the if __name__ == "__main__": block would be executed upon import.

Example:

# Example module/script

def some_function():
    print("This function can be reused")

if __name__ == "__main__":
    # Code to execute when the script is run as the main program
    print("This script is being run directly.")
    some_function()

In this example, some_function() can be imported and used in another script without executing the code inside the if __name__ == "__main__": block. When the script is run directly, the block is executed, and the message is printed.