python 本地三方库打包whl

原创

mob64ca12eb3858 2024-09-18 04:04:53 ©著作权

文章标签 Python bash python 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12eb3858的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python 本地第三方库打包为 whl

在 Python 开发中，调试和分享自己编写的代码都是常见的需求。打包我们的代码为 wheel 文件（.whl），可以方便地分享给他人或部署在服务器上。本文将系统地介绍如何打包本地的第三方库，IT 领域的轮子（wheel）是一个重要的概念，它为 Python 模块提供了一种简便的分发方式。

什么是 Wheel？

Wheel 是一种二进制包格式，是 Python 标准库开发的一个重要组成部分，用于高效地分发 Python 项目。与传统的 setup.py 文件相比，wheel 文件不需要用户进行编译，安装速度更快。

准备工作

在开始之前，请确保已安装 setuptools 和 wheel 库。可以使用以下命令进行安装：

pip install setuptools wheel

创建一个简单的 Python 项目

首先，我们需要一个简单的 Python 项目。我们可以创建一个文件夹，并在其中写入一些代码。

mkdir my_package
cd my_package

在 my_package 文件夹中创建一个名为 example.py 的文件，内容如下：

def greet(name):
    return f"Hello, {name}!"

接下来，我们需要创建一个 setup.py 文件，内容如下：

from setuptools import setup

setup(
    name='my_first_package',
    version='0.1',
    description='A simple greeting package',
    author='Your Name',
    author_email='your_email@example.com',
    py_modules=['example'],
)

打包为 Wheel 文件

在项目目录下，通过以下命令打包我们的 Python 项目：

python setup.py bdist_wheel

执行完此命令后，将会在 dist 文件夹中生成一个 .whl 文件（例如：my_first_package-0.1-py3-none-any.whl）。

查看生成的 Wheel 文件

我们可以运行以下命令来查看轮子文件的详细信息：

pip show my_first_package

安装和使用 Wheel 文件

为了安装我们刚刚打包的 wheel 文件，可以在项目中使用以下命令：

pip install dist/my_first_package-0.1-py3-none-any.whl

安装完后，我们可以在 Python 中通过以下方式使用：

from example import greet

print(greet("World"))  # 输出: Hello, World!

状态图

接下来，我们为打包过程创建一个状态图，以便更好地理解整个流程。

stateDiagram
    [*] --> 创建项目
    创建项目 --> 编写代码
    编写代码 --> 创建setup.py
    创建setup.py --> 打包为wheel
    打包为wheel --> 生成whl文件
    生成whl文件 --> [*]

旅行图

我们来展示一下使用该 package 的旅程，如下：

journey
    title 使用自定义 Python Package 的旅程
    section 创建项目
      创建目录: 5: 用户
      编写代码: 4: 用户
    section 打包过程
      创建 setup.py: 3: 用户
      运行打包命令: 2: 用户
    section 安装和使用
      安装 whl 文件: 4: 用户
      导入模块: 5: 用户
      调用函数: 5: 用户