Python Package With Examples [Latest]

Python Package

Python package is a collection of modules in directories that give a package hierarchy. More elaborately, python packages are a way of structuring python’s module by using “dotted module names”. So A.B actually indicates that B is a sub module which is under a package named A.

So as modules are way of handling functions and namespace in a better way, in that way python package is the way of handling two or more modules in a structured method.

Suppose you want to design a collection of modules for handling the music files. Take a look at the following structures-

music/                          Top-level package
      __init__.py               Initialize the music package
      formats/                  Subpackage for file format conversions
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpackage for sound effects
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  Subpackage for filters
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...

Every python package needs to have a __init__.py file, which will ensure that this directory will be treated as a python package. Generally __init__.py can be just an empty file or it can also be an executable initialisation code for the package or set the __all__ variable which will be explored in the later part of this tutorial.

To import individual module from the package one can use any of the following ways.

import music.formats.wavwrite

Or,

from music.formats import wavwrite

The above commands load the sub module music.formats.wavwrite. Of course this must be referenced with it’s full name. Suppose module wavwrite.py has a functions named writeFile(aFileName) which takes name of a file as it’s argument. So to call it we have to write like this;

import music.formats.wavwrite
...
...
music.formats.wavwrite.writeFile(outputFileName)

Or, in the second way-

from music.formats import wavwrite
...
...
wavwrite.writeFile(outputFileName)

Also one may wonder, there is also another variation to import the desired function or variable directly;

from music.formats.wavwrite import writeFile
...
...
writeFile(outputFileName)

Can I import * From a Python Package

A curious reader may wonder what if one writes from music.formats import * like we did while importing from a module. Well this might cause unwanted side-effects and also this will consume a lot of time.

Ideal solution to do this would be if the package author provide an explicit index of the package. If a package’s __init__.py code defines a list named __all__, it would be considered as the index of module names that should be imported when from music.formats import * is encountered.

Let’s see a different example to understand this concept clearly. Suppose we have a package structure like this;

Here you can see under music there is a __init__.py. If the __all__ is defined below;

__all__ = ["admin", "apps", "models"]

Then only sub modules enlisted in the above list will imported while a from music import * is encountered. The rest of the sub modules and variables will be ignored.

If __all__ is not defined, there is guarantee that all the submodules under it will be imported. The statement from music import * only ensures that music package has been imported.

So that’s pretty much all of the basic information about python package. For more information you can see the official python doc – https://docs.python.org/3/tutorial/modules.html#packages

So keep practicing. #happy_coding 🙂