How do I write good/correct package __init__.py files

by

__all__ is very good – it helps guide import statements without automatically importing modules
http://docs.python.org/tutorial/modules.html#importing-from-a-package

using __all__ and import * is redundant, only __all__ is needed

I think one of the most powerful reasons to use import * in an __init__.py to import packages is to be able to refactor a script that has grown into multiple scripts without breaking an existing application. But if you’re designing a package from the start. I think it’s best to leave __init__.py files empty.

for example:

foo.py - contains classes related to foo such as fooFactory, tallFoo, shortFoo

then the app grows and now it’s a whole folder

foo/
    __init__.py
    foofactories.py
    tallFoos.py
    shortfoos.py
    mediumfoos.py
    santaslittlehelperfoo.py
    superawsomefoo.py
    anotherfoo.py

then the init script can say

__all__ = ['foofactories', 'tallFoos', 'shortfoos', 'medumfoos',
           'santaslittlehelperfoo', 'superawsomefoo', 'anotherfoo']
# deprecated to keep older scripts who import this from breaking
from foo.foofactories import fooFactory
from foo.tallfoos import tallFoo
from foo.shortfoos import shortFoo

so that a script written to do the following does not break during the change:

from foo import fooFactory, tallFoo, shortFoo

More Related Contents:

  1. Sibling package imports
  2. How do I remove packages installed with Python’s easy_install?
  3. How to install Python packages from the tar.gz file without using pip install
  4. List all the modules that are part of a python package?
  5. Can I force pip to reinstall the current version?
  6. What is the most compatible way to install python modules on a Mac?
  7. Making an executable in Cython
  8. Can I use __init__.py to define global variables?
  9. Defined variable is not defined
  10. Adding a element in dictionary which consist of dictionaries.
  11. Select nan column in pandas
  12. Matplotlib scatterplot; color as a function of a third variable
  13. Remove duplicates by columns A, keeping the row with the highest value in column B
  14. Usage of sys.stdout.flush() method
  15. What is the correct way to set Python’s locale on Windows?
  16. Calling functions from a Tkinter Frame to another
  17. Accessing attributes on literals work on all types, but not `int`; why? [duplicate]
  18. How to get the last N rows of a pandas DataFrame?
  19. Difference between data type ‘datetime64[ns]’ and ‘
  20. Pytube givng an “HTTP Error 404: Not Found” error. Anyone knows how to fix this?
  21. How can I strip comment tags from HTML using BeautifulSoup?
  22. Gauss-Legendre Algorithm in python
  23. Get unicode code point of a character using Python
  24. Pass variable between python scripts
  25. Multiply operator applied to list(data structure)
  26. NumPy version of “Exponential weighted moving average”, equivalent to pandas.ewm().mean()
  27. How to write custom python logging handler?
  28. What values are valid in Pandas ‘Freq’ tags?
  29. Updating Python on Mac
  30. Sum list of list elements in python like sql group by [duplicate]

Leave a Comment