Pengendalian Kunci API Selamat dalam Projek Python

Panduan untuk mengurus kunci API dan pembolehubah persekitaran dengan betul dalam projek Python

? pengenalan

Apabila bekerja dengan API dalam Python, anda selalunya perlu menggunakan kunci API atau bukti kelayakan sensitif yang lain. Adalah penting untuk mengurus kunci ini dengan selamat untuk mengelakkan kebocoran maklumat sensitif atau secara tidak sengaja menyerahkannya ke repositori Git anda.

Untuk demonstrasi lengkap, lihat repositori GitHub saya Secure-API-Key-Handling, Ia menampilkan apl sembang Streamlit yang menguruskan kunci API dengan selamat menggunakan fail .env dan pakej python-dotenv semasa berinteraksi dengan model AI Generatif Gemini .

? Bermula

Ikuti langkah ini untuk menyediakan projek anda bagi pengendalian kunci API yang selamat:

1. Pasang Ketergantungan

Anda memerlukan pakej python-dotenv untuk memuatkan pembolehubah persekitaran daripada fail .env.

pip install python-dotenv

2. Sediakan Fail .env

Buat fail .env dalam akar projek anda, tempat anda akan menyimpan kunci API anda dan pembolehubah khusus persekitaran yang lain:

# .env
API_KEY=your_api_key_here

Penting: Fail .env ini tidak boleh disimpan dalam repositori anda. Kami akan mengkonfigurasi .gitignore untuk memastikannya.

3. Tambahkan .env pada .gitignore

Tambah baris berikut pada fail .gitignore anda untuk memastikan .env tidak ditolak ke Git:

# .gitignore
.env

5. Sediakan Fail .env.example

Untuk pembangun lain yang mengusahakan projek anda, sertakan fail .env.example sebagai templat:

# .env.example
API_KEY=your_api_key_here

Fail ini tidak akan mengandungi data sensitif, tetapi ia memberikan contoh pembolehubah yang diperlukan untuk menjalankan projek. Pembangun lain boleh menyalin fail ini ke .env dan menambah bukti kelayakan mereka sendiri.

cp .env.example .env

? Kesilapan Biasa yang Perlu Dielakkan

• Kekunci API Pengekodan Keras: Jangan sekali-kali maklumat sensitif kod keras secara langsung dalam kod Python anda.

# BAD EXAMPLE: Never do this
api_key = "hardcoded_api_key"

• Melakukan fail .env : Pastikan .env sentiasa disertakan dalam .gitignore untuk mengelak menolaknya secara tidak sengaja ke kawalan versi.

• Menolak Persekitaran Maya: Sentiasa kecualikan persekitaran maya (seperti venv) daripada Git:
  

# .gitignore
venv/

? Sumber:

• Repositori GitHub Pengendalian Kunci API Selamat
• 8 Petua untuk Menggunakan Kunci API dengan Selamat

Atas ialah kandungan terperinci Pengendalian Kunci API Selamat dalam Projek Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!