Kod Bersih dan Amalan Baik dalam Python

Menulis kod Python yang bersih dan boleh diselenggara ialah kemahiran penting bagi mana-mana pembangun. Kod bersih bukan sahaja menjadikan kerja anda lebih mudah dibaca dan cekap tetapi juga memastikan projek anda mudah difahami dan diselenggara oleh orang lain. Dalam artikel ini, kami akan meneroka prinsip utama dan amalan baik untuk menulis kod Python yang bersih.

1. Ikuti Garis Panduan Gaya PEP 8

PEP 8 ialah panduan gaya rasmi untuk Python dan menyediakan konvensyen untuk menulis kod yang boleh dibaca dan konsisten. Alat seperti pylint dan flake8 boleh membantu memastikan kod anda mematuhi piawaian ini.

Peraturan Utama PEP 8:

• Gunakan 4 ruang untuk lekukan.
• Hadkan baris kepada 79 aksara.
• Gunakan nama yang bermakna untuk pembolehubah dan fungsi.

Contoh:

# Good
def calculate_total_price(price, tax_rate):
    return price + (price * tax_rate)

2. Tulis Nama Deskriptif dan Bermakna

Nama hendaklah menerangkan dengan jelas tujuan pembolehubah, fungsi dan kelas. Elakkan menggunakan huruf tunggal atau istilah yang tidak jelas.

❌ Buruk:

def func(x, y):
    return x + y

✅ Baik:

def add_numbers(number1, number2):
    return number1 + number2

Garis panduan:

• Gunakan snake_case untuk nama pembolehubah dan fungsi.
• Gunakan PascalCase untuk nama kelas.

3. Pastikan Fungsi dan Kelas Kecil

Fungsi harus melakukan satu perkara dan melakukannya dengan baik. Begitu juga, kelas harus mematuhi Prinsip Tanggungjawab Tunggal (SRP).

❌ Buruk:

def process_user_data(user):
    # Validating user
    if not user.get('name') or not user.get('email'):
        return "Invalid user"

    # Sending email
    print(f"Sending email to {user['email']}")
    return "Success"

✅ Baik:

def validate_user(user):
    return bool(user.get('name') and user.get('email'))

def send_email(email):
    print(f"Sending email to {email}")

def process_user_data(user):
    if validate_user(user):
        send_email(user['email'])
        return "Success"
    return "Invalid user"

4. Gunakan Pemalar untuk Nombor dan Rentetan Ajaib

Elakkan menggunakan nilai berkod keras secara langsung dalam kod anda. Takrifkannya sebagai pemalar untuk kebolehbacaan dan kebolehselenggaraan yang lebih baik.

❌ Buruk:

if order_total > 100:
    discount = 10

✅ Baik:

MINIMUM_DISCOUNT_THRESHOLD = 100
DISCOUNT_PERCENTAGE = 10

if order_total > MINIMUM_DISCOUNT_THRESHOLD:
    discount = DISCOUNT_PERCENTAGE

5. Gunakan Pemahaman Senarai untuk Transformasi Mudah

Senaraikan pemahaman menjadikan kod anda lebih ringkas dan Pythonic. Walau bagaimanapun, elakkan merumitkannya.

❌ Buruk:

squared_numbers = []
for number in range(10):
    squared_numbers.append(number ** 2)

✅ Baik:

squared_numbers = [number ** 2 for number in range(10)]

6. Elakkan Argumen Lalai Boleh Berubah

Menggunakan objek boleh ubah seperti senarai atau kamus sebagai hujah lalai boleh membawa kepada tingkah laku yang tidak dijangka.

❌ Buruk:

def append_to_list(value, items=[]):
    items.append(value)
    return items

✅ Baik:

def append_to_list(value, items=None):
    if items is None:
        items = []
    items.append(value)
    return items

7. Tangani Pengecualian dengan Anggun

Python menggalakkan penggunaan pengecualian untuk pengendalian ralat. Gunakan try...kecuali blok untuk mengendalikan ralat dan memberikan mesej yang bermakna.

Contoh:

# Good
def calculate_total_price(price, tax_rate):
    return price + (price * tax_rate)

8. Tulis Kod KERING (Jangan Ulangi Sendiri)

Elakkan pendua logik dalam kod anda. Ekstrak fungsi biasa ke dalam fungsi atau kelas boleh guna semula.

❌ Buruk:

def func(x, y):
    return x + y

✅ Baik:

def add_numbers(number1, number2):
    return number1 + number2

9. Gunakan Rentetan Dokumen dan Komen

Dokumenkan kod anda dengan rentetan dan ulasan yang bermakna untuk menerangkan "mengapa" di sebalik logik yang kompleks.

Contoh:

def process_user_data(user):
    # Validating user
    if not user.get('name') or not user.get('email'):
        return "Invalid user"

    # Sending email
    print(f"Sending email to {user['email']}")
    return "Success"

10. Gunakan Petua Jenis

Petua taip menjadikan kod anda lebih mudah dibaca dan membantu alatan seperti mypy menangkap ralat lebih awal.

Contoh:

def validate_user(user):
    return bool(user.get('name') and user.get('email'))

def send_email(email):
    print(f"Sending email to {email}")

def process_user_data(user):
    if validate_user(user):
        send_email(user['email'])
        return "Success"
    return "Invalid user"

11. Uji Kod Anda

Sentiasa tulis ujian untuk memastikan kod anda berfungsi seperti yang diharapkan. Gunakan rangka kerja seperti unittest atau pytest.

Contoh:

if order_total > 100:
    discount = 10

12. Gunakan Persekitaran Maya

Asingkan kebergantungan projek anda untuk mengelakkan konflik menggunakan persekitaran maya.

Perintah:

MINIMUM_DISCOUNT_THRESHOLD = 100
DISCOUNT_PERCENTAGE = 10

if order_total > MINIMUM_DISCOUNT_THRESHOLD:
    discount = DISCOUNT_PERCENTAGE

Kata Terakhir

Kod bersih bukan sekadar satu set peraturan—ia adalah satu pemikiran. Dengan mengamalkan amalan baik ini, anda akan menulis kod Python yang boleh dibaca, diselenggara dan profesional. Ingat, kod bersih memberi manfaat bukan sahaja kepada anda tetapi semua orang yang menggunakan kod anda.

Apakah amalan kod bersih kegemaran anda dalam Python? Sila kongsi petua anda dalam ulasan di bawah!

Atas ialah kandungan terperinci Kod Bersih dan Amalan Baik dalam Python. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!