Apa konvensi penamaan di Python untuk nama variabel dan fungsi?

Berasal dari latar belakang C #, konvensi penamaan untuk variabel dan nama metode biasanya camelCase atau PascalCase:

// C# example
string thisIsMyVariable = "a"
public void ThisIsMyMethod()

Dalam Python, saya telah melihat di atas tetapi saya juga melihat garis bawah yang digunakan:

# python example
this_is_my_variable = 'a'
def this_is_my_function():

Apakah ada gaya pengkodean yang lebih disukai dan definitif untuk Python?

Lihat Python PEP 8: Fungsi dan Nama Variabel :

Nama fungsi harus huruf kecil, dengan kata-kata dipisahkan oleh garis bawah seperlunya untuk meningkatkan keterbacaan.

Nama variabel mengikuti konvensi yang sama dengan nama fungsi.

mixedCase hanya diperbolehkan dalam konteks di mana itu sudah menjadi gaya yang berlaku (misalnya threading.py ), untuk mempertahankan kompatibilitas ke belakang.

The Google Python Style Guide memiliki konvensi berikut:

module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name.

Skema penamaan yang serupa harus diterapkan ke a CLASS_CONSTANT_NAME

David Goodger (dalam "Code Like a Pythonista" di sini ) menjelaskan rekomendasi PEP 8 sebagai berikut:

• joined_lower untuk fungsi, metode, atribut, variabel

• joined_loweratau ALL_CAPSuntuk konstanta

• StudlyCaps untuk kelas

• camelCase hanya untuk menyesuaikan diri dengan konvensi yang sudah ada sebelumnya

Seperti yang diakui Panduan Gaya untuk Kode Python ,

Konvensi penamaan pustaka Python agak berantakan, jadi kita tidak akan pernah mendapatkan ini sepenuhnya konsisten

Perhatikan bahwa ini merujuk hanya ke perpustakaan standar Python . Jika mereka tidak bisa mendapatkan yang konsisten, maka ada hampir tidak banyak harapan untuk memiliki umumnya-ditaati-konvensi untuk semua kode Python, apakah ada?

Dari itu, dan diskusi di sini, saya akan menyimpulkan bahwa itu bukan dosa yang mengerikan jika seseorang terus menggunakan misalnya konvensi penamaan Java atau C # (jelas dan mapan) untuk variabel dan fungsi ketika menyeberang ke Python. Ingatlah, tentu saja, yang terbaik adalah mematuhi gaya apa pun yang berlaku untuk basis kode / proyek / tim. Seperti yang ditunjukkan oleh Panduan Gaya Python, konsistensi internal paling penting.

^{Jangan ragu untuk menganggap saya sebagai bidat. :-) Seperti OP, saya bukan "Pythonista", belum.}

Ada PEP 8 , seperti yang ditunjukkan oleh jawaban lain, tetapi PEP 8 hanya panduan gaya untuk perpustakaan standar, dan itu hanya dianggap sebagai Injil di dalamnya. Salah satu penyimpangan yang paling sering dari PEP 8 untuk potongan kode lainnya adalah penamaan variabel, khususnya untuk metode. Tidak ada gaya tunggal yang mendominasi, walaupun mempertimbangkan volume kode yang menggunakan mixedCase, jika seseorang ingin membuat sensus ketat seseorang mungkin akan berakhir dengan versi PEP 8 dengan mixedCase. Ada sedikit penyimpangan lain dari PEP 8 yang cukup umum.

Seperti disebutkan, PEP 8 mengatakan digunakan lower_case_with_underscoresuntuk variabel, metode, dan fungsi.

Saya lebih suka menggunakan lower_case_with_underscoresuntuk variabel dan mixedCaseuntuk metode dan fungsi membuat kode lebih eksplisit dan mudah dibaca. Dengan demikian mengikuti Zen dari Python "eksplisit lebih baik daripada implisit" dan "jumlah keterbacaan"

lebih jauh dengan apa yang telah dijawab @JohnTESlade. Panduan gaya python Google memiliki beberapa rekomendasi yang cukup rapi,

Nama yang Harus Dihindari

• nama karakter tunggal kecuali untuk penghitung atau iterator
• tanda hubung (-) dalam nama paket / modul apa saja
• \__double_leading_and_trailing_underscore__ names (disediakan oleh Python)

Konvensi penamaan

• "Internal" berarti internal ke modul atau dilindungi atau pribadi di dalam kelas.
• Prepending satu garis bawah (_) memiliki beberapa dukungan untuk melindungi variabel dan fungsi modul (tidak termasuk dengan impor * dari). Menempatkan double garis bawah (__) ke variabel instan atau metode berfungsi secara efektif untuk membuat variabel atau metode privat untuk kelasnya (menggunakan nama mangling).
• Tempatkan kelas terkait dan fungsi tingkat atas bersama-sama dalam sebuah modul. Tidak seperti Java, tidak perlu membatasi diri untuk satu kelas per modul.
• Gunakan CapWordsuntuk nama kelas, tetapi lower_with_under.pyuntuk nama modul. Meskipun ada banyak modul yang ada bernama CapWords.py, ini sekarang tidak disarankan karena membingungkan ketika modul diberi nama setelah kelas. ("tunggu - apakah saya menulis import StringIOatau from StringIO import StringIO?")

Pedoman berasal dari Rekomendasi Guido

Kebanyakan orang python lebih suka garis bawah, tetapi bahkan saya menggunakan python sejak lebih dari 5 tahun sekarang, saya masih tidak suka mereka. Mereka hanya terlihat jelek bagiku, tapi mungkin itu semua Jawa di kepalaku.

Saya hanya suka CamelCase lebih baik karena lebih cocok dengan cara kelas dinamai, Rasanya lebih logis untuk memilikinya SomeClass.doSomething()daripada SomeClass.do_something(). Jika Anda melihat-lihat dalam indeks modul global dalam python, Anda akan menemukan keduanya, yang disebabkan oleh fakta bahwa itu adalah kumpulan perpustakaan dari berbagai sumber yang tumbuh lembur dan bukan sesuatu yang dikembangkan oleh satu perusahaan seperti Sun dengan aturan pengkodean yang ketat . Saya akan mengatakan intinya adalah: Gunakan apapun yang Anda suka lebih baik, itu hanya masalah selera pribadi.

Secara pribadi saya mencoba menggunakan CamelCase untuk kelas, metode dan fungsi mixedCase. Variabel biasanya dipisahkan garis bawah (bila saya ingat). Dengan cara ini saya bisa melihat sekilas apa yang sebenarnya saya panggil, daripada semuanya tampak sama.

Ada sebuah makalah tentang ini: http://www.cs.kent.edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

TL; DR Dikatakan bahwa snake_case lebih mudah dibaca daripada camelCase. Itu sebabnya bahasa modern menggunakan (atau seharusnya menggunakan) ular di mana pun mereka bisa.

Gaya pengkodean biasanya merupakan bagian dari standar kebijakan / konvensi internal organisasi, tetapi saya pikir secara umum, gaya all_lower_case_underscore_separator (juga disebut snake_case) paling umum digunakan dalam python.

Saya pribadi menggunakan konvensi penamaan Java ketika berkembang dalam bahasa pemrograman lain karena konsisten dan mudah diikuti. Dengan begitu saya tidak terus-menerus bergumul tentang konvensi apa yang harus digunakan yang seharusnya tidak menjadi bagian tersulit dari proyek saya!

Biasanya, satu mengikuti konvensi yang digunakan di perpustakaan standar bahasa.