نویسنده : مهندس عبدالله قاسمی (کارشناسی مهندسی نرم افزار )
مقدمه:
هدف از تحلیل کردن pep8 راهنمای و استاندار نویسی و رعایت اوصول کد زدن بهتر برای مخاطب چگونگی روند بهبود یافته و نوشتن کد تمیز و تشخیص کد های تمیز از کد های کثیف و یک روند خوب ادامه بدهیم
ما یک لیست را مورد بررسی قرار می دهیم و تشخیص می دهیم در کد های پایتون سعی بر این می شود موقع جداسازی لیست های که وقتی طول لیست زیاد میشود اون رو میشکنیم و انهارو به طور واضح نمایان میکنیم
my_list = [
1, 2, 3,
4, 5, 6,
]
result = some_function_that_takes_arguments(
'a', 'b', 'c',
'd', 'e', 'f',
)
تمامی کتاب خانه ها زیر هم قرار گرفته باشنn و در یک سطر نوشتن کاملا اشتباه است هدف از این کار فقط بهبود یافتن کد تمیز و جداسازی کدهای تمیز از کدهای کثیف است
import os
import sys
و اگر بخواهیم ان را به عنوان کد کثیف در نظر بگیریم ور پایین نمایش داده می شود
import os , import sys
اجتنباب از فضای سفید باعث می شود کد خیلی واضح تر و تمیزتر نمایان شود و پایتون این کدتمیز را قبول دارد به عنوان مثال:
spam (ham[1], {eggs: 2})
foo = (0,)
if x == 4: print x, y; x, y = y, x
dct['key'] = lst[index]
و کد کثیف به عنوان مثال:
spam( ham[ 1 ], { eggs: 2 } )
شما اگر نگاه کنید در این کد کاملا بعد از صفر فضای سفید نمایان است
bar = ( 0, )
و همچنین بعد از دستور شرط کاملا فضای سفید نمایان است واین بزرگترین اشتباهاتی است که بعضی از برنامه نویسان از این اصول پیروی میکنند
if x == 4 : print x , y ; x , y = y , x
dct ['key' ] = lst [index ]
و یک نکته خیلی مهم هست برای کسانی که تازه کار هستند و ما قصد داریم این اشتباه را برای همیشه کنار گذاشته شود .
بعنوان مثال ما یک کد تمیز را می نویسیم
x = 25
y= 45
long_number= 35
بعنوان مثال ما یک کد کثیف می نویسیم
x = 25
y= 45
long_number 86
ببینید دقت کنین از فضای خیلی زیادی استفاده کرده و باعث بهم ریختن کد شده
اگر اپراتورهای با اولویت های مختلف مورد استفاده قرار گیرند، در نظر گرفتن فضای خالی را در اطراف اپراتورهای با کمترین اولویت قرار دهید. از قضاوت خود استفاده کنید با این حال، هرگز از یک فضای استفاده نکنید و همیشه از هر دو طرف اپراتور باینری یک مقدار فضای خالی را داشته باشید
بعنوان مثال:
i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)
بعنوان مثال کد کثیف:
i= i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = ( a + b ) * ( a - b )
از فضاهای کنار علامت مساوی هیچوقت استفاده نکنیم برای نشان دادن یک استدلال کلمه کلیدی یا یک مقدار پارامتر پیش فرض استفاده کنید.
بعنوان مثال:
def complex(real, imag=0.0):
return magic(r=real, i=imag)
و کد اشتباه ان
def complex(real, imag = 0.0):
return magic(r = real, i = imag)
نکته : در تابع سعی بر این شود از اسم کوچک استفاده شود
نتیجه گیری:
سعی بر این شد که ما بهترین کد از لحظ تمیز بودن اموخته شود
منابع و مناخذ:
pep8.org
ایمیل:abdollahghasemi10@gmail.com
