讲师中心 微信公众号
AI工具推荐 视频效率加速

Python开源项目中setup.py配置文件的基本骨架应该怎么编写?

老杰小哥_7064

老杰小哥_7064

发布时间:2026-11-02 09:18:30

|

240人浏览过

|

来源于php中文网

原创

一个能被 pip install -e . 正确识别安装的最小可用 setup.py 骨架只需三要素:包名、版本、Python 兼容性声明,即 from setuptools import setup; setup(name="myproject", version="0.1.0", python_requires=">=3.8")。

python开源项目中setup.py配置文件的基本骨架应该怎么编写?

setup.py 最小可用骨架长什么样

一个能被 pip install -e . 正确识别并安装的 setup.py,核心只需三要素:包名、版本、Python 兼容性声明。其他字段全是可选的,但漏掉 name 或 version 会导致 pip 报错 AttributeError: 'Distribution' object has no attribute 'name'。

最简骨架如下:

from setuptools import setup
<p>setup(
name="myproject",
version="0.1.0",
python_requires=">=3.8",
)

注意:setuptools 是当前事实标准,distutils 已在 Python 3.12 中彻底移除,别再用 from distutils.core import setup。

如何正确声明源码包和入口点

如果项目结构是 src/myproject/__init__.py,直接写 packages=["myproject"] 会找不到模块——因为 setup.py 默认从当前目录找包,而源码在 src/ 下。

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

两种解法:

  • 用 package_dir={"": "src"} 告诉 setuptools 源码根目录在哪,再配合 find_packages("src")
  • 用 py_modules 手动列单文件模块(适合极简工具)

命令行入口点(如运行 mycmd --help)必须通过 entry_points 注册:

python-flask-vue-creator
python-flask-vue-creator

创建 Flask + Vue.js 全栈项目,采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发:创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词:新建项目、创建项目、搭建项目、Flask项目、Vue项目。

下载
setup(
    # ...
    packages=find_packages("src"),
    package_dir={"": "src"},
    entry_points={
        "console_scripts": [
            "mycmd=myproject.cli:main",
        ],
    },
)

这里 myproject.cli:main 表示 src/myproject/cli.py 里的 main() 函数;路径错误或函数不存在,安装后执行会报 ModuleNotFoundError 或 AttributeError。

依赖管理该写在 setup.py 还是 pyproject.toml

现在应该写在 pyproject.toml 里,setup.py 不再负责声明依赖。

如果你还在 setup.py 里写 install_requires,它仍会被读取(兼容性保留),但已不是推荐路径。真正现代的做法是:

  • 删掉 setup.py 中所有 install_requires、extras_require 等依赖字段
  • 在 pyproject.toml 中用 [project.dependencies] 和 [project.optional-dependencies]
  • setup.py 仅保留元数据(name、version、packages 等)或完全删除(改用 setup.cfg 或纯 pyproject.toml)

混用两套机制容易导致 pip install 和 build 解析出不同依赖集,CI 环境尤其容易翻车。

version 怎么动态生成才安全

硬编码 version="0.1.0" 在发布时容易忘记更新。常见动态方案有三种,但只有两种靠谱:

  • ✅ 从 git describe 读(需确保每次提交都打 tag):
    version = subprocess.check_output(["git", "describe", "--tags"]).decode().strip()
  • ✅ 从独立 myproject/_version.py 文件读(推荐):
    该文件只含 __version__ = "0.1.0",setup.py 用 exec 或正则提取,不引入运行时依赖
  • ❌ 从 __init__.py 导入(会导致安装时提前导入包,可能触发未满足的依赖报错)

动态 version 的最大陷阱是:构建 wheel 时若 git 命令失败(如 CI 环境没带 git history),整个构建就中断。务必加 try/except fallback 到默认值。

热门AI工具

更多
Loomy
Loomy Hot

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

DeepSeek

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

VibeKnow
VibeKnow Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

火山引擎

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

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Atoms
Atoms Hot

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

WorkBuddy

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

相关专题

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

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

1851

2023.07.20

python能做什么
python能做什么

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

5004

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29997

2023.08.03

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

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

3567

2023.08.04

python eval
python eval

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

3587

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

0

2026.11.02

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

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