”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 一步一步:用 Poetry 创建你的第一个 Python 库(第一部分)

一步一步:用 Poetry 创建你的第一个 Python 库(第一部分)

发布于2024-07-30
浏览:941

Passo a Passo: Criando Sua Primeira Biblioteca em Python com Poetry (Parte I)

了解如何创建您的第一个 Python 库!在本系列文章中,我们将指导您完成使用 Poetry 创建和发布 Python 库的过程。让我们从构建一个小型计算器应用程序开始,涵盖从初始配置到基本功能的实现和测试的所有内容。在本系列结束时,您将准备好您的库,可以在 PyPI 上与世界共享。

什么是诗?

Poetry是Python项目的依赖管理和打包工具。它通过自动化许多传统上需要多种工具的任务,简化了创建和维护库和应用程序的过程。 Poetry 附带了您可能需要的所有工具来确定性地管理您的项目。以下是诗歌的一些主要优点:

  • 构建项目:使用单个命令轻松构建和打包您的项目。
  • 分享您的作品:通过在 PyPI 上发布您的作品来让人们了解您的作品。
  • 检查依赖项的状态:只需一个命令即可查看项目的依赖项。
  • 依赖解析:Poetry 带有一个详尽的依赖解析器,如果存在的话,它总是会找到一个解决方案。
  • 隔离:Poetry 使用配置的虚拟环境或创建自己的虚拟环境以始终与您的系统隔离。
  • 直观的 C​​LI:Poetry 命令直观且易于使用,默认敏感但可配置。

凭借这些优势,Poetry 成为开发 Python 项目的强大而高效的工具。

在启动 Python 库之前我们需要什么?

在开始编写代码之前,我们需要设置我们的开发环境。以下是确保一切准备就绪的步骤:

检查Python版本

首先,我们需要确保您安装了最新版本的 Python。要检查系统上安装的 Python 版本,请在终端中运行以下命令:

python --version

如果您尚未安装Python或需要更新Python,您可以从Python官方网站下载并安装。

安装诗歌

确保安装了最新版本的Python后,下一步是安装Poetry。您可以按照官方文档中详细说明安装 Poetry。这是一个快速安装命令:

curl -sSL https://install.python-poetry.org | python3 -

启动您的图书馆:第一步

第 1 步:使用 Poetry 创建项目

现在我们已经安装了 Python 和 Poetry,是时候开始我们的计算器项目了。 Poetry 可以通过简单的命令轻松创建新项目。

导航到要创建项目的目录并在终端中运行以下命令:

poetry new calculator
cd calculator

此命令为您创建一个新的项目结构,其中包括必要的文件夹和文件。

calculator/
├── README.md
├── calculator
│   └── __init__.py
├── pyproject.toml
└── tests
    └── __init__.py

让我们了解一下生成的结构:

  • README.md:描述您的项目的文档文件。
  • calculator/:包含应用程序源代码的文件夹。
  • tests/:单元测试的文件夹。
  • pyproject.toml:Poetry的主要配置文件。

第2步:实现计算器功能

现在让我们在calculator/calculator.py 文件中创建计算器函数。

calculator/
├── calculator.py
├── __init__.py

打开calculator.py文件,实现基本计算器功能:

def add(a, b):
    return a   b

def subtract(a, b):
    return a - b

def multiply(a, b):
    return a * b

def divide(a, b):
    if b == 0:
        raise ValueError("Não é possível dividir por zero")
    return a / b

步骤 3:测试计算器功能

测试对于保证软件质量、提供错误修复和代码演化的可靠性至关重要。在此示例中,我们将使用单元测试来验证我们的计算器功能。让我们搭建测试环境并编写一些测试用例来确保数学运算正确。

配置测试环境

开始添加 pytest 作为开发依赖项:

poetry add --dev pytest

现在,在测试文件夹中创建一个名为 test_calculator.py 的文件:

import pytest
from calculator.calculator import add, subtract, multiply, divide

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(-1, -1) == -2

def test_subtract():
    assert subtract(5, 2) == 3
    assert subtract(0, 0) == 0
    assert subtract(-1, 1) == -2
    assert subtract(-1, -1) == 0

def test_multiply():
    assert multiply(2, 3) == 6
    assert multiply(5, 0) == 0
    assert multiply(-1, 1) == -1
    assert multiply(-2, -3) == 6

def test_divide():
    assert divide(6, 2) == 3
    assert divide(5, 2) == 2.5
    assert divide(-10, 2) == -5
    with pytest.raises(ValueError):
        divide(4, 0)

最后,只需使用以下命令运行测试:

poetry run pytest

第4步:发布到GitHub

现在我们的应用程序已完成测试,让我们准备将其在 GitHub 上共享。请按照以下步骤将您的项目添加到 GitHub:

  1. 在 GitHub 上创建存储库:转到 GitHub 并为您的计算器创建一个新存储库。

  2. 将您的项目添加到存储库:

  • 如果尚未初始化,请初始化项目目录中的 Git 存储库:
git init
  • 将所有文件添加到 Git 并进行第一次提交:
git add .
git commit -m "Initial commit"
  • 将本地存储库连接到 GitHub 上的远程存储库:
git remote add origin 
  • 将文件上传到 GitHub:
git push -u origin main

现在您的项目已在 GitHub 上,并准备好与其他开发人员共享和协作。

第5步:通过Pip或Poetry安装

要直接安装您的库,只需使用以下命令:

  • 通过点:
pip install git https://github.com/seu_usuario/seu_repositorio.git
  • 通过诗歌:
poetry add git https://github.com/seu_usuario/seu_repositorio.git

接下来是什么?

在本教程的第一部分中,我们介绍了使用 Poetry 创建 Python 库的基本基础知识。我们首先设置了开发环境,使用 pytest 实现了一个带有单元测试的基本计算器,并在 GitHub 上共享了该项目以供协作。

在本教程的下一部分中,我们将探索如何将您的库发布到 PyPI(标准 Python 包存储库),并学习如何直接从 PyPI 使用 Poetry 或 pip 安装它。这不仅可以让其他开发人员更轻松地使用您的库,还可以帮助您融入 Python 社区。

恭喜您走到这一步!我希望您喜欢创建 Python 库。请随时在评论中分享问题或建议。现在让我们进入第二部分,继续我们与 Python 社区的合作之旅。

参考

  • Canal Eduardo Mendes (@Dunossauro) 从头开始​​创建 python 包:从需求到部署
  • 诗歌文献
  • 诗歌:以简单的方式构建 Python 包
版本声明 本文转载于:https://dev.to/domdias/passo-a-passo-criando-sua-primeira-biblioteca-em-python-com-poetry-parte-i-2alj?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 如何将MySQL数据库添加到Visual Studio 2012中的数据源对话框中?
    如何将MySQL数据库添加到Visual Studio 2012中的数据源对话框中?
    在Visual Studio 2012 尽管已安装了MySQL Connector v.6.5.4,但无法将MySQL数据库添加到实体框架的“ DataSource对话框”中。为了解决这一问题,至关重要的是要了解MySQL连接器v.6.5.5及以后的6.6.x版本将提供MySQL的官方Visual...
    编程 发布于2025-04-01
  • 哪种方法更有效地用于点 - 填点检测:射线跟踪或matplotlib \的路径contains_points?
    哪种方法更有效地用于点 - 填点检测:射线跟踪或matplotlib \的路径contains_points?
    在Python Matplotlib's path.contains_points FunctionMatplotlib's path.contains_points function employs a path object to represent the polygon.它...
    编程 发布于2025-04-01
  • 为什么不使用CSS`content'属性显示图像?
    为什么不使用CSS`content'属性显示图像?
    在Firefox extemers属性为某些图像很大,&& && && &&华倍华倍[华氏华倍华氏度]很少见,却是某些浏览属性很少,尤其是特定于Firefox的某些浏览器未能在使用内容属性引用时未能显示图像的情况。这可以在提供的CSS类中看到:。googlepic { 内容:url(&#...
    编程 发布于2025-04-01
  • 为什么PYTZ最初显示出意外的时区偏移?
    为什么PYTZ最初显示出意外的时区偏移?
    与pytz 最初从pytz获得特定的偏移。例如,亚洲/hong_kong最初显示一个七个小时37分钟的偏移: 差异源利用本地化将时区分配给日期,使用了适当的时区名称和偏移量。但是,直接使用DateTime构造器分配时区不允许进行正确的调整。 example pytz.timezone(...
    编程 发布于2025-04-01
  • 如何将来自三个MySQL表的数据组合到新表中?
    如何将来自三个MySQL表的数据组合到新表中?
    mysql:从三个表和列的新表创建新表 答案:为了实现这一目标,您可以利用一个3-way Join。 选择p。*,d.content作为年龄 来自人为p的人 加入d.person_id = p.id上的d的详细信息 加入T.Id = d.detail_id的分类法 其中t.taxonomy =...
    编程 发布于2025-04-01
  • PHP阵列键值异常:了解07和08的好奇情况
    PHP阵列键值异常:了解07和08的好奇情况
    PHP数组键值问题,使用07&08 在给定数月的数组中,键值07和08呈现令人困惑的行为时,就会出现一个不寻常的问题。运行print_r($月份)返回意外结果:键“ 07”丢失,而键“ 08”分配给了9月的值。此问题源于PHP对领先零的解释。当一个数字带有0(例如07或08)的前缀时,PHP将...
    编程 发布于2025-04-01
  • 在GO中构造SQL查询时,如何安全地加入文本和值?
    在GO中构造SQL查询时,如何安全地加入文本和值?
    在go中构造文本sql查询时,在go sql queries 中,在使用conting and contement和contement consem per时,尤其是在使用integer per当per当per时,per per per当per. [&​​&&&&&&&&&&&&&&&默元组方法在...
    编程 发布于2025-04-01
  • 如何在Java字符串中有效替换多个子字符串?
    如何在Java字符串中有效替换多个子字符串?
    在java 中有效地替换多个substring,需要在需要替换一个字符串中的多个substring的情况下,很容易求助于重复应用字符串的刺激力量。 However, this can be inefficient for large strings or when working with nu...
    编程 发布于2025-04-01
  • Python读取CSV文件UnicodeDecodeError终极解决方法
    Python读取CSV文件UnicodeDecodeError终极解决方法
    在试图使用已内置的CSV模块读取Python中时,CSV文件中的Unicode Decode Decode Decode Decode decode Error读取,您可能会遇到错误的错误:无法解码字节 在位置2-3中:截断\ uxxxxxxxx逃脱当CSV文件包含特殊字符或Unicode的路径逃...
    编程 发布于2025-04-01
  • 如何使用Python的请求和假用户代理绕过网站块?
    如何使用Python的请求和假用户代理绕过网站块?
    如何使用Python的请求模拟浏览器行为,以及伪造的用户代理提供了一个用户 - 代理标头一个有效方法是提供有效的用户式header,以提供有效的用户 - 设置,该标题可以通过browser和Acterner Systems the equestersystermery和操作系统。通过模仿像Chro...
    编程 发布于2025-04-01
  • 如何使用FormData()处理多个文件上传?
    如何使用FormData()处理多个文件上传?
    )处理多个文件输入时,通常需要处理多个文件上传时,通常是必要的。 The fd.append("fileToUpload[]", files[x]); method can be used for this purpose, allowing you to send multi...
    编程 发布于2025-04-01
  • 版本5.6.5之前,使用current_timestamp与时间戳列的current_timestamp与时间戳列有什么限制?
    版本5.6.5之前,使用current_timestamp与时间戳列的current_timestamp与时间戳列有什么限制?
    在时间戳列上使用current_timestamp或MySQL版本中的current_timestamp或在5.6.5 此限制源于遗留实现的关注,这些限制需要对当前的_timestamp功能进行特定的实现。 创建表`foo`( `Productid` int(10)unsigned not n...
    编程 发布于2025-04-01
  • 如何简化PHP中的JSON解析以获取多维阵列?
    如何简化PHP中的JSON解析以获取多维阵列?
    php 试图在PHP中解析JSON数据的JSON可能具有挑战性,尤其是在处理多维数组时。要简化过程,建议将JSON作为数组而不是对象解析。执行此操作,将JSON_DECODE函数与第二个参数设置为true:[&&&&& && &&&&& json = JSON = JSON_DECODE($ j...
    编程 发布于2025-04-01
  • 为什么使用Firefox后退按钮时JavaScript执行停止?
    为什么使用Firefox后退按钮时JavaScript执行停止?
    导航历史记录问题:JavaScript使用Firefox Back Back 此行为是由浏览器缓存JavaScript资源引起的。要解决此问题并确保在后续页面访问中执行脚本,Firefox用户应设置一个空功能。 警报'); }; alert('inline Alert')...
    编程 发布于2025-04-01
  • 如何正确使用与PDO参数的查询一样?
    如何正确使用与PDO参数的查询一样?
    在pdo 中使用类似QUERIES在PDO中的Queries时,您可能会遇到类似疑问中描述的问题:此查询也可能不会返回结果,即使$ var1和$ var2包含有效的搜索词。错误在于不正确包含%符号。通过将变量包含在$ params数组中的%符号中,您确保将%字符正确替换到查询中。没有此修改,PDO...
    编程 发布于2025-04-01

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3