تنسيق الكود

الدرس 17 من 28 في دورة Clean Code - كتابة كود أفضل باستخدام Python على Coddy.

تنص PEP 8 على بعض القواعد المتعلقة بـ "تنسيق الكود" (Code Lay-out):

استخدم الإزاحة (Indent) بمقدار 4 مسافات أو مفتاح tab
يجب ألا يتجاوز طول الأسطر 79 حرفًا

# سطر يحتوي على 137 حرفًا
def some_very_long_function_name(very_important_argument1, very_important_argument2, very_important_argument3, very_important_argument4):
	pass 
# اقتراح للإصلاح
def some_very_long_function_name(
	very_important_argument1,
	very_important_argument2,
	very_important_argument3,
	very_important_argument4):
	pass
# أفضل بكثير!

تعد المسافة البادئة بعد سطر جديد كما في المثال أعلاه ممارسة جيدة

تجنب العبارات المتعددة في نفس السطر

do_calc1(); do_calc2(); x = 3;  # سيء

# جيد
do_calc1()
do_calc2()
x = 3

يجب أن تكون عمليات الاستيراد (imports) في أسطر منفصلة

import sys, numpy  # سيء

# جيد
import sys
import numpy

التحدي

سهل

لقد تم تزويدك بكود، قم بإصلاح انتهاكات إرشادات PEP 8!

جرّب بنفسك

import my_module, other_module

some_very_important_argument = 0; another_very_important_argument = 3; very_big_and_important_argument = "Hello?";
my_module.calc_something_big_and_important(some_very_important_argument, another_very_important_argument, very_big_and_important_argument)