Untuk menginstalnya, buka terminal Anda dan jalankan kode di bawah pilihan Anda. Flake8 adalah aplikasi open source (berlisensi MIT) yang merangkum sejumlah fitur aplikasi lain seperti pycodestyle, pyflakes dan lain-lain (skrip/fungsi). Menurut PEP8, kode tersebut masih perlu diperbaiki dan terdapat blok kode yang akan menghasilkan kesalahan.
Mari kita ambil salah satu contoh, ketika pylint digunakan, pesan yang ditampilkan adalah "calculator.py 7:5 Parsing failed: 'expected. Jika diproses dengan pycodestyle dan flake8, tidak akan muncul pesan seperti gambar di bawah ini tidak ditampilkan. Saat Anda menjalankan perintah di atas, kode di kalkulator.py akan mengalami perubahan.
Ketika Anda menjalankan perintah di atas, itu tidak akan mengubah kode Anda secara langsung, seperti warna hitam. Cara kerja autopep8 bisa seperti yapf yang akan memberikan saran kode ke layar terminal atau seperti black yang akan langsung mengubah isi file kalkulator.py. Jika Anda ingin mengubah file kode secara langsung, silakan jalankan kode berikut dan periksa kembali file kode Anda.
Jika Anda menulis dalam editor kode yang sangat sederhana, anggaplah itu sebagai notepad di Windows atau pico/nano di Linux; saat menulis kode Python, perhatikan hanya lekukan setiap baris pernyataan.
Style Guide Statement Gabungan
Anda diperbolehkan membuat konten if/for/sementara yang cukup pendek untuk muat dalam satu baris (program masih berjalan). Tanda koma (koma terakhir) umumnya opsional, satu-satunya pernyataan yang diperlukan adalah ketika kita membuat variabel menggunakan tipe tupel elemen tunggal. Bukan hal yang lazim untuk memberi tanda koma pada baris di mana Anda menutup tanda kurung, seperti di bawah ini, kecuali dalam tupel elemen tunggal, seperti yang dijelaskan di atas.
Meskipun sebelumnya kita telah mempelajari cara menambahkan informasi terkait fungsi dengan menambahkan string dokumen, anotasi fungsi lebih spesifik dalam menjelaskan parameter dan nilai kembalian. Penggunaan anotasi fungsi harus menggunakan aturan standar untuk titik dua (:) dan spasi untuk tanda panah (->). Pada contoh di atas, kami memberikan informasi bahwa parameter dan nilai kembalian harus bertipe data string.
Kita bisa menentukannya dengan tipe lain, misalnya 'int' untuk integer dan 'float' untuk tipe data float. Berikutnya, saat Anda membuat fungsi dan menggabungkan anotasi dengan nilai parameter, sebaiknya gunakan spasi sebelum dan sesudah tanda sama dengan. Pada contoh di atas, kita membuat fungsi bernama “AreaofRectangle” untuk mencari luas persegi panjang dengan parameter panjang dan lebar.
Pada contoh di atas, kita membuat fungsi untuk mencari luas persegi panjang dengan parameter panjang dan lebar. Artinya ketika fungsi AreaRectangle dipanggil hanya dengan meneruskan argumen lebar, program akan tetap berjalan dengan baik. Namun perlu diingat karena petunjuk tipe bersifat opsional dan memberikan instruksi, jika kita menyediakan tipe data float di fungsi RectangleArea, program akan tetap berjalan sebagaimana mestinya.
Jika kita membuat fungsi yang menggabungkan anotasi dengan nilai parameter, sebaiknya gunakan spasi sebelum dan sesudah tanda sama dengan. Namun, saat membuat fungsi reguler tanpa notasi apa pun, sebaiknya tidak menggunakan spasi sebelum dan sesudah tanda sama dengan. Pada contoh di atas, kita menggabungkan dalam sebuah fungsi; parameter panjang menggabungkan anotasi fungsi dan nilai default, sedangkan parameter lebar hanya mendefinisikan nilai default tanpa anotasi fungsi.
Style Guide Prinsip Penamaan pada Python
Huruf huruf besar perkataan (CapWords, CamelCase): Huruf huruf besar perkataan (pastikan semua . singkatan/akronim ditulis dengan huruf besar, cth HTTPServerError, bukan HttpServerError) 8. Huruf besar perkataan dengan garis bawah: Capitalize_beginning_of_words_with_underscores . Satu perkara yang perlu diingat semasa mencipta fungsi ialah tidak disyorkan untuk menggunakan frasa atau huruf sebagai awalan fungsi.
Python tidak merekomendasikan atau lebih tepatnya tidak diperlukan jika Anda membuat fungsi yang dimulai dengan huruf atau frase, seperti 'f' jika fungsinya adalah 'f_mean()', 'r' jika fungsinya adalah 'r_name()', dan seterusnya antrian. Selain penggunaan huruf atau frasa yang tidak disarankan, berikut beberapa konvensi penamaan khusus yang umum ditemukan dalam penamaan fungsi. Mengacu pada PEP 3131, pengidentifikasi yang digunakan di Perpustakaan Standar Python harus kompatibel dengan ASCII.
Pengidentifikasi merujuk pada nama yang digunakan untuk merujuk pada variabel, fungsi, kelas, dan kode lainnya dengan Python. Nama modul harus pendek, menggunakan huruf kecil dan opsional garis bawah (_) untuk meningkatkan keterbacaan. Nama fungsi, parameter, dan variabel harus ditulis dengan huruf kecil, dan garis bawah harus dipisahkan agar lebih mudah dibaca.
Saat membuat metode dan variabel di kelas, gunakan penamaan fungsi standar, gunakan huruf kecil dengan garis bawah untuk meningkatkan keterbacaan. Diawali dengan dua garis bawah hanya digunakan jika ada konflik dengan suatu atribut di kelas atau subkelas lain. Saat memberi nama variabel bertipe konstan, biasanya variabel tersebut didefinisikan di bagian atas modul dengan huruf kapital, misalnya 'PI = 3,14' atau 'TOTAL = 4,14213'.
Saat Anda membangun metode dan variabel dalam suatu kelas, Anda harus dapat segera menemukan atribut metode dan variabel tersebut, baik publik maupun non-publik. Variabel atau metode non-publik adalah variabel atau metode yang hanya digunakan dalam lingkup tertentu dan tidak dapat diakses langsung secara eksternal. Pada contoh di atas, metode '_private_method' merupakan tipe fungsi yang tidak diakses secara langsung.
Selanjutnya variabel seperti '_private_var' atau '_secret_list' merupakan variabel non-publik yang tidak digunakan secara langsung saat kelas dipanggil. Jika Anda berencana untuk mewarisi atau membuat subkelas suatu kelas dan ingin variabel hanya digunakan di kelas utama, tambahkan dua garis bawah.
Rangkuman Style Guide pada Python
Pycodestyle adalah aplikasi open source (lisensi MIT/Expat) untuk membantu memeriksa kode terhadap konvensi penulisan kode PEP8. Pylint adalah aplikasi open source (berlisensi GPL v2) untuk menganalisis kode Python, memeriksa kesalahan pemrograman, menegakkan standar pengkodean dengan memeriksa. Flake8 adalah aplikasi open source (berlisensi MIT) yang menggabungkan banyak kemampuan aplikasi lainnya, seperti pycodestyle, pyflakes, dan banyak lainnya (skrip/fitur).
Jika proses kasa atau pagar hanya melakukan pengecekan, kali ini arah gaya penulisan kode agar sesuai dengan PEP8. Tidak umum bagi Anda untuk membubuhkan tanda koma di baris tempat Anda menutup tanda kurung seperti berikut, kecuali dalam tupel elemen tunggal seperti yang dijelaskan di atas. Di bawah ini beberapa rekomendasi penamaan yang meliputi penamaan dominan, deskriptif, fungsi, metode, dan lain-lain.
Capital_Letter di awal kata dengan garis bawah: Capital_Letter di awal kata dengan garis bawah Python tidak menyarankan atau lebih tepatnya tidak mengharuskan Anda membuat fungsi yang diawali dengan huruf atau frasa, misalnya 'f' sebagai fungsinya adalah 'f_mean()', 'r' jika fungsinya 'r_name()', dll. Selain menggunakan huruf atau frasa yang tidak disarankan, berikut beberapa bentuk penamaan khusus yang umum digunakan saat memberi nama fungsi. Anda dapat menggunakan garis bawah untuk mencegah variabel diimpor jika variabel tersebut milik modul non-publik.
Variabel atau metode non-publik adalah variabel atau metode yang hanya digunakan dalam lingkup tertentu dan tidak dapat diakses langsung secara eksternal.