Python包怎么创建_Python包的创建与组织结构说明

爱谁谁 2025-11-05 00:00:00 次阅读

Python包是包含__init__.py的目录，用于组织模块；通过合理结构和导入设计，便于维护与使用。

创建Python包并不复杂，关键是理解其结构和规范。一个良好的包结构不仅便于自己维护，也方便他人使用或贡献代码。

什么是Python包

在Python中，包（Package） 是一种组织模块的方式，本质上是一个包含 __init__.py 文件的目录。这个文件可以为空，也可以包含包的初始化代码或定义 __all__ 变量来控制导入行为。从Python 3.3开始，即使没有 __init__.py，目录也能作为“隐式命名空间包”，但显式声明更清晰、兼容性更好。

创建一个简单的Python包

下面通过一个实际例子说明如何创建一个名为 mypackage 的包：

1. 创建目录结构

mypackage/
    __init__.py
    math_utils.py
    string_utils.py

2. 编写模块内容

例如，在 math_utils.py 中添加：

def add(a, b):
    return a + b
def multiply(a, b):
return a * b

在 string_utils.py 中添加：

def to_upper(s):
    return s.upper()

3. 配置 __init__.py

为了让用户更方便地导入功能，可以在 __init__.py 中暴露常用接口：

from .math_utils import add, multiply
from .string_utils import to_upper
all = ['add', 'multiply', 'to_upper']

这样用户使用 from mypackage import * 或直接调用函数时会更方便。

包的层级结构与子包

对于更复杂的项目，可以使用子包进行分层管理。例如：

mypackage/
    __init__.py
    utils/
        __init__.py
        math_utils.py
        string_utils.py
    io/
        __init__.py
        file_ops.py

此时，在根目录的 __init__.py 中可以这样组织：

from .utils.math_utils import add
from .io.file_ops import read_file
all = ['add', 'read_file']

子包中的 __init__.py 同样可用于简化导入路径，保持接口整洁。

打包与发布准备（可选）

如果你想将包分享到 PyPI 或供他人安装，需要添加 setup.py 或使用 pyproject.toml。

示例 setup.py：

from setuptools import setup, find_packages
setup(
name="mypackage",
version="0.1",
packages=find_packages(),
description="A simple example package",
author="Your Name",
author_email="your.email@example.com",
)

然后运行：