Bagaimana untuk membina dan menggunakan perpustakaan Python

Dalam pembangunan perisian, banyak projek melibatkan tugasan berulang menggunakan kod dan logik yang sama. Pengaturcara sentiasa menulis semula kod ini, mewujudkan ketidakcekapan. Contohnya termasuk pengesahan e-mel atau penjanaan rentetan rawak.

Penyelesaian adalah dengan membungkus kod ini ke dalam perpustakaan boleh guna semula. Perpustakaan ini dipasang dan digunakan merentas projek, menghapuskan pengekodan berlebihan. Kebanyakannya adalah sumber terbuka dan tersedia secara percuma.

Ini adalah amalan standard dalam bahasa seperti Python dan JavaScript. Tutorial ini memperincikan membina dan menggunakan perpustakaan Python ke PyPI, repositori pakej Python rasmi.

Gambaran Keseluruhan Projek

Tutorial ini membimbing anda membuat dan menggunakan pustaka Python sumber terbuka yang berinteraksi dengan API REST.

Perpustakaan Python

Pustaka akan membalut API Abstrak Kadar Pertukaran REST API. API ini menawarkan tiga titik akhir:

• /live: Mendapatkan semula kadar pertukaran langsung.
• /convert: Menukar amaun antara mata wang (mis., 5 USD kepada GBP).
• /historical: Mendapatkan semula kadar pertukaran sejarah untuk tempoh tertentu.

Pustaka ini memudahkan interaksi API untuk pembangun.

Keperluan Projek

Tutorial ini menganggap kecekapan pengekodan Python, termasuk pengaturcaraan berorientasikan objek (OOP) dan penggunaan fungsi. Kebiasaan dengan Git, repositori GitHub dan dorongan projek juga diperlukan.

Alat dan Pakej

Anda memerlukan:

• Python: Jurubahasa (>=3.9).
• Permintaan: Untuk membuat permintaan HTTP.
• Akaun API abstrak: Untuk mendapatkan kunci API (arahan disediakan).
• Dotenv: Untuk mengurus pembolehubah persekitaran.
• Puisi: Alat pengurusan dan pembungkusan pergantungan Python.

Mencipta Projek

1. Buat direktori projek:

   mkdir exchangeLibrary

2. Pasang virtualenv (jika belum dipasang):

   pip install virtualenv

3. Navigasi ke direktori projek:

   cd exchangeLibrary

4. Buat dan aktifkan persekitaran maya:

   virtualenv env

   Aktifkan (Windows): .envScriptsactivate Aktifkan (Linux/macOS): source env/bin/activate

5. Pasang pakej yang diperlukan:

   pip install requests poetry dotenv

6. Buka projek dalam editor kod (Kod PyCharm/VS).

Menyediakan Sumber Projek

1. Buat direktori src: Di dalam, buat exchange_python yang mengandungi __init__.py dan exchange.py. Struktur anda sepatutnya menyerupai imej di bawah:

   

2. Buat test.py untuk ujian unit.

3. Dapatkan kunci API Abstrak anda: a. Daftar pada API Abstrak. b. Log masuk. c. Navigasi ke API Kadar Pertukaran. d. Dapatkan kunci Utama anda.

4. Buat .env fail: Tambahkan kunci API anda:

   mkdir exchangeLibrary

   Struktur anda kini sepatutnya kelihatan seperti ini:

Membina Pembalut API (exchange.py)

pip install virtualenv

(Kaedah live, historical dan convert kekal seperti yang diterangkan dalam input asal.)

Menguji Pembalut API (test.py)

1. __init__.py:

   cd exchangeLibrary

2. test.py:

   virtualenv env

3. Jalankan ujian: Anda sepatutnya melihat keputusan ujian yang berjaya.

Menggunakan Projek

1. Buat fail .gitignore: Tambah env, .env.

2. Buat fail README.md.

3. Buat pyproject.toml:

   pip install requests poetry dotenv

4. Buat repositori GitHub.

5. Inisialisasikan Git: git init

6. Tambah alat kawalan jauh: git remote add origin <your github repo>

7. Kemas kini pyproject.toml dengan URL repo GitHub anda.

8. Tekan ke GitHub.

Menggunakan PyPI

1. Buat akaun PyPI dan sahkan e-mel anda.
2. Sediakan 2FA.
3. Jana kod pemulihan.
4. Gunakan apl pengesah untuk mengimbas kod QR.
5. Dapatkan token API anda.
6. Bina pakej: poetry build
7. Tetapkan token PyPI: poetry config pypi-token.pypi <your-api-token>
8. Terbitkan: poetry publish

Penyelenggaraan Projek

Selepas kemas kini, tolak perubahan kepada GitHub, bina (poetry build) dan terbitkan semula (poetry publish), mengemas kini versi dalam pyproject.toml mengikut keperluan.

Pemasangan dan Penggunaan

mkdir exchangeLibrary

pip install virtualenv

Kesimpulan

Tutorial ini merangkumi pembinaan dan penggunaan pustaka Python ke PyPI, termasuk kemas kini dan penerbitan semula. Sumbangan anda kepada komuniti sumber terbuka membantu meningkatkan pembangunan Python.

Atas ialah kandungan terperinci Bagaimana untuk membina dan menggunakan perpustakaan Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!