Lima petua penting untuk meningkatkan kebolehbacaan kod Python

Terdapat banyak kaedah dalam Python yang boleh membantu kami memahami cara kerja dalaman kod Tabiat pengaturcaraan yang baik boleh menjadikan kerja kami lebih berkesan dengan separuh usaha.

Sebagai contoh, kita mungkin akan mendapat kod yang kelihatan seperti imej di bawah. Walaupun bukan yang paling teruk, namun, kita perlu mengembangkan beberapa perkara, seperti:

• Apakah maksud f dan d dalam fungsi load_las_file?
• Mengapa kita menyemak keputusan dalam fungsi tanah liat?
• Apakah jenis yang diperlukan oleh fungsi ini? Terapung? Lima Petua Penting untuk Seks.

1. Komen

Perkara pertama yang boleh kami lakukan pada kod kami ialah menambahkan beberapa ulasan pada kod kami, tetapi jangan gunakannya secara berlebihan. Komen harus memberitahu anda mengapa kod itu berfungsi atau sebab sesuatu dilakukan dengan cara tertentu, bukan cara ia berfungsi.

Ulasan dalam Python biasanya dilakukan menggunakan tanda paun (#) dan boleh menjangkau satu baris atau berbilang baris.

Untuk ulasan berbilang baris, kami juga boleh menggunakan tiga petikan berganda.

Dalam contoh di bawah, beberapa ulasan telah ditambahkan pada kod untuk menerangkan aliran kerja dan alasan di sebalik baris kod tertentu

# Comment using the hashtag
# Another comment using the hashtag

"""
This is an example of
a multi-line comment
"""

2 . Penaipan Eksplisit

Bahasa Python ditaip secara dinamik, yang bermaksud jenis pembolehubah hanya disemak semasa masa jalan. Selain itu, pembolehubah boleh menukar jenis semasa pelaksanaan kod.

Taipan statik, sebaliknya, melibatkan menyatakan secara eksplisit jenis pembolehubah dan ia tidak boleh berubah semasa pelaksanaan kod.

Pada tahun 2014, PEP 484 memperkenalkan konsep pembayang jenis, kemudian diperkenalkan dalam Python versi 3.5, ini membolehkan kami menyatakan secara eksplisit jenis pembolehubah yang sepatutnya.

Dengan menambahkan pembayang jenis, anda boleh meningkatkan kebolehbacaan kod anda dengan ketara. Dalam contoh berikut, kita boleh mendapatkan maklumat berikut dengan mudah:

Fungsi memerlukan dua parameter

Parameter nama fail hendaklah daripada jenis rentetan

parameter start_depth sepatutnya Ia adalah jenis apungan, dan nilai lalai ialah Tiada

• Fungsi ini akan mengembalikan objek DataFrame panda
• Kami boleh menentukan dengan tepat dengan segera fungsi itu perlu berdasarkan jenis petunjuk apa dan apa yang akan dikembalikan.

3. Rentetan Dokumen (Rentetan Dokumentasi)

Rentetan dokumen ialah literal rentetan yang mengikut takrifan fungsi atau kelas ialah cara yang bagus untuk menerangkan secara terperinci apa yang dilakukan oleh fungsi kami yang diperlukan, sebarang pengecualian yang dilemparkan, apa yang dipulangkan, dsb.

Selain itu, jika kami menggunakan alat seperti Sphinx untuk membuat dokumentasi dalam talian untuk kod kami, docstrings akan secara automatik diambil dan ditukar kepada dokumentasi yang sesuai.

Contoh berikut menunjukkan docstring untuk fungsi bernama clay_volume .

Di sini kita boleh menentukan apakah setiap parameter, yang lebih terperinci daripada pembayang jenis asas, dan kita juga boleh memasukkan lebih banyak maklumat tentang kaedah di sebalik fungsi tersebut, seperti rujukan akademik atau persamaan.

Mempunyai docstring juga sangat membantu apabila kita memanggil fungsi dari tempat lain dalam kod. Sebagai contoh, apabila mengedit kod menggunakan Visual Studio, anda boleh menuding pada panggilan fungsi dan melihat tetingkap timbul tentang perkara yang fungsi itu lakukan dan perkara yang diperlukan.

Jika anda menggunakan Visual Studio Code (VSCode) untuk mengedit kod Python anda, anda boleh menggunakan sambungan seperti autoDocstring untuk memudahkan proses mencipta docstrings. Pemalam membenarkan kami memasukkan tiga petikan berganda dan secara automatik mengisi seluruh templat, kami hanya perlu memberi tumpuan kepada butiran lain yang mesti diisi.

4. Nama Pembolehubah Boleh Dibaca

Banyak kali, apabila kita menulis kod, kita tidak terlalu mengambil berat tentang nama pembolehubah, terutamanya apabila kita tidak sabar-sabar untuk melengkapkan fungsi tertentu. Tetapi jika kod kami mengembalikan satu siri pembolehubah bernama x1 atau var123, tiada siapa yang akan dapat memahami apa yang mereka wakili pada pandangan pertama.

Dalam contoh berikut, kita mempunyai dua pembolehubah f dan d. Anda boleh meneka maksud ini dengan melihat bahagian lain kod, tetapi ini mengambil sedikit masa, terutamanya jika kod itu panjang.

Jika kita memberikan nama yang sesuai kepada pembolehubah ini, kita akan dapat mengetahui bahawa salah satu daripadanya ialah fail_data yang dibaca oleh panggilan lasio.read() dan paling banyak kemungkinan data asal, Pembolehubah data memberitahu kami bahawa ini adalah data sebenar yang kami sedang bekerjasama.

5. Mengelakkan Nombor Ajaib

Nombor ajaib ialah nilai dalam kod yang mempunyai banyak makna yang tidak dapat dijelaskan di belakangnya dan boleh mewakili pemalar. Menggunakan ini dalam kod boleh menyebabkan kekaburan, terutamanya bagi mereka yang tidak biasa dengan sebarang pengiraan di mana nombor digunakan.

Selain itu, jika kami mempunyai nombor ajaib yang sama di beberapa tempat dan perlu mengemas kininya, kami perlu mengemas kini setiap kejadiannya. Walau bagaimanapun, keseluruhan proses adalah lebih mudah jika anda menetapkan nombor kepada pembolehubah yang dinamakan dengan betul.

Dalam contoh di bawah, kita mempunyai fungsi yang mengira nilai yang dipanggil hasil dan mendarabkannya dengan 0.6. Kami tidak dapat mengetahui dengan tepat apa maksud kod daripada kod

Jika kami mengisytiharkan pembolehubah dan memberikan nilai kepadanya, maka kami mempunyai peluang yang lebih baik untuk mengetahui apa itu ia. Dalam kes ini, nisbah tanah liat kepada syal digunakan untuk menukar indeks sinar gamma kepada isipadu tanah liat.

Ringkasan

Menambah dokumentasi pada kod kami melalui ulasan dan docstrings boleh membantu kami dan orang lain memahami perkara yang dilakukan oleh kod tersebut. Memang, ia mungkin terasa seperti tugas pada mulanya, tetapi dengan penggunaan alatan dan latihan biasa, ia boleh menjadi sifat kedua kepada anda.

Atas ialah kandungan terperinci Lima petua penting untuk meningkatkan kebolehbacaan kod Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!