6 Praktik Terbaik Python untuk Kode yang Lebih Baik

Praktik Terbaik Python 

1. Praktik terbaik Python untuk kualitas kode

Menulis kode yang mudah dibaca dan terstruktur dapat membuat perbedaan dan meningkatkan prospek karier Anda. Meskipun bagi pemula ngoding mungkin tampak mekanis dan kompleks, kenyataannya ngoding adalah sebuah seni. 

Ada banyak kiat yang dapat Anda ikuti untuk meningkatkan kualitas kode di Python. Berikut adalah daftar beberapa yang paling relevan.

Tirani indentasi

Indentasi mengacu pada spasi di awal baris kode. Sementara pada bahasa pemrograman lain indentasi hanya untuk keterbacaan, di Python indentasi adalah wajib. Python menggunakan indentasi untuk membuka blok kode. Lebih tepatnya, 4 spasi berturut-turut per tingkat indentasi, seperti pada kode berikut:

for number in [1,2,3,4]:
    if number % 2 == 0:
        print(number)
    else:
        continue

Panjang baris maksimum

PEP 8 merekomendasikan agar tidak ada baris yang lebih dari 79 karakter. Ini masuk akal karena baris yang lebih pendek lebih mudah dibaca. Selain itu, panjang ini memungkinkan Anda membuka beberapa berkas berdampingan.

Baris kosong

Kelilingi definisi fungsi dan kelas tingkat atas dengan dua baris kosong. Definisi metode di dalam kelas dikelilingi satu baris kosong. Baris kosong tambahan dapat digunakan (secukupnya) untuk memisahkan kelompok fungsi yang terkait. Terakhir, gunakan baris kosong di dalam fungsi (secukupnya) untuk menandai bagian logis. 

Gunakan linter dan pemformat otomatis

Penguasaan kode membutuhkan waktu. Memperhatikan semua detail saat ngoding bisa menantang dan memakan waktu. Untungnya, mesin – khususnya linter dan formatter – dapat membantu kita memastikan kualitas kode. 

Linter melakukan analisis statis terhadap kode sumber dan memeriksa ketidaksesuaian semantik. Formatter adalah alat serupa yang mencoba menata ulang spasi, panjang baris, posisi argumen, dan seterusnya agar kode Anda terlihat konsisten di berbagai berkas atau proyek. Python menawarkan banyak pilihan linter dan formatter.

Ingat prinsip-prinsipnya

Walau beberapa aturan di atas mudah, ngoding sering kali soal selera dan intuisi yang baik. Untuk menjadi seniman ngoding, Anda perlu mengetahui beberapa prinsip yang menjadi dasar Python. Contoh hebat dari prinsip-prinsip tersebut adalah Zen of Python, yang dibahas dalam artikel terpisah.  

2. Praktik terbaik logging Python

Logging adalah cara melacak peristiwa yang terjadi saat suatu perangkat lunak berjalan. Terutama ketika aplikasi tumbuh dalam ukuran dan kompleksitas, logging menjadi teknik krusial untuk mengembangkan, men-debug, menjalankan, dan melacak kinerja.  

Modul logging telah menjadi bagian dari Pustaka Standar Python sejak versi 2.3 untuk menangani praktik logging. Ini adalah paket andalan bagi sebagian besar pengembang Python terkait logging dan dibahas secara ekstensif dalam PEP 282.

Logging secara semangat mirip dengan fungsi Print. Namun, fungsi print tidak memiliki banyak informasi yang mungkin berguna bagi pengembang. Logging dapat mencatat stempel waktu dan nomor baris tempat kesalahan terjadi. Logging juga bisa mencatat kesalahan atau informasi apa pun ke berkas, soket, dll.

Untuk mengimpor modulnya, Anda cukup menjalankan kode ini:

import logging

Tidak semua pesan log serupa. Memang, modul ini menyediakan kategori level logging berdasarkan tingkat keparahan pesan. Urutannya sebagai berikut:

• NOTSET (0): Artinya semua pesan akan dicatat.
• Debug (10): Berguna untuk mendiagnosis masalah dalam kode. 
• Info (20): Dapat digunakan untuk mengonfirmasi bahwa tidak ada bug dalam kode. Salah satu penggunaan yang baik untuk logging level info adalah melacak kemajuan pelatihan model machine learning. 
• Warning (30): Mengindikasikan masalah yang bisa terjadi di masa mendatang. Misalnya, peringatan mungkin dikeluarkan untuk modul yang mungkin dihentikan di masa depan atau peringatan RAM rendah. 
• Error (40): Bug serius dalam kode; bisa berupa kesalahan sintaks, kehabisan memori, atau exception. 
• Critical (50): Kesalahan yang dapat menyebabkan program berhenti berfungsi atau keluar secara tiba-tiba.

import logging
logging.info('This message is just informative')
logging.debug('My missions is to provide information about debugging.')
logging.critical("A Critical Logging Message")

Setelah itu, berikut adalah daftar enam praktik terbaik untuk menangani logging di Python.  

Gunakan log alih-alih print

Kita sudah menyebutkan bahwa log memberikan informasi serupa dengan fungsi print. Namun, log jauh lebih kuat dan dapat memberikan informasi yang lebih terperinci. 

Menggunakan fungsi Print mungkin menggoda, terutama jika Anda belum terbiasa dengan rutinitas logging, tetapi log akan selalu menjadi opsi yang paling aman. Log lebih cocok untuk skala dan menangani aplikasi yang kompleks. 

Web penuh dengan panduan dan dokumentasi. Misalnya, tutorial logging dari DataCamp ini bisa menjadi yang Anda butuhkan untuk memulai.

Gunakan modul logging 

Modul ini adalah opsi andalan bagi sebagian besar pengembang Python. Artinya modul ini dipelihara dengan baik dan didukung oleh komunitas besar yang akan selalu punya jawaban untuk keraguan Anda.

Pilih level logging dengan bijak

Modul logging memiliki enam level pesan yang berbeda. Masing-masing dirancang untuk tujuan tertentu. Semakin Anda mematuhinya, semakin mudah bagi Anda dan pengguna untuk memahami apa yang terjadi dalam kode Anda.

Gunakan stempel waktu saat logging

Ini adalah fitur krusial dari log yang tidak dimiliki fungsi print. Selain mengetahui di mana masalah muncul, penting untuk mengetahui kapan itu terjadi. Stempel waktu adalah sekutu terbesar Anda dalam situasi ini. Pastikan menggunakan format standar untuk menulis stempel waktu, yaitu format ISO-8601.

Kosong

Kosongkan tempat penyimpanan log

Gunakan kelas RotatingFileHandler, seperti TimedRotatingFileHandler, alih-alih FileHandler, untuk mengarsipkan, mengompresi, atau menghapus berkas log lama guna mencegah masalah ruang memori. Kelas-kelas ini akan membersihkan ruang setelah batas ukuran atau kondisi waktu terpenuhi.

3. Praktik terbaik komentar Python

Komentar sangat penting untuk membuat anotasi bagi pembaca kode kita di masa mendatang. Walaupun sulit menentukan bagaimana kode harus dikomentari, ada pedoman tertentu yang dapat kita ikuti: 

• Komentar yang bertentangan dengan kode lebih buruk daripada tanpa komentar. Karena itu sangat penting untuk memperbarui kode dan komentar guna menghindari ketidakkonsistenan. 
• Komentar harus berupa kalimat lengkap, dengan huruf pertama kapital. 
• Usahakan menulis komentar dalam bahasa Inggris. Meskipun setiap orang bebas menulis komentar dalam bahasa yang dianggap tepat, disarankan untuk menggunakan bahasa Inggris. 
• Pastikan komentar Anda jelas dan mudah dipahami oleh penutur bahasa yang Anda gunakan.

Ada dua jenis komentar: komentar blok dan komentar inline. 

Komentar blok menjelaskan kode yang mengikutinya. Biasanya, Anda menjorokkan komentar blok pada level yang sama dengan blok kode. Setiap baris komentar blok diawali dengan # dan satu spasi, seperti berikut:

# This is a block comment
print('Welcome to DataCamp!")

Di sisi lain, komentar inline muncul pada level yang sama dengan kode. Komentar inline harus dipisahkan setidaknya dua spasi dari pernyataan. Mirip dengan komentar blok, komentar inline diawali dengan satu tanda pagar (#) dan diikuti oleh spasi dan teks. 

print ("Have you ever tried Python?") # This is an inline comment

4. Praktik terbaik docstring Python

Docstring adalah string literal yang muncul sebagai pernyataan pertama dalam definisi modul, fungsi, kelas, atau metode. Biasanya, Anda menggunakan string dokumentasi untuk menghasilkan dokumentasi kode secara otomatis. Karena itu, docstring dapat diakses saat run-time menggunakan atribut khusus obj.__doc__ dari objek tersebut.

Demi konsistensi, docstring selalu ditutup dengan tiga tanda kutip ganda (""").

Ada dua bentuk docstring: satu baris dan multi-baris. Satu baris untuk kasus yang benar-benar jelas. Docstring jenis ini seharusnya muat dalam satu baris. Contoh berikut menggambarkan docstring satu baris pada fungsi multiply():

def multiply(x, y):
    """ Return the product of two numbers """
    result = x * y
    return result

Sementara itu, docstring multi-baris dapat mencakup banyak baris. Docstring semacam ini harus mendokumentasikan fungsi skrip, sintaks baris perintah, variabel lingkungan, dan berkas. Pesan penggunaan bisa cukup mendetail dan harus cukup bagi pengguna baru untuk menggunakan perintah dengan benar.

def calculate_salary(hours, price=20):
    """ Return the salary according to the hours worked

    Arguments:
    hours: total hours investe
    price: price of each hours worked. Minimum price is 20 dollars
    """
    salary = hours * price
    return salary

Penjelasan yang lebih rinci tentang docstring dapat ditemukan di PEP257.

5. Praktik terbaik dokumentasi Python

Meskipun komentar penting agar pengembang lain yang bekerja bersama Anda memahami kode, dokumentasi ditujukan untuk membantu komunitas calon pengguna mempelajari cara menggunakan perangkat lunak Anda. Ini adalah langkah krusial: sebaik apa pun perangkat lunak Anda, jika dokumentasinya tidak cukup baik, atau bahkan tidak ada, orang tidak akan menggunakannya. 

Menyertakan berkas README selalu menjadi praktik yang baik, terutama jika Anda mengerjakan proyek baru. Berkas-berkas ini biasanya menjadi titik masuk utama bagi pembaca kode Anda dan mencakup informasi umum untuk pengguna dan pengelola proyek. 

Meski ringkas, berkas README harus menjelaskan tujuan proyek, URL sumber utama perangkat lunak, dan informasi kredit.

Demikian pula, Anda sebaiknya selalu menyertakan berkas setup.py, yang memastikan perangkat lunak atau pustaka telah dikemas dan didistribusikan dengan Distutils, standar untuk mendistribusikan modul Python.

Selain itu, jika perangkat lunak Anda memerlukan dependensi atau paket lain untuk berjalan, Anda harus menyertakan berkas requirements.txt yang menjelaskan dependensi yang dibutuhkan dan versinya.

Terakhir, Anda bebas menambahkan informasi lain yang menurut Anda relevan bagi calon pengguna. Misalnya, praktik yang baik adalah memberikan contoh cara kerja paket atau fungsi Anda. 

6. Praktik terbaik lingkungan virtual Python 

Untuk memastikan ketertiban dan konsistensi di seluruh proyek data Anda, membuat lingkungan virtual untuk setiap proyek yang Anda mulai adalah praktik yang baik. 

Lingkungan virtual, juga dikenal sebagai virtualenv, membantu memisahkan dan mengisolasi versi Python dan pustaka yang diperlukan untuk proyek Anda beserta versi pip terkait. Ini mengizinkan pengguna akhir memasang dan mengelola seperangkat perangkat lunak dan versinya sendiri yang independen dari yang disediakan sistem. 

Untuk membuat virtualenv, kita perlu terlebih dahulu memasang paket yang diperlukan, dengan menulis baris kode berikut di terminal Anda:

pip install virtualenv

Untuk membuat virtualenv baru, kode berikut akan melakukan tugasnya. Kita menamai virtualenv baru tersebut “new_venv”

python3 -m venv /path/to/new/virtual/environment/new_venv

Konvensi Penamaan Python

Salah satu kesalahan paling umum di kalangan pengembang Python pemula adalah penamaan yang tidak tepat untuk variabel, kelas, fungsi, dan sebagainya. Konvensi penamaan adalah elemen penting untuk memastikan keterbacaan kode.

PEP 8 menjelaskan cara standar menamai objek di Python. Menurut pedoman, modul dan paket baru (termasuk kerangka kerja pihak ketiga) harus ditulis mengikuti standar ini, tetapi konsistensi internal lebih diprioritaskan jika pustaka yang ada memiliki gaya berbeda.

Anda harus menghindari penggunaan nama yang terlalu umum atau terlalu panjang. Selain itu, pengenal yang digunakan di pustaka standar harus kompatibel dengan ASCII, seperti dijelaskan dalam PEP 3131.

# Bad naming:
data_structure, ríos_españa, dictionary_with_countries_and_capitals
# Good naming:
user_profile, stop_words, global_emissions_df

Di bawah ini adalah daftar konvensi penamaan untuk objek paling umum di Python.

• Paket dan modul
• Nama paket dan modul harus seluruhnya huruf kecil
• Garis bawah hanya boleh digunakan pada nama paket dan modul jika meningkatkan keterbacaan.
• Kelas
• Nama kelas harus mengikuti konvensi UpperCaseCamelCase
• Namun, kelas bawaan Python biasanya berupa kata huruf kecil
• Variabel instance, metode, dan fungsi
• Nama variabel instance harus seluruhnya huruf kecil
• Gunakan garis bawah untuk menambahkan kata baru pada instance variabel
• Variabel instance non-publik harus diawali dengan satu garis bawah
• Konstanta
• Nama konstanta harus seluruhnya huruf kapital
• Gunakan garis bawah untuk menambahkan kata baru pada konstanta

Kesimpulan

Menguasai praktik terbaik Python penting untuk menulis kode yang bersih, efisien, dan mudah dirawat. Dengan mengikuti pedoman tentang kualitas kode, logging, komentar, dan dokumentasi, serta menggunakan alat seperti lingkungan virtual, Anda dapat memastikan proyek lebih mudah dikelola, dikerjakan bersama, dan diskalakan.

Seiring Anda terus meningkatkan keterampilan Python, pertimbangkan untuk menjelajahi sumber belajar yang lebih mendalam guna memperkaya pemahaman tentang Python dan beragam penerapannya. Jika Anda mencari panduan terstruktur, lihat sumber berikut:

• How to Learn Python: A Guide to Becoming an Expert – Panduan pakar ini akan membantu Anda menavigasi proses belajar, menawarkan kiat dan teknik untuk menguasai Python.
• Introduction to Python for Developers – Sempurna bagi pengembang yang ingin memulai dengan Python, kursus ini membahas konsep inti dan fitur bahasa secara praktis dan langsung.
• Introduction to Data Science in Python – Setelah Anda nyaman dengan Python, dalami ilmu data dengan kursus ramah pemula ini. Mencakup pustaka penting dan teknik bekerja dengan data di Python.