Adding code to __init__.py

by

All imports in __init__.py are made available when you import the package (directory) that contains it.

Example:

./dir/__init__.py:

import something

./test.py:

import dir
# can now use dir.something

EDIT: forgot to mention, the code in __init__.py runs the first time you import any module from that directory. So it’s normally a good place to put any package-level initialisation code.

EDIT2: dgrant pointed out to a possible confusion in my example. In __init__.py import something can import any module, not necessary from the package. For example, we can replace it with import datetime, then in our top level test.py both of these snippets will work:

import dir
print dir.datetime.datetime.now()

and

import dir.some_module_in_dir
print dir.datetime.datetime.now()

The bottom line is: all names assigned in __init__.py, be it imported modules, functions or classes, are automatically available in the package namespace whenever you import the package or a module in the package.

More Related Contents:

  1. “pip install unroll”: “python setup.py egg_info” failed with error code 1
  2. How to read a (static) file from inside a Python package?
  3. Is __init__.py not required for packages in Python 3.3+
  4. Execution of Python code with -m option or not
  5. Python: importing a sub‑package or sub‑module
  6. Can’t import my own modules in Python
  7. How to import members of all modules within a package?
  8. How include static files to setuptools – python package
  9. Absolute vs. explicit relative import of Python module
  10. Can’t install new packages for Python (Python 3.9.0, Windows 10)
  11. How do I update a Python package?
  12. Using hyphen/dash in python repository name and package name
  13. Python Class Members Initialization
  14. Python import precedence: packages or modules?
  15. Python: import module from another directory at the same level in project hierarchy
  16. importing a module in nested packages
  17. How do I document classes imported from other modules – hence without the declaration module’s name?
  18. Python – Initializing Multiple Lists/Line
  19. How to import classes defined in __init__.py
  20. Check if Python Package is installed
  21. jupyter notebook running kernel in different env
  22. Install Shapely: OSError: [WinError 126] The specified module could not be found
  23. Python modules with identical names (i.e., reusing standard module names in packages)
  24. PyCharm: ImportError no module named X?
  25. Does uninstalling a package with “pip” also remove the dependent packages?
  26. How to properly use relative or absolute imports in Python modules?
  27. How to document Python packages using Sphinx
  28. How to reference python package when filename contains a period
  29. ModuleNotFoundError: No module named ‘sklearn’
  30. pip fails to install packages from requirements.txt

Leave a Comment