Python Packages Tutorial – How to Create Your Own Package
1. Python Packages Tutorial
In today’s article, we will discuss Python Packages. Moreover, we will learn the structure of Python Packages and how to import modules from packages in Python.
So, let’s start the Python Packages Tutorial.
Python Packages Tutorial – How to Create Your Own Package in Python
2. What are Python Packages?
In our computer systems, we store our files in organized hierarchies. We don’t store them all in one location. Likewise, when our programs grow, we divide it into packages. In real-life projects, programs are much larger than what we deal with in our journey of learning Python. A package lets us hold similar modules in one place.
Like a directory may contain subdirectories and files, a package may contain sub-packages and modules. We have been using modules a lot in the previous lessons. Remember math, os, and collections? Those were all modules that ship with Python officially. We will discuss the difference between a module and a package in our next lesson. But for now, let’s dive into the world of Python packages.
3. Structure of Python Packages
As we discussed, a package may hold other Python packages and modules. But what distinguishes a package from a regular directory? Well, a Python package must have an __init__.py file in the directory. You may leave it empty, or you may store initialization code in it. But if your directory does not have an __init__.py file, it isn’t a package; it is just a directory with a bunch of Python scripts. Leaving __init__.py empty is indeed good practice.
Take a look at the following structure for a game:
Here, the root package is Game. It has sub packages Sound, Image, and Level, and file __init__.py. Sound further has modules load, play, and pause, apart from file __init__.py. Image has modules open, change, and close, apart from __init__.py. Finally, Level has modules start, load, and over, apart from __init__.py.
4. How to Import Modules from Packages in Python?
A Python package may contain several modules. To import one of these into your program, you must use the dot operator(.)
In the above example, if you want to import the load module from subpackage sound, we type the following at the top of our Python file:
Note that we don’t type the extension, because that isn’t what we refer to the module as. The subpackage Level has a module named load too, but there is no clash here. This is because we refer to the module by its fully qualified name.
To escape having to type so much every time we needed to use the module, we could also import it under an alias:
import Game.Sound.load as loadgame
(If you’re working the interpreter, you may also do the following:
This works equally fine.)
Alternatively, you could do:
from Game.Sound import load
Now, if the Sound subpackage has a function volume_up(), we call it this way:
If we imported this way:
from Game.Sound.load import volume_up() as volup
We could call the function simply, without needing to use a full qualifier:
But this isn’t recommended, as this may cause names in a namespace to clash.
5. Further Notes
When you import a package, only the modules directly under it are imported. An import does not import the sub packages.
>>> import one >>> one.two
Traceback (most recent call last):
File “<pyshell#488>”, line 1, in <module>
AttributeError: module ‘one’ has no attribute ‘two’
Also note that if you want to check where your Python packages are being created, your path will look something like this:
6. How to Create Your Own Python Package?
Now, on to the most interesting part. Like we said, Python packages are nothing but a dictionary with sub-packages and modules, and an __init__.py file.
In our example, this is the hierarchy we create:
This is what we have in evenodd.py:
def check(): a=int(input('Enter a number')) if a%2==0: print("Even") else: print("Odd")
Also, we keep each __init__.py empty.
Now, we import and use it this way:
>>> from one.two.evenodd import check as check >>> check()
Enter a number7
Enter a number0
So, this was all about Python Packages. Hope you like our explanation.
In this Python Packages tutorial, we discussed packages, and how to create them. Apart from that, the Python Package Index(PyPI) provides us with a lot of Python packages to help us with our projects. We talked about this in our Introduction to Python. Still, have a confusion? Feel free to ask in the comment box.