pengembangan-web-mp.com

Python konvensi penamaan file?

Saya telah melihat bagian PEP-8 ini https://www.python.org/dev/peps/pep-0008/#package-and-module-names

Saya tidak jelas apakah ini merujuk pada nama file modul/kelas/paket.

Jika saya punya satu contoh masing-masing, haruskah nama file semua huruf kecil dengan garis bawah jika sesuai? Atau sesuatu yang lain?

164
darkace

Mengutip https://www.python.org/dev/peps/pep-0008/#package-and-module-names :

Modul harus memiliki nama pendek, semua huruf kecil. Garis bawah dapat digunakan dalam nama modul jika itu meningkatkan keterbacaan. Python paket juga harus memiliki nama kecil, semua huruf kecil, meskipun penggunaan garis bawah tidak disarankan.

Untuk kelas :

Nama kelas biasanya harus menggunakan konvensi CapWords.

Dan fungsi dan nama variabel (lokal) harus:

huruf kecil, dengan kata-kata dipisahkan oleh garis bawah seperlunya untuk meningkatkan keterbacaan

Lihat jawaban ini untuk perbedaan antara modul, kelas, dan paket:

  • A Python hanyalah sebuah file sumber Python, yang dapat mengekspos kelas, fungsi, dan variabel global.
  • Paket Python hanyalah sebuah direktori dari modul Python).

Jadi PEP 8 memberitahu Anda bahwa :

  • modules (nama file) harus memiliki nama pendek, semua huruf kecil, dan mereka dapat berisi garis bawah;
  • paket (direktori) harus memiliki pendek, nama semua huruf kecil, lebih disukai tanpa garis bawah;
  • kelas harus menggunakan konvensi CapWords.

PEP 8 memberi tahu bahwa nama harus pendek; jawaban ini memberikan ikhtisar yang baik tentang apa yang harus dipertimbangkan ketika membuat nama variabel, yang juga berlaku untuk nama lain (untuk kelas, paket, dll.):

  • nama variabel bukan deskriptor penuh;
  • letakkan detail dalam komentar;
  • nama terlalu spesifik mungkin berarti kode terlalu spesifik;
  • simpan cakupan singkat untuk pencarian cepat;
  • habiskan waktu untuk memikirkan keterbacaan.

Untuk menyelesaikan, ikhtisar yang baik dari konvensi penamaan diberikan dalam Google Python Panduan Gaya .

171
agold

Di Sini adalah tautan untuk berbagai jenis konvensi nama Python.

Panduan gaya untuk Python didasarkan pada rekomendasi konvensi penamaan Guido.

enter image description here

7
Vlad Bezden