一步一步：用 Poetry 创建你的第一个 Python 库（第一部分）

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

什么是诗？

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

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

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

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

在开始编写代码之前，我们需要设置我们的开发环境。以下是确保您准备好一切的步骤：

检查Python版本

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

python --version

如果您尚未安装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 的主要配置文件。

第二步：实现计算器功能

现在让我们在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)

Por fim, basta executar os testes com o seguinte comando:

poetry run pytest

Passo 4: Publicando no GitHub

Agora que nossa aplicação já está coberta com testes, vamos prepará-la para ser compartilhada no GitHub. Siga os passos abaixo para adicionar seu projeto ao GitHub:

1. Crie um repositório no GitHub: Vá para o GitHub e crie um novo repositório para sua calculadora.

2. Adicione seu projeto ao repositório:

• Inicialize o repositório Git dentro do diretório do seu projeto se ainda não estiver inicializado:

git init

• Adicione todos os arquivos ao Git e faça o primeiro commit:

git add .
git commit -m "Initial commit"

• Conecte seu repositório local ao repositório remoto no GitHub:

git remote add origin <URL_DO_SEU_REPOSITORIO_GITHUB>

• Envie seus arquivos para o GitHub:

git push -u origin main

Agora seu projeto está no GitHub e pronto para ser compartilhado e colaborado com outros desenvolvedores.

Passo 5: Instalando via Pip ou Poetry

Para instalar sua biblioteca diretamente basta usar os seguintes comandos:

• Via Pip:

pip install git+https://github.com/seu_usuario/seu_repositorio.git

• Via Poetry:

poetry add git+https://github.com/seu_usuario/seu_repositorio.git

O que vem a seguir?

Nesta primeira parte do tutorial, cobrimos os fundamentos essenciais para criar uma biblioteca Python utilizando o Poetry. Começamos configurando o ambiente de desenvolvimento, implementamos uma calculadora básica com testes unitários usando pytest, e compartilhamos o projeto no GitHub para colaboração.

Na próxima parte deste tutorial, exploraremos como publicar sua biblioteca no PyPI, o repositório padrão de pacotes Python, e aprenderemos como instalá-la usando o Poetry ou pip diretamente do PyPI. Isso não apenas facilitará o uso da sua biblioteca por outros desenvolvedores, mas também ajudará a integrá-la com a comunidade Python.

Parabéns por chegar até aqui! Espero que esteja aproveitando a criação da sua biblioteca Python. Fique à vontade para compartilhar dúvidas ou sugestões nos comentários. Vamos agora para a Parte II e continuar nossa jornada de colaboração com a comunidade Python.

Referências

• Canal Eduardo Mendes (@Dunossauro) Criando um pacote python do zero: dos requisitos ao deploy
• Documentação Poetry
• Poetry: construindo pacotes Python de uma forma fácil

以上是一步一步：用 Poetry 创建你的第一个 Python 库（第一部分）的详细内容。更多信息请关注PHP中文网其他相关文章！