展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 如何搭建Python项目自动化打包流程_配置Setuptools与PyProject

如何搭建Python项目自动化打包流程_配置Setuptools与PyProject

PyProject.toml:现代Python打包的基石 在Python打包领域,pyproject.toml 已经成为事实上的标准。整个生态,包括 setuptools 本身,都已全面转向基于此文件的配置方式。如果你还在直接编写 setup.py,那可要注意了——这种做法不仅已经过时,而且在 pi

本文目录

    PyProject.toml:现代Python打包的基石

    如何搭建Python项目自动化打包流程_配置Setuptools与PyProject

    在Python打包领域,pyproject.toml 已经成为事实上的标准。整个生态,包括 setuptools 本身,都已全面转向基于此文件的配置方式。如果你还在直接编写 setup.py,那可要注意了——这种做法不仅已经过时,而且在 pip ≥23.1 及最新版本的 build 工具中,很可能会触发警告,甚至直接导致构建失败。

    第一步:在 pyproject.toml 中声明构建后端

    很多项目在第一步就卡住了:运行 python -m build 时,报错 ModuleNotFoundError: No module named 'setuptools.build_meta',或者提示“no build backend specified”。问题的根源很简单:缺少了关键的 build-backend 声明。

    • 必须在 [build-system] 段落中,明确指定 build-backend = "setuptools.build_meta"。
    • requires 列表里至少要包含 "setuptools>=61.0"(这个版本才开始支持PEP 621)和 "wheel"(生成 .whl 文件所必需)。
    • 如果计划使用 setuptools_scm 来自动管理版本号,别忘了在 requires 里额外加上 "setuptools-scm[toml]>=8.0"。
    [build-system]
    requires = ["setuptools>=61.0", "wheel"]
    build-backend = "setuptools.build_meta"

    第二步:用 PEP 621 标准化项目元数据(彻底告别 setup.py)

    现在,你不再需要 setup.py 或 setup.cfg 了。所有项目信息都应该统一写入 [project] 段落,这是 setuptools 61.0+ 原生支持的现代写法。

    • name、version、description、readme、requires-python 是必填项。
    • dependencies 字段替代了旧的 install_requires,格式是字符串列表,并且支持完整的PEP 508表达式(例如 "requests>=2.25; platform_system != 'Windows'")。
    • optional-dependencies 对应原来的 extras_require,键名就是 extra 的名称(比如 dev),值是对应的依赖列表。
    • 这里有个关键点:如果你想启用 setuptools_scm 来自动从 __version__ 或 Git tag 提取版本,就必须删除这里的 version 字段,否则两者会产生冲突。
    [project]
    name = "mylib"
    version = "0.1.0"
    description = "A sample package"
    readme = "README.md"
    requires-python = ">=3.8"
    dependencies = ["requests>=2.25"]
    
    [project.optional-dependencies]
    dev = ["pytest>=7.0", "black"]

    第三步:配置动态版本号(setuptools_scm 要点解析)

    手动维护 version 字段太容易出错了。setuptools_scm 可以从 Git commit 或 tag 自动生成版本号,非常方便,但配置上有些细节需要注意,否则很容易失效。

    立即学习“Python免费学习笔记(深入)”;

    • 首先,确保项目根目录是一个 Git 仓库(包含 .git/ 目录),并且至少有一个带有语义化标签的 commit(例如 v0.1.0)。
    • 在 [build-system] 的 requires 列表中加入 "setuptools-scm[toml]>=8.0"。
    • 删除 [project] 中的 version 字段,这是让 setuptools_scm 生效的前提。
    • 如果需要自定义行为,可以添加 [tool.setuptools_scm] 段落。例如,设置回退版本:fallback_version = "0.0.0";或者禁用本地节点标记:local_scheme = "no-local-version"。

    执行打包与常见陷阱规避

    执行 python -m build 命令,默认会同时生成源码包(sdist,即 .tar.gz)和二进制包(wheel,即 .whl)。但在实际的 CI/CD 流程中,我们常常需要控制输出类型,或者跳过某些步骤。

    • 只构建 wheel:python -m build --wheel;只构建源码包:python -m build --sdist。
    • 如果遇到报错 error: invalid command 'bdist_wheel',这通常意味着 wheel 包没有被列在 build-system.requires 中。
    • 打包完成后,建议用 twine check dist/* 检查包的元数据是否合规。注意,不是所有警告都是致命的,但像 InvalidDistribution 这类错误必须修复。
    • 上传到 PyPI 前,务必确认 project.urls、project.authors 等字段都已填写。一个没有描述或作者信息的包,是会被 PyPI 直接拒绝的。

    最后,分享两个最容易被忽略的陷阱。首先是 Git 仓库的状态:setuptools_scm 默认要求工作区是干净的(没有未提交的更改),否则它可能会静默地回退到 fallback_version。你需要在配置中显式允许“脏”提交(dirty = true)来避免这个问题。其次,文件位置也很关键:pyproject.toml 必须放在项目的根目录下,并且不能被 MANIFEST.in 排除(当然,在现代配置下,大多数项目已经不再需要 MANIFEST.in 文件了)。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Python
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    PixPix 网页版
    PixPix 网页版

    PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。