جودة الكود
يُقرأ الكود أكثر بكثير ممّا يُكتب. وPEP 8 هو دليل الأسلوب الرسمي لـ Python: إزاحة بأربع مسافات، وأسماء المتغيّرات والدوال بأسلوب snake_case، والأصناف بأسلوب PascalCase، والثوابت بأسلوب UPPER_CASE، وأسطر غير طويلة جدًّا. واختر أسماءً تقول ما تفعله الأشياء: average(scores) بدل f(l).
تشرح سلسلة التوثيق (docstring)، وهي نصّ بين علامات اقتباس ثلاثية تحت def مباشرةً، الغرضَ من الدالة. وتساعدك أدوات مجانية: يكتشف Ruff أو Flake8 المشكلات، ويعيد Black تنسيق الكود تلقائيًا. واحرص أيضًا على أن تكون دوالّك قصيرة، لكلّ منها مسؤولية واحدة.
# Hard to read:
def f(l):
t=0
for x in l: t+=x
return t/len(l)
# Clean (PEP 8, clear names, docstring):
def average(scores):
"""Return the average of a non-empty list of numbers."""
total = sum(scores)
return total / len(scores)
print(f([10, 20]), average([10, 20]))
print(average.__doc__)