DEV Community

Precious Ifeanyi
Precious Ifeanyi

Posted on

How To Create Packages And Subpackages In Python

Python enables you to organize your code into packages and subpackages, offering a structured approach to managing your project's modules. Packages consist of directories that contain Python modules and a special __init__.py file, whereas subpackages are packages within other packages.

Follow these steps to create packages and subpackages in Python:

Step 1: Create Your Project Directory Structure
You need to first decide on a directory structure for your project. Typically, your project directory should contain your main Python scripts, along with directories for packages and subpackages. For example:

project/
│
├── main.py
│
└── my_package/
    ├── __init__.py
    ├── module1.py
    ├── module2.py
    └── subpackage/
        ├── __init__.py
        ├── submodule1.py
        └── submodule2.py
Enter fullscreen mode Exit fullscreen mode

Step 2: Create The Package Directory
In your project directory, create a directory for your package. This directory will contain the Python modules that make up your package.

mkdir my_package
Enter fullscreen mode Exit fullscreen mode

Step 3: Create The __init__.py File
Inside the package directory, create a file named init.py. This file can be empty or contain initialization code for your package.

touch my_package/__init__.py
Enter fullscreen mode Exit fullscreen mode

Step 4: Create Python Modules
Create Python modules inside your package directory. These modules will contain the code for your package's functionality. You can create as many modules as needed.

touch my_package/module1.py
touch my_package/module2.py
Enter fullscreen mode Exit fullscreen mode

Step 5: Create Subpackages
If you want to create subpackages within your package, repeat steps 2-4 inside the package directory to create subdirectories and subpackage modules.

mkdir my_package/subpackage
touch my_package/subpackage/__init__.py
touch my_package/subpackage/submodule1.py
touch my_package/subpackage/submodule2.py
Enter fullscreen mode Exit fullscreen mode

Step 6: Write Your Python Code
Write the code for your modules and submodules. You can define functions, classes, and other objects within these modules to implement your package's functionality.

Step 7: Import Your Package
Import your package and its modules/submodules in your Python scripts or interactive sessions using the import statement.

import my_package.module1
from my_package.subpackage import submodule1
Enter fullscreen mode Exit fullscreen mode

Step 8: Use Your Package
Once imported, you can use the functions, classes, and other objects defined in your package's modules/submodules in your Python code.

my_package.module1.function1()
submodule1.function2()
Enter fullscreen mode Exit fullscreen mode

That's it! You've successfully created packages and subpackages in Python. Organizing your code in this way can help improve readability, maintainability, and reusability in your projects.

Top comments (0)