What does __all__ mean in Python?

by

Linked to, but not explicitly mentioned here, is exactly when __all__ is used. It is a list of strings defining what symbols in a module will be exported when from <module> import * is used on the module.

For example, the following code in a foo.py explicitly exports the symbols bar and baz:

__all__ = ['bar', 'baz']

waz = 5
bar = 10
def baz(): return 'baz'

These symbols can then be imported like so:

from foo import *

print(bar)
print(baz)

# The following will trigger an exception, as "waz" is not exported by the module
print(waz)

If the __all__ above is commented out, this code will then execute to completion, as the default behaviour of import * is to import all symbols that do not begin with an underscore, from the given namespace.

Reference: https://docs.python.org/tutorial/modules.html#importing-from-a-package

NOTE: __all__ affects the from <module> import * behavior only. Members that are not mentioned in __all__ are still accessible from outside the module and can be imported with from <module> import <member>.

More Related Contents:

  1. The letter ‘n’ is invalid syntax in Python? [closed]
  2. What does the star and doublestar operator mean in a function call?
  3. Is there a standardized method to swap two variables in Python?
  4. Accessing dict keys like an attribute?
  5. What does a b prefix before a python string mean?
  6. Python ElementTree module: How to ignore the namespace of XML files to locate matching element when using the method “find”, “findall”
  7. What does preceding a string literal with “r” mean? [duplicate]
  8. Putting an if-elif-else statement on one line?
  9. Why are trailing commas allowed in a list?
  10. When are parentheses required around a tuple?
  11. Which is more preferable to use: lambda functions or nested functions (‘def’)?
  12. Python Script returns unintended “None” after execution of a function [duplicate]
  13. Python: One Try Multiple Except
  14. type object ‘datetime.datetime’ has no attribute ‘datetime’
  15. What does [:] mean?
  16. Is it bad practice to use a built-in function name as an attribute or method identifier?
  17. Is there a difference between continue and pass in a for loop in Python?
  18. Creating a class within a function and access a function defined in the containing function’s scope
  19. How do you express binary literals in Python?
  20. Recursively access dict via attributes as well as index access?
  21. Why does python use two underscores for certain things?
  22. Python print statement “Syntax Error: invalid syntax” [duplicate]
  23. The difference between double brace `[[…]]` and single brace `[..]` indexing in Pandas
  24. inspect.getmembers() vs __dict__.items() vs dir()
  25. What do ** (double star/asterisk) and * (star/asterisk) mean in a function call?
  26. How to find “import name” of any package in Python?
  27. How to tell if a string contains valid Python code
  28. What does the ** maths operator do in Python?
  29. NameError: global name is not defined
  30. Square braces not required in list comprehensions when used in a function

Leave a Comment