先别急着觉得"自己开发库自己调用"很诡异——其实你早就这么干过了!
举个栗子:你写了一个utils.py文件,里面有个calculate_something()函数,然后在main.py里import utils并调用它。恭喜!你已经完成了"自己开发库,自己调用"的80%!
只不过,这个"库"还只是个.py文件,没打包成正式的pip install格式而已。所以,你的问题不是"能不能",而是"怎么从野路子变成正规军"。
Python库的"前世今生":从.py文件到pip包
要理解"自己开发库自己调用",得先知道Python库的几种形态:
这是什么? 就是你随手写的my_module.py,然后在另一个文件里import my_module。
优点:简单粗暴,3秒搞定
缺点:只能在当前项目用,不能分享给别人,也不能用pip install
这是什么? 把多个.py文件放到一个文件夹里,加上__init__.py,变成"包"(Package)。
目录结构:
my_package/
__init__.py
module1.py
module2.py
然后在代码里import my_package.module1。
优点:稍微正规一点,可以组织复杂代码
缺点:还是只能自己用,别人要复制粘贴你的文件夹
这是什么? 就是能用pip install my_package安装的库。它有标准的打包格式(.whl或.tar.gz),包含元数据、依赖声明等。
优点:可以分享、可以版本管理、可以用pip管理依赖
缺点:需要学习打包工具(setuptools、poetry等)
现在,我们一步步把你写的代码变成"可pip安装的库",然后自己调用它。
假设我们要写一个"超级计算器"库,叫super_calculator。先创建项目结构:
super_calculator/
super_calculator/ # 这是我们的包目录
__init__.py
calculator.py
tests/ # 测试目录(可选)
test_calculator.py
README.md
setup.py # 打包配置文件
在calculator.py里写点"有用"的代码:
#- super_calculator/calculator.py
def add(a, b):
"""加法(虽然很简单,但我们要假装很厉害)"""
return a + b
def multiply(a, b):
"""乘法(假装这是'超级'计算)"""
return a * b
def power(base, exponent):
"""幂运算(这才是'超级'所在!)"""
return base ** exponent
#- super_calculator/__init__.py
from .calculator import add, multiply, power
__all__ = ['add', 'multiply', 'power']
#- test_locally.py
from super_calculator import add, power
print(add(2, 3)) # 输出:5
print(power(2, 10)) # 输出:1024
注意:这时候你还在"游击队"阶段——只能通过相对路径导入,不能pip install。
要让你的代码变成"正规军",需要setup.py文件:
#- setup.py
from setuptools import setup, find_packages
setup(
name="super_calculator", # 包名(pip install时用的名字)
version="0.1.0", # 版本号(第一次发布用0.1.0)
description="一个超级计算器库(其实并不超级)",
author="你的名字",
author_email="your.email@example.com",
packages=find_packages(), # 自动找到所有包
install_requires=[], # 依赖列表(我们这个库不需要依赖)
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
)
关键点:
✦ name:必须唯一,不能和PyPI上已有的包重名(可以去https://pypi.org搜一下)
✦ version:遵循语义化版本(major.minor.patch)
✦ packages:告诉setuptools哪些目录是包
这个-e参数是"可编辑模式"——你修改代码后,不需要重新安装就能生效(非常适合开发阶段)。
安装成功后,你可以在任何Python文件里调用:
#- 在任何地方!
import super_calculator
print(super_calculator.add(1, 2)) # 输出:3
恭喜! 你现在已经实现了"自己开发库,自己调用"——虽然还只是在本地。
python setup.py sdist bdist_wheel
这会生成两个文件:
✦ dist/super_calculator-0.1.0.tar.gz(源码包)
✦ dist/super_calculator-0.1.0-py3-none-any.whl(wheel包,推荐)
现在你可以把.whl文件发给别人,他们用pip install super_calculator-0.1.0-py3-none-any.whl就能安装。
注意:这一步是可选的。如果你只想自己用,到第4步就够了。如果想分享给全世界(或者至少是PyPI用户),才需要发布。
发布流程:
✦ 注册PyPI账号(https://pypi.org)
✦ 安装twine:pip install twine
✦ 上传:twine upload dist/*
上传成功后,全世界都能pip install super_calculator了!
但注意:发布到公共PyPI需要谨慎——包名要唯一,代码要测试,别发布垃圾代码污染PyPI。
你可能觉得:"哇,这么多步骤,好复杂!" 其实,这是因为:
就像开公司要注册、要营业执照一样,可分发库需要元数据(版本、作者、依赖等),这样pip才能管理它。.py文件就像"摆地摊",pip包就像"开连锁店"——后者更规范,但前期准备也多。
大多数情况下,你开发库是为了:
✦ 自己项目复用(用pip install -e .本地安装就够了)
✦ 团队内部共享(搭建私有PyPI服务器,或直接传.whl文件)
✦ 学习练习(不需要发布)
只有当你真的想开源分享,或者公司需要公共组件库时,才需要完整发布流程。
如果你觉得setuptools配置麻烦,可以试试Poetry或Flit这些现代工具。它们用pyproject.toml代替setup.py,命令更简洁:
#- 用Poetry初始化
poetry new my_package
poetry install # 本地安装
#- 打包
poetry build
#- 发布(如果需要)
poetry publish
你可能会问:"我自己写的库,我自己调用,这不是脱裤子放屁吗?直接写函数不就行了?"
错! 这背后有深刻的软件工程思想:
把通用功能抽成库,可以让:
✦ 业务代码更干净(只关注业务逻辑)
✦ 库代码可独立测试、维护
✦ 多个项目复用同一个库(避免复制粘贴)
用库的形式,你可以:
✦ 升级库版本(比如修复bug)而不影响业务代码
✦ 回滚到旧版本(如果新版本有问题)
✦ 声明依赖版本(install_requires)
在团队中,库是"公共组件"。A同学开发了utils库,B、C、D同学都可以用,而不是每人复制一份代码(然后各自改出bug)。
A模块导入B,B又导入A——Python会懵圈。解决方案:重构代码,或用importlib动态导入。
你的库依赖requests>=2.0,但用户项目依赖requests==1.0——冲突!解决方案:尽量少声明依赖,或用宽松的版本范围(如requests>=2.0,<3.0)。
你的库叫utils,但用户项目里也有个utils.py——import utils到底导入谁?解决方案:起个独特的包名(如mycompany_utils),避免常见单词。
没有__init__.py的文件夹不是包!Python 3.3+支持"命名空间包",但最好还是老老实实加__init__.py。
一旦发布到PyPI,这个版本就"钉死"了。你不能修改已发布的代码(但可以发布新版本)。所以发布前要充分测试!