PyTips

What is __init__.py ?

July 28,2013

Okay yet another useful post. This post is really important and useful for anyone just starting out with python. So what is the __init__.py file ?

Files name __init__.py are used to mark directories on disk as Python package directories. If you have the files

mydir/spam/__init__.py
midir/spam/module.py

and mydir is on your path, you can import the code in module.py as

import spam.module

or

from spam import module

If you remove the __init__.py file, Python will no longer look for submodules inside that directory, so attempts to import the module will fail.

The __init__.py file is usually empty, but can be used to export selected portions of the package under more convenient name, hold convenience functions, etc. Given the example above, the contents of the init module can be accessed as

import spam

And finally here is what the official documentation has to say about this file:

The init.py files are required to make Python treat the directories as containing packages; this is done to prevent directories with a common name, such as string, from unintentionally hiding valid modules that occur later on the module search path. In the simplest case,init.py can just be an empty file, but it can also execute initialization code for the package or set the all variable, described later.

Source: http://effbot.org/pyfaq/what-is-init-py-used-for.htm

programming python __init__.py