Создание полной структуры пакета
Теперь, когда мы понимаем основные принципы Python-пакетов и роль файла __init__.py, давайте создадим более полную структуру пакета, которая следует лучшим практикам. Это поможет вам эффективно организовать более крупные проекты.
Лучшие практики для структуры пакета
Хорошо организованный Python-пакет обычно следует этой структуре:
package_name/
├── __init__.py
├── module1.py
├── module2.py
├── subpackage1/
│ ├── __init__.py
│ └── module3.py
├── subpackage2/
│ ├── __init__.py
│ └── module4.py
├── README.md
├── setup.py
└── tests/
├── __init__.py
├── test_module1.py
└── test_module2.py
Давайте реализуем упрощенную версию этой структуры для нашего калькуляторного пакета:
- Создайте файл README.md:
touch ~/project/calculator_package/README.md
- Откройте файл README.md в WebIDE и добавьте:
Calculator Package
A simple Python package that provides basic and advanced calculator functions.
Features
- Basic arithmetic operations (addition, multiplication)
- Advanced scientific operations (square root, power)
Usage
from calculator_package import add_two_numbers, multiply_two_numbers
from calculator_package.advanced import square_root, power
## Basic operations
result1 = add_two_numbers(5, 3)
result2 = multiply_two_numbers(4, 2)
## Advanced operations
result3 = square_root(16)
result4 = power(2, 3)
- Создайте каталог tests:
mkdir ~/project/calculator_package/tests
touch ~/project/calculator_package/tests/__init__.py
- Создайте тестовые файлы:
touch ~/project/calculator_package/tests/test_basic.py
- Откройте
test_basic.py в WebIDE и добавьте:
import unittest
from calculator_package import add_two_numbers, multiply_two_numbers
class TestBasicOperations(unittest.TestCase):
def test_addition(self):
self.assertEqual(add_two_numbers(5, 3), 8)
self.assertEqual(add_two_numbers(-1, 1), 0)
def test_multiplication(self):
self.assertEqual(multiply_two_numbers(5, 3), 15)
self.assertEqual(multiply_two_numbers(-2, 3), -6)
if __name__ == '__main__':
unittest.main()
- Создайте файл setup.py для распространения пакета:
touch ~/project/setup.py
- Откройте
setup.py в WebIDE и добавьте:
from setuptools import setup, find_packages
setup(
name="calculator_package",
version="0.1.0",
author="Your Name",
author_email="[email protected]",
description="A simple calculator package",
packages=find_packages(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.6",
)
- Давайте запустим модульные тесты:
cd ~/project
python3 -m calculator_package.tests.test_basic
Вы должны увидеть вывод, похожий на:
Calculator Package v0.1.0 initialized
..
----------------------------------------------------------------------
Ran 2 tests in 0.001s
OK
Это подтверждает, что наш пакет хорошо структурирован и тесты работают правильно.
Документация пакета с помощью строк документации (Docstrings)
Хорошая документация важна для любого Python-пакета. Давайте добавим правильные строки документации в наш пакет:
- Обновите файл
calculator_package/__init__.py, чтобы включить строку документации уровня пакета:
"""
Calculator Package - A collection of calculator functions.
This package provides various calculator functions including basic
arithmetic operations and advanced scientific operations.
"""
## Import functions from modules
from .addition import add_two_numbers, add_multiple_numbers
from .multiplication import multiply_two_numbers, multiply_multiple_numbers
## Define package-level variables
__version__ = "0.1.0"
__author__ = "Your Name"
## Print a message when the package is imported
print(f"Calculator Package v{__version__} initialized")
## Import the advanced subpackage
from . import advanced
- Вы можете просмотреть строку документации, используя функцию help Python:
cd ~/project
python3 -c "import calculator_package; help(calculator_package)"
Это должно отобразить документацию пакета:
Help on package calculator_package:
NAME
calculator_package - Calculator Package - A collection of calculator functions.
DESCRIPTION
This package provides various calculator functions including basic
arithmetic operations and advanced scientific operations.
PACKAGE CONTENTS
addition
advanced (package)
multiplication
tests (package)
DATA
__author__ = 'Your Name'
__version__ = '0.1.0'
FILE
/home/labex/project/calculator_package/__init__.py
Эта документация помогает пользователям понять назначение и возможности вашего пакета.
