Understanding Python’s __main__ variable

See Python: Tips and Tricks for similar articles.

Let’s say we have two scripts: foo.py and bar.py.

They are exactly the same. They begin with the definition of a function called main(), which simply prints out the value of __name__, a built-in variable that returns the name of the module. foo and bar

If we run either of these modules, it will output ‘__main__’. This tells us that a module refers to itself as ‘__main__’. foo and bar with output

Now let’s modify foo.py so that it imports bar.py. Now when we run foo.py, it first imports bar.py, which invokes its own main() function. But, because it’s been imported, it now calls itself by its imported name: ‘bar’: foo and bar import

Then foo.py invokes its own main() function, again calling itself ‘__main__’.

It is common for modules to check to see if they are being imported by checking the value of the __name__ variable. And often, they’ll only run their main() function if __name__ is equal to ‘__main__’, indicating that they are not being imported foo and bar with if

Video Version:

Written by Nat Dunn. Follow Nat on Twitter.

Related Articles

  1. Fixing WebVTT Times with Python
  2. Using Python to Convert Images to WEBP
  3. Scientific Notation in Python
  4. Understanding Python’s __main__ variable (this article)
  5. Converting Leading Tabs to Spaces with Python
  6. pow(x, y, z) more efficient than x**y % z and other options
  7. A Python Model for Ping Pong Matches
  8. Bulk Convert Python files to IPython Notebook Files (py to ipynb conversion)
  9. Python’s date.strftime() slower than str(), split, unpack, and concatenate?
  10. Basic Python Programming Exercise: A Penny Doubled Every Day
  11. Bi-directional Dictionary in Python
  12. How to find all your Python installations on Windows (and Mac)
  13. Associate Python Files with IDLE
  14. Change Default autosave Interval in JupyterLab
  15. Python: isdigit() vs. isdecimal()
  16. Python Clocks Explained
  17. Python Color Constants Module
  18. Maximum recursion depth exceeded while calling a Python object
  19. When to use Static Methods in Python? Never
  20. Finally, a use case for finally – Python Exception Handling
  21. Creating an Email Decorator with Python and AWS
  22. Python Coding Challenge: Two People with the Same Birthday
  23. How to Create a Simple Simulation in Python – Numeric Data
  24. Collatz Conjecture in Python
  25. Simple Python Script for Extracting Text from an SRT File
  26. Python Virtual Environments with venv
  27. Mapping python to Python 3 on Your Mac
  28. How to Make IDLE the Default Editor for Python Files on Windows
  29. How to Do Ternary Operator Assignment in Python
  30. How to Convert Seconds to Years with Python
  31. How to Create a Python Package
  32. How to Read a File with Python
  33. How to Check the Operating System with Python
  34. How to Use enumerate() to Print a Numbered List in Python
  35. How to Repeatedly Append to a String in Python
  36. Checking your Sitemap for Broken Links with Python
  37. How to do Simultaneous Assignment in Python
  38. Visual Studio Code - Opening Files with Python open()
  39. How to Slice Strings in Python
  40. How Python Finds Imported Modules
  41. How to Merge Dictionaries in Python
  42. How to Index Strings in Python
  43. How to Create a Tuple in Python