Langkah demi Langkah: Mencipta Perpustakaan Python Pertama Anda dengan Puisi (Bahagian I)

Ketahui cara mencipta pustaka Python pertama anda! Dalam siri siaran ini, kami akan membimbing anda melalui proses mencipta dan menerbitkan perpustakaan Python menggunakan Puisi. Mari mulakan dengan membina aplikasi kalkulator kecil, meliputi segala-galanya daripada konfigurasi awal kepada pelaksanaan dan ujian fungsi asas. Pada penghujung siri ini, anda akan menyediakan perpustakaan anda untuk dikongsi dengan dunia di PyPI.

Apa itu Puisi?

Puisi ialah alat pengurusan pergantungan dan pembungkusan untuk projek Python. Ia memudahkan proses mencipta dan menyelenggara perpustakaan dan aplikasi dengan mengautomasikan banyak tugas yang secara tradisinya memerlukan berbilang alatan. Puisi disertakan dengan semua alat yang mungkin anda perlukan untuk mengurus projek anda secara deterministik. Berikut adalah beberapa kelebihan utama Puisi:

• Bina projek: Bina dan bungkus projek anda dengan mudah dengan satu arahan.
• Kongsi kerja anda: Buat kerja anda dikenali dengan menerbitkannya di PyPI.
• Semak status tanggungan anda: Dapatkan paparan kebergantungan projek anda dengan hanya satu arahan.
• Penyelesaian Ketergantungan: Puisi dilengkapi dengan penyelesai pergantungan yang menyeluruh, yang akan sentiasa mencari penyelesaian jika wujud.
• Pengasingan: Puisi menggunakan persekitaran maya yang dikonfigurasikan atau mencipta sendiri untuk sentiasa diasingkan daripada sistem anda.
• CLI Intuitif: Perintah puisi adalah intuitif dan mudah digunakan, sensitif lalai namun boleh dikonfigurasikan.

Dengan kelebihan ini, Puisi menonjol sebagai alat yang berkuasa dan cekap untuk membangunkan projek Python.

Apa yang kami perlukan sebelum memulakan perpustakaan Python kami?

Sebelum kita mula menulis kod, kita perlu menyediakan persekitaran pembangunan kita. Berikut ialah langkah-langkah untuk memastikan anda mempunyai segala-galanya:

Semak versi Python

Pertama, kami perlu memastikan anda memasang versi terkini Python. Untuk menyemak versi Python yang dipasang pada sistem anda, jalankan arahan berikut dalam terminal:

python --version

Jika anda belum memasang Python atau perlu mengemas kininya, anda boleh memuat turun dan memasangnya daripada tapak web Python rasmi.

Memasang Puisi

Selepas memastikan anda memasang versi terkini Python, langkah seterusnya ialah memasang Puisi. Anda boleh memasang Puisi dengan mengikuti arahan yang diperincikan dalam dokumentasi rasmi. Berikut ialah arahan pantas untuk pemasangan:

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

Memulakan Pustaka Anda: Langkah Pertama

Langkah 1: Mencipta projek dengan Puisi

Sekarang kami telah memasang Python dan Puisi, tiba masanya untuk memulakan projek kalkulator kami. Puisi memudahkan untuk mencipta projek baharu dengan arahan mudah.

Navigasi ke direktori tempat anda ingin mencipta projek anda dan jalankan arahan berikut dalam terminal:

poetry new calculator
cd calculator

Arahan ini mencipta struktur projek baharu untuk anda, yang termasuk folder dan fail penting.

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

Mari kita fahami struktur yang dihasilkan:

• README.md: Fail dokumentasi untuk menerangkan projek anda.
• kalkulator/: Folder yang mengandungi kod sumber aplikasi anda.
• ujian/: Folder untuk ujian unit anda.
• pyproject.toml: Fail konfigurasi utama untuk Puisi.

Langkah 2: Melaksanakan fungsi kalkulator

Sekarang mari kita cipta fungsi kalkulator dalam fail kalkulator/calculator.py.

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

Buka fail calculator.py dan laksanakan fungsi kalkulator asas:

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

Langkah 3: Menguji fungsi kalkulator

Pengujian adalah penting untuk menjamin kualiti perisian, memberikan kebolehpercayaan dalam pembetulan pepijat dan evolusi kod. Dalam contoh ini, kami akan menggunakan ujian unit untuk mengesahkan fungsi kalkulator kami. Mari sediakan persekitaran ujian dan tulis beberapa kes ujian untuk memastikan operasi matematik berfungsi dengan betul.

Mengkonfigurasi persekitaran ujian

Mulakan dengan menambah pytest sebagai kebergantungan pembangunan:

poetry add --dev pytest

Sekarang, buat fail yang dipanggil test_calculator.py di dalam folder ujian:

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

Atas ialah kandungan terperinci Langkah demi Langkah: Mencipta Perpustakaan Python Pertama Anda dengan Puisi (Bahagian I). Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!