En İyi Kodlama Pratikleri ve Etkili Kod İnceleme
Sunumu GörüntüleAltın standart. İncelediğiniz her pull request'i değerlendirmek için on kategori.
x, tmp, data, calc, process gibi isimler; derinden iç içe geçmiş mantık; büyük ve anlaşılmaz fonksiyonlar> 0 gibi zayıf doğrulamalar; geçersiz girdi testleri yok; değişen mantık için test yokNone döndürme; yutulmuş istisnalar; gizli hata modlarıYaygın inceleme senaryoları için profesyonel ifadeler. Bunları başlangıç noktası olarak kullanın.
Pratik için kasıtlı olarak hatalı bir PR. Sorunları bulabilir misiniz?
def calc(items, user, d=False):
t = 0
for i in items:
if i["type"] == "book":
t += i["price"] * 0.9
else:
t += i["price"]
if d:
t = t - t * 0.1
if user is not None:
if "is_premium" in user:
if user["is_premium"] == True:
t = t - t * 0.05
return t
def process_cart(items, user):
total = calc(items, user, True)
print("cart processed")
return totalfrom src.cart import calc
def test_calc():
items = [{"type": "book", "price": 100}]
user = {"is_premium": True}
assert calc(items, user, True) > 0# Cart Project
cart logiccalc çok genel - calculate_cart_total olmalıd belirsiz - discount_enabled olmalıt ve i açıklayıcı değil0.9, 0.1, 0.05 adlandırılmış sabitler olmalıif blokları - .get() kullanınprocess_cart iş mantığıyla karışık bir yan etkiye (print) sahipd=False konumsal olarak True geçirilmesi kafa karıştırıcı> 0 doğruluğu kontrol etmiyorprocess_cart test edilmemişBOOK_DISCOUNT_RATE = 0.10
GENERAL_DISCOUNT_RATE = 0.10
PREMIUM_DISCOUNT_RATE = 0.05
def calculate_item_price(item):
item_type = item["type"]
price = item["price"]
if item_type == "book":
return price * (1 - BOOK_DISCOUNT_RATE)
return price
def apply_general_discount(total_price, discount_enabled):
if not discount_enabled:
return total_price
return total_price * (1 - GENERAL_DISCOUNT_RATE)
def apply_premium_discount(total_price, user):
if not user or not user.get("is_premium", False):
return total_price
return total_price * (1 - PREMIUM_DISCOUNT_RATE)
def calculate_cart_total(items, user, discount_enabled=False):
total_price = 0
for item in items:
total_price += calculate_item_price(item)
total_price = apply_general_discount(total_price, discount_enabled)
total_price = apply_premium_discount(total_price, user)
return total_price
def process_cart(items, user):
total_price = calculate_cart_total(items, user, discount_enabled=True)
return total_pricePR İnceleme Ödevi: Profesyonel Bir Mühendis Gibi İnceleyin
Tesliminiz şunları içermelidir:
Dosya: src/orders.py Satır/Alan: calc fonksiyonu Yorum: Fonksiyon adı çok genel. Netlik için calculate_order_total olarak yeniden adlandırabilir miyiz? Dosya: tests/test_orders.py Satır/Alan: test_calc Yorum: Bu test sadece sonucun sıfırdan büyük olduğunu kontrol ediyor. Bunun yerine beklenen kesin değeri doğrulayabilir miyiz?
Aşağıdaki dosyaları inceleyin:
def calc(items, vip=False):
total = 0
for i in items:
if i["type"] == "book":
total += i["price"] * 0.9
elif i["type"] == "electronics":
total += i["price"]
else:
total += i["price"]
if vip == True:
total = total - total * 0.05
return total
def checkout(items, user):
total = calc(items, user["vip"])
print("checking out order...")
print("total is", total)
return {"ok": True, "total": total}def f(x):
if x == None:
return False
return Truefrom src.orders import calc
def test_calc():
items = [{"type": "book", "price": 100}]
assert calc(items, False) > 0# Orders
Run it with python.Harika mühendisler sadece kodun çalışmasını sağlamaz. Kodu anlaşılır, test edilebilir, incelenebilir ve güvenilir yaparlar.