创建Python包的过程通常包括以下步骤:
创建包结构
创建一个文件夹,该文件夹的名称将作为包的名称。
在该文件夹中创建一个`__init__.py`文件,这个文件可以是空的,但它的存在告诉Python这个文件夹应该被视为一个包。
编写模块
在包内创建`.py`文件,每个文件包含一些函数、类或变量。
可以在`__init__.py`中导入其他模块,这样就可以在外部直接使用这些模块。
编写`setup.py`
在包的根目录下创建一个`setup.py`文件,这个文件用于定义包的元数据和依赖关系。
`setup.py`文件通常包含以下信息:
`name`:包的名称。
`version`:包的版本号。
`description`:包的简短描述。
`author`:包的作者。
`packages`:要包含在包中的模块列表。
安装包
在命令行中运行`python setup.py sdist bdist_wheel`命令,生成源代码发布版和wheel发布版。
安装包可以使用`pip`,例如:`pip install .`(假设当前目录是包的根目录)。
测试包
创建一个测试文件,在文件中导入并使用包中的函数或类。
运行测试文件以确保包按预期工作。
下面是一个简单的例子,说明如何创建一个名为`myPackage`的包:
create_package/
|-- myPackage/
| |-- __init__.py
| |-- aa.py
| |-- bb.py
| |-- inner/
| |-- __init__.py
| |-- cc.py
|-- setup.py
`setup.py`内容可能如下:
from setuptools import setup, find_packages
setup(
name='myPackage',
version='1.0.1',
description='Test package',
author='Wang Cheng',
packages=find_packages(),
)
然后,在命令行中运行:
python setup.py sdist bdist_wheel
这将在`create_package/dist`目录下生成源代码和wheel文件。
请注意,随着时间的推移,Python包管理工具(如`setuptools`和`poetry`)已经变得更加流行和强大,它们提供了更多的功能和更好的依赖管理。如果你打算发布你的包,可能需要遵循这些工具特定的指南和最佳实践。