一步一步：用 Poetry 建立你的第一個 Python 函式庫（第一部分）

學習如何創建你的第一個 Python 庫！在本系列文章中，我們將引導您完成使用 Poetry 建立和發布 Python 庫的過程。讓我們從建立一個小型計算器應用程式開始，涵蓋從初始配置到基本功能的實現和測試的所有內容。在本系列結束時，您將準備好您的庫，可以在 PyPI 上與世界分享。

什麼是詩？

Poetry 是 Python 專案的依賴管理和打包工具。它透過自動化許多傳統上需要多種工具的任務，簡化了建立和維護程式庫和應用程式的過程。 Poetry 附帶了您可能需要的所有工具來確定性地管理您的專案。以下是詩歌的一些主要優點：

• 建置專案：使用單一命令輕鬆建置和打包您的專案。
• 分享您的作品：透過在 PyPI 上發布您的作品來讓人們了解您的作品。
• 檢查依賴項的狀態：只需一個指令即可查看專案的依賴項。
• 依賴解析：Poetry 附帶一個詳盡的依賴解析器，如果存在的話，它總是會找到解決方案。
• 隔離：Poetry 使用配置的虛擬環境或建立自己的虛擬環境以始終與您的系統隔離。
• 直觀的 CLI：Poetry 命令直觀且易於使用，預設敏感但可設定。

憑藉著這些優勢，Poetry 成為開發 Python 專案的強大而高效的工具。

在啟動 Python 函式庫之前我們需要什麼？

在開始編寫程式碼之前，我們需要設定我們的開發環境。以下是確保您準備好一切的步驟：

檢查Python版本

首先，我們需要確保您安裝了最新版本的Python。若要檢查系統上安裝的 Python 版本，請在終端機中執行下列命令：

雷雷

如果您還沒有安裝Python或需要更新它，您可以從Python官方網站下載並安裝。

安裝詩歌

確保安裝了最新版本的Python後，下一步是安裝Poetry。您可以按照官方文件中詳細說明安裝 Poetry。這是一個快速安裝指令：

雷雷

啟動您的圖書館：第一步

第 1 步：使用 Poetry 建立項目

現在我們已經安裝了 Python 和 Poetry，是時候開始我們的計算器專案了。 Poetry 可以透過簡單的指令輕鬆建立新專案。

導航到要建立專案的目錄並在終端機中執行以下命令：

雷雷

此命令為您建立一個新的專案結構，其中包括必要的資料夾和檔案。

雷雷

讓我們來了解生成的結構：

• README.md：描述您的專案的文件檔案。
• calculator/：包含應用程式原始碼的資料夾。
• tests/：單元測試的資料夾。
• pyproject.toml：Poetry 的主要設定檔。

第2步：實現計算器功能

現在讓我們在calculator/calculator.py 檔案中建立計算器函數。

雷雷

開啟calculator.py文件，實現基本計算器功能：

雷雷

步驟 3：測試計算器功能

測試對於確保軟體品質、提供錯誤修復和程式碼演化的可靠性至關重要。在此範例中，我們將使用單元測試來驗證我們的計算器功能。讓我們設定測試環境並編寫一些測試案例以確保數學運算正確運作。

配置測試環境

首先加入 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中文網其他相關文章！