不使用setup.py,打包 Python 项目
off999 2024-09-16 00:52 18 浏览 0 评论
我编写了许多开源项目,并允许其他人通过PyPI访问这些项目。为此,我需要从这些项目构建一个源代码分发版(sdist)和一个可选的wheel包,并将二者上传到PyPI。最后,这个sdist和wheel包必须要能通过pip进行安装,以便其他人使用。
我的大多数项目使用setuptools(通过一个setup.py)进行打包,因为这是长久以来实现此目的的(唯一)方法,但是,最近的两个PEP(517和518)允许我们开发新的工具。最值得注意的是,这些新工具使用了一个pyproject.toml文件,你可以在这篇文章中了解有关它的更多信息。
一段时间以来,我一直在使用这些新工具中的一种,Poetry,来管理我的应用程序。最初,我这样做是受Poetry's的文件锁支持所鼓舞的,它优于我之前使用的requirements-to-freeze系统。还有一个原因是poetry允许执行脚本,比如poetry run test,我在这篇文章中解释过。
因为我喜欢在我的应用程序中使用Poetry,所以我想我应该在我的一个库(Quart- Auth)上尝试一下,Quart- Auth是Quart的一个身份验证管理扩展。这是我正在实验的一些东西,但是我已经对下面的设置很满意了。
Setup.py 设置
由于我的项目是纯python的(没有用c代码来编译),构建要简单得多,唯一的复杂之处是我希望按照PEP 561包含一个py.typed文件。我的设置需要一个MANIFEST.in和一个 setup.py,并且关键的是使用check-manifest工具和python setup.py check来确保一切都是正确的。
来自Quart-Rate-Limiter的一个示例setup.py文件(精简至关键部分)是,
一个示例MANIFEST.in文件(同样进行了精简) 是:
Setup.py 发布过程
要构建sdist、wheel并将其推送到PyPI,一个安装了setuptools、whee和twine的环境是必需的。然后你就可以使用以下命令去构建和上传,
Poetry 设置
Poetry包含了一个方便的命令来允许你使用poetry new从头设置一个项目或者使用poetry init在现有的项目中设置一个项目。这个命令会创建pyproject.toml文件,其中包含了继续进行项目所需的足够的信息。对于Quart-Auth,我添加了一个分类器列表、存储库url、依赖项(包括用于开发的tox),并指出py.typed文件应该在构建包中,请在这里查看该文件。
就我所知,这就是所有需要设置的东西。我们现在就可以使用poetry构建Quart-Auth了。
Poetry发布
要构建sdist、wheel并将其推送到PyPI,一个安装了poetry和wheel的环境是必需的。然后你就可以使用以下命令去构建和上传,
补充:包版本用法
通常情况下,例如在Quart & Flask中,版本存储在源代码中,该代码会在setup.py中被加载或解析。
这就允许库用户以编程方式查询版本(例如quart.__about__.__version__)。这在poetry设置中显然是不可能的,但是在Python3.8中有一个更好的解决方案,
一个示例用法是当你在构建Quart-Auth文档的时候。
结论
只使用pyproject和poetry而不使用setuptools有一个重要的缺点,那就是可编辑安装,例如,pip install -e ..在没有shim的情况下是不可能执行的,看看这个讨论。这就暂时排除了在我所维护的Quart 和 Hypercorn项目中使用Poetry的可能性。
切换到poetry和pyproject.toml就意味着我距离为我的项目设置一个更简单、更清晰的配置这个目标更近了一步,即pyproject.toml中的所有东西。当我有时间的时候,我可能会转移更多的项目。
英文原文:https://pgjones.dev/blog/packaging-without-setup-py-2020/
译者:一瞬
相关推荐
- 面试官:来,讲一下枚举类型在开发时中实际应用场景!
-
一.基本介绍枚举是JDK1.5新增的数据类型,使用枚举我们可以很好的描述一些特定的业务场景,比如一年中的春、夏、秋、冬,还有每周的周一到周天,还有各种颜色,以及可以用它来描述一些状态信息,比如错...
- 一日一技:11个基本Python技巧和窍门
-
1.两个数字的交换.x,y=10,20print(x,y)x,y=y,xprint(x,y)输出:102020102.Python字符串取反a="Ge...
- Python Enum 技巧,让代码更简洁、更安全、更易维护
-
如果你是一名Python开发人员,你很可能使用过enum.Enum来创建可读性和可维护性代码。今天发现一个强大的技巧,可以让Enum的境界更进一层,这个技巧不仅能提高可读性,还能以最小的代价增...
- Python元组编程指导教程(python元组的概念)
-
1.元组基础概念1.1什么是元组元组(Tuple)是Python中一种不可变的序列类型,用于存储多个有序的元素。元组与列表(list)类似,但元组一旦创建就不能修改(不可变),这使得元组在某些场景...
- 你可能不知道的实用 Python 功能(python有哪些用)
-
1.超越文件处理的内容管理器大多数开发人员都熟悉使用with语句进行文件操作:withopen('file.txt','r')asfile:co...
- Python 2至3.13新特性总结(python 3.10新特性)
-
以下是Python2到Python3.13的主要新特性总结,按版本分类整理:Python2到Python3的重大变化Python3是一个不向后兼容的版本,主要改进包括:pri...
- Python中for循环访问索引值的方法
-
技术背景在Python编程中,我们经常需要在循环中访问元素的索引值。例如,在处理列表、元组等可迭代对象时,除了要获取元素本身,还需要知道元素的位置。Python提供了多种方式来实现这一需求,下面将详细...
- Python enumerate核心应用解析:索引遍历的高效实践方案
-
喜欢的条友记得关注、点赞、转发、收藏,你们的支持就是我最大的动力源泉。根据GitHub代码分析统计,使用enumerate替代range(len())写法可减少38%的索引错误概率。本文通过12个生产...
- Python入门到脱坑经典案例—列表去重
-
列表去重是Python编程中常见的操作,下面我将介绍多种实现列表去重的方法,从基础到进阶,帮助初学者全面掌握这一技能。方法一:使用集合(set)去重(最简单)pythondefremove_dupl...
- Python枚举类工程实践:常量管理的标准化解决方案
-
本文通过7个生产案例,系统解析枚举类在工程实践中的应用,覆盖状态管理、配置选项、错误代码等场景,适用于Web服务开发、自动化测试及系统集成领域。一、基础概念与语法演进1.1传统常量与枚举类对比#传...
- 让Python枚举更强大!教你玩转Enum扩展
-
为什么你需要关注Enum?在日常开发中,你是否经常遇到这样的代码?ifstatus==1:print("开始处理")elifstatus==2:pri...
- Python枚举(Enum)技巧,你值得了解
-
枚举(Enum)提供了更清晰、结构化的方式来定义常量。通过为枚举添加行为、自动分配值和存储额外数据,可以提升代码的可读性、可维护性,并与数据库结合使用时,使用字符串代替数字能简化调试和查询。Pytho...
- 78行Python代码帮你复现微信撤回消息!
-
来源:悟空智能科技本文约700字,建议阅读5分钟。本文基于python的微信开源库itchat,教你如何收集私聊撤回的信息。[导读]Python曾经对我说:"时日不多,赶紧用Python"。于是看...
- 登录人人都是产品经理即可获得以下权益
-
文章介绍如何利用Cursor自动开发Playwright网页自动化脚本,实现从选题、写文、生图的全流程自动化,并将其打包成API供工作流调用,提高工作效率。虽然我前面文章介绍了很多AI工作流,但它们...
- Python常用小知识-第二弹(python常用方法总结)
-
一、Python中使用JsonPath提取字典中的值JsonPath是解析Json字符串用的,如果有一个多层嵌套的复杂字典,想要根据key和下标来批量提取value,这是比较困难的,使用jsonpat...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python自定义函数 (53)
- python进度条 (67)
- python吧 (67)
- python字典遍历 (54)
- python的for循环 (65)
- python格式化字符串 (61)
- python串口编程 (60)
- python读取文件夹下所有文件 (59)
- java调用python脚本 (56)
- python操作mysql数据库 (66)
- python字典增加键值对 (53)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python人脸识别 (54)
- python多态 (60)
- python命令行参数 (53)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)