讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

如何在复杂的Python工程中编写用于setup.py扩展的自定义安装命令?

大萱酱_2593

大萱酱_2593

发布时间:2026-11-18 09:40:20

|

927人浏览过

|

来源于php中文网

原创

setup.py自定义install命令被忽略,因pip默认跳过它而走wheel构建路径;真正生效的是build_py、build_ext或develop等命令,推荐迁移到pyproject.toml构建系统。

如何在复杂的python工程中编写用于setup.py扩展的自定义安装命令?

setup.py里自定义install命令为什么总被忽略?

因为setuptools默认的install命令在现代pip安装流程中基本不执行——pip会跳过它,直接走bdist_wheel + pip install的构建路径。你写的class MyInstall(install)可能根本没机会运行。

真正起作用的是build、build_ext或develop这类命令,或者更可靠的替代方案:cmdclass中注册build_py或build_ext,并在其中注入逻辑;或者用pyproject.toml + build-system.requires + 自定义build_backend(推荐但需迁移成本)。

  • 如果你仍坚持用setup.py,优先重载build_py:它在源码安装和开发模式下都稳定触发
  • 避免重载install或easy_install:它们在pip ≥21.3+中已被标记为“legacy”,行为不可靠
  • 验证是否生效:用python setup.py build_py -v手动触发,观察你的run()是否打印日志

如何让自定义命令支持--dry-run和--force-rebuild?

自定义命令必须显式处理dry_run标志,否则在CI或测试环境里会误执行副作用(比如删文件、调API)。setuptools.Command基类已提供self.dry_run属性,但不会自动拦截操作——你得自己检查。

例如,在生成Cython代码或下载预编译二进制时,应包裹关键动作:

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

Camoufox Open Source Anti-Detect Browser for Python Automation
Camoufox Open Source Anti-Detect Browser for Python Automation

Camoufox 是一个基于 Firefox 构建的开源反检测浏览器,为 Python 自动化工作流程提供强大的指纹注入和反机器人检测规避功能。它与 Playwright 集成,以提供能够绕过现代机器人检测系统的隐身浏览能力。

下载
def run(self):
    if self.dry_run:
        self.announce("would generate bindings for platform", level=2)
        return
    # 实际逻辑
    generate_bindings()
  • --force-rebuild不是内置参数,需手动添加:self.user_options.append(('force-rebuild', 'f', 'rebuild even if outputs exist')),再在initialize_options()里设默认值self.force_rebuild = None
  • 判断重建条件时,别只依赖os.path.exists(),要考虑时间戳、哈希或版本号——尤其当输入是远程资源时
  • 所有文件写入操作前,先用mkpath()确保父目录存在,否则dry_run=True下会报错

自定义build_ext如何安全地调用CMake并传递Python ABI信息?

直接在build_ext.run()里subprocess.run(['cmake', ...])容易出问题:CMake可能找不到Python解释器、头文件路径或链接库,尤其在conda或pyenv环境下。

正确做法是复用setuptools已解析的Python配置,并通过CMAKE_PREFIX_PATH或-DPYTHON_EXECUTABLE显式传参:

from setuptools import build_ext
import sysconfig
<p>class CMakeBuild(build_ext):
def build_extension(self, ext):
cmake_args = [
f"-DPYTHON_EXECUTABLE={sys.executable}",
f"-DPYTHON_INCLUDE_DIR={sysconfig.get_path('include')}",
f"-DPYTHON_LIBRARY={sysconfig.get_config_var('LIBDIR')}",
]
subprocess.run(["cmake", ext.sourcedir] + cmake_args, check=True)
  • 不要硬编码/usr/include/python3.9m——用sysconfig.get_path('include'),它能适配musl、conda、framework builds等场景
  • Linux上LIBDIR可能指向lib64,而CMake默认找lib;建议改用sysconfig.get_config_var('LIBRARY')或完整路径sysconfig.get_config_var('LIBDIR') + '/' + sysconfig.get_config_var('LDLIBRARY')
  • 如果CMake项目输出so/dylib,确保ext.name与CMake里pybind11_add_module()的模块名一致,否则import失败

为什么自定义命令在pip install -e .里不执行?

因为pip install -e .默认调用develop命令,而不是build或install。你重载的build_py不会自动被develop调用。

解决方法只有两个:要么重载develop本身,要么让develop显式依赖你的命令(通过get_sub_commands()或run_command()):

from setuptools.command.develop import develop
<p>class DevelopWithGen(develop):
def run(self):
self.run_command("build_py")  # 触发你的build_py逻辑
super().run()
  • 别在develop.run()里直接复制build_py.run()逻辑——那会绕过build_py自身的依赖检查和缓存机制
  • 如果自定义逻辑涉及生成文件,记得把输出路径加入easy_install.pth的搜索路径,否则import时找不到模块:用self.distribution.package_dir或修改sys.path(仅调试用)
  • 最稳妥的方式是放弃setup.py扩展,改用pyproject.toml中定义[build-system]和[project.optional-dependencies],配合build插件(如setuptools-scm或自研build-backend)

复杂工程里,setup.py扩展的维护成本远高于收益。真正需要动态生成代码或绑定的场景,应该把逻辑下沉到构建阶段(如CMakeLists.txt或pyproject.toml的build hooks),而不是塞进一个被pip逐步弃用的命令系统里。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1951

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5524

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1889

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

33757

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3967

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3967

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1283

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

636

2023.08.10

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn