Pengecekan Style Guide PEP8 Pada Python

Haloo sobat ngodingg

Semoga kalian sehat selaluu

Sampai dengan saat ini, kamu tentu sudah menuliskan kode pemrograman Python cukup banyak, termasuk di antaranya kode yang kamu tulis mengalami kesalahan sintaksis atau indentasi. Lalu, bagaimana agar ke depannya bisa mencegah hal tersebut terjadi?

Semua itu bergantung pada kode editor yang kamu gunakan untuk menulis kode Python, terkadang ada beberapa kode editor yang sudah dilengkapi dengan fitur pengecekan kemungkinan kesalahan dan memformat kode sesuai arahan gaya penulisan (style guide) PEP8, seperti PyCharm. Ada juga kode editor, seperti Visual Studio Code yang menyediakan plugin tambahan untuk membantu pengecekan kemungkinan kesalahan dan memformat kode.

PEP8 adalah panduan gaya resmi untuk kode Python. Mengikuti PEP8 dapat membuat kode kamu lebih mudah dibaca, dipelihara, dan dipahami oleh programmer lain.

Tujuan dari panduan ini agar kode kamu lebih mudah dibaca dan dipahami oleh programmer lain serta menghindari kemungkinan kesalahan yang akan muncul.

Pada materi kali ini, kita akan mempelajari beberapa aplikasi yang dapat kamu gunakan dengan memanggil perintah atau sebaiknya diintegrasikan ke editor kode yang kamu pakai. Tujuannya untuk membantu kamu mengecek kemungkinan kesalahan dan kesesuaian dengan PEP8.

1. Alat Online

  • - PEP8 Online: URL PEP8 Online: Situs web ini memungkinkan kamu untuk memasukkan kode Python kamu dan akan memeriksa apakah kode tersebut mengikuti PEP8.
  • - LintCode: URL LintCode: Alat online ini memungkinkan kamu untuk memasukkan kode Python kamu dan akan memeriksa berbagai masalah gaya, termasuk PEP8.
  • - Codacy: URL Codacy: Layanan ini memungkinkan kamu untuk menghubungkan akun GitHub kamu dan akan secara otomatis memeriksa kode kamu untuk masalah gaya, termasuk PEP8.

2. Alat CLI

  • - pycodestyle: URL pycodestyle: Paket Python ini memungkinkan kamu untuk memeriksa kode Python kamu dari baris perintah. Untuk instalasi, silakan buka terminal kalian dan jalankan kode berikut:
  • - flake8: URL flake8: Paket Python ini memungkinkan kamu untuk memeriksa kode Python kamu untuk berbagai masalah gaya, termasuk PEP8. Untuk instalasi, silakan buka terminal kalian dan jalankan kode berikut:

3. Integrasi Editor Kode

Banyak editor kode populer, seperti PyCharm, VS Code, dan Sublime Text, memiliki plugin yang dapat membantu kamu memeriksa kode Python kamu untuk masalah gaya, termasuk PEP8.

Tips:

  • Sebaiknya periksa kode kamu untuk PEP8 sebelum kamu push ke repositori kode.
  • kamu dapat mengonfigurasi alat PEP8 untuk mengabaikan aturan tertentu yang tidak kamu sukai.
  • Ada beberapa gaya pengkodean alternatif untuk Python, seperti Black. kamu dapat memilih gaya yang paling sesuai dengan kebutuhan kamu.

Sumber Daya

  • PEP8
  • URL PEP8: Panduan gaya resmi untuk Python
  • PEP8 Online: URL PEP8 Online: Alat online untuk memeriksa kode Python kamu untuk PEP8
  • Pycodestyle:
  • URL pycodestyle: Paket Python untuk memeriksa kode Python kamu untuk PEP8
  • Flake8:
  • URL flake8: Paket Python untuk memeriksa kode Python kamu untuk berbagai masalah gaya, termasuk PEP8

Selanjutnya, mari kita masuk ke pembahasan cara kerja ketiganya. Pastikan kamu sudah menginstal aplikasi yang disebutkan sebelumnya.

  • 1. Masuk ke kode editor kamu, misalnya Visual Studio Code.
  • 2. Buat sebuah file bernama kalkulator.py dan masukkan kode berikut.Pada kode di atas, kita membuat kelas bernama Kalkulator. Kelas ini memiliki dua metode, yaitu tambah dan kurang. Atribut yang dimiliki kelas ini hanyalah variabel "i".Berdasarkan PEP8, kode tersebut masih perlu diperbaiki dan ada blok kode yang akan menghasilkan error. Kita akan mengetahuinya nanti. 
    1. class Kalkulator:
    2.     """kalkulator tambah kurang"""
    3.     def __init__(self, _i):
    4.         self.i = _i
    5.     def tambah(self, _i): return self.i + _i
    6.     def kurang(self, _i):
    7.     return self.i - _i
  • 3. Mari kita jalankan file atau script tersebut dengan aplikasi yang telah diinstal. Buka kembali terminal kamu , pastikan membuka direktori tempat file atau kamu berada.

Pycodestyle

Untuk menguji menggunakan pycodestyle, jalankan kode berikut:

pycodestyle kalkulator.py

Output yang dihasilkan adalah berikut:

Gambar di atas adalah tampilan terminal ketika kamu menjalankan script menggunakan pycodestyle.
  • Pylint

Untuk menguji menggunakan pylint, jalankan kode berikut.

pylint kalkulator.py
  • Output yang dihasilkan adalah berikut:
Gambar di atas adalah tampilan terminal ketika kamu menjalankan script menggunakan pylint
  • Flake8

Untuk menguji menggunakan flake8, jalankan kode berikut:

 flake8 kalkulator.py

Output yang dihasilkan adalah berikut:

Gambar di atas adalah tampilan terminal ketika kamu menjalankan script menggunakan flake8.

Pesan dari ketiga aplikasi tersebut ternyata beragam, tetapi ada satu kesamaan, yakni ketiganya menunjukkan pola yang sama di awal pesan berupa nama file diikuti dengan baris dan kolom.

Untuk mengetahui mana baris dan kolom, perhatikan gambar di bawah ini.

Gambar di atas menunjukkan baris dan kolom dari kode yang telah kita buat sebelumnya. Kita ambil satu contoh, ketika menggunakan pylint pesan yang ditampilkan adalah "kalkulator.py 7:5 Parsing failed: 'expected an indented block after function definition on line 6 (<unknown>, line 7)' (syntax-error).". Ini artinya pylint menunjukkan bahwa pada baris 7 kolom ke-5 seharusnya memiliki indentasi setelah mendefinisikan fungsi di baris ke-6.

Baik flake8 maupun pylint, keduanya memberikan pesan bahwa ada error indentasi, sedangkan pada pycodestyle format kode juga dicek sesuai PEP8 sehingga akan menghasilkan pesan yang berbeda, yakni error indentasi dan blank line.

Mari perbaiki kodenya, silakan ganti dengan kode berikut.


1. class Kalkulator:
2.     """kalkulator tambah kurang"""
3.     def __init__(self, _i):
4.         self.i = _i
5.  
6.     def tambah(self, _i): return self.i + _i
7.  
8.     def kurang(self, _i):
9.         return self.i - _i

Pada kode di atas, kita telah melakukan beberapa perbaikan. Pertama adalah kita menambahkan new line (garis baru) pada setiap penulisan setelah blok fungsi, sekarang setiap fungsinya dipisahkan oleh satu baris kosong. Kedua, kita menambahkan indentasi pada metode "kurang".

Kemudian jalankan kembali file tersebut menggunakan ketiga aplikasi yang sebelumnya digunakan.

Jika diproses menggunakan pycodestyle dan flake8, itu tidak akan memunculkan pesan seperti gambar di bawah ini. Hal ini berarti menjelaskan kodenya sudah lebih baik.

Namun, ketika kamu menjalankannya menggunakan pylint, beberapa pesan peringatan muncul. Hal ini karena kita perlu menambahkan dokumentasi pada setiap fungsi dan kelas yang dibangun. Tidak apa-apa, itu merupakan peringatan untuk membuat kode kita lebih sempurna.

Kesimpulan

Mematuhi style guide PEP8 adalah cara yang bagus untuk meningkatkan keterbacaan, konsistensi, dan maintainability kode Python Anda. Ada beberapa alat bantu yang dapat membantu Anda mengecek kode Anda untuk kepatuhan PEP8. Jadi buat kawan-kawan yang mau mempelajari tentang python dari dasar kalian bisa mengikuti kelasnya di BuildWithAngga yaitu Kelas Online Gratis Python Pemrograman Dasar Kalian bisa akses kelasnya secara gratiss lohhh.

Oke sekian penjelasan tentang Pengecekan Style Guide PEP8 Pada Python, kalian bisa kembali untuk menguliknya sendiri tentunya. Semoga bermanfaat buat kalian.

See you guysss !