لینت در لغت به معنی پرزگیری میباشد و در برنامه نویسی به فرایند بررسی قواعد ظاهری برنامه نویسی گفته میشود . قواعد دستوری به وسیله مفسر زبان برنامه نویسی کنترل میگردد و در صورت وجود اشکال توسط مفسر زبان شناسایی میگردد. اما در خصوص ایرادات ظاهری کد نویسی احتیاج به وجود ابزارهای دیگری میباشد تا در این خصوص به برنامه نویسان مخصوصا در پروژه های بزرگ که تعداد زیادی برنامه نویس به طور همزمان بر روي پروژه کار میکنند کمک نماید.
قبلا از توضیح لینتیگ در پایتون لازمه با مفهوم PEP در پایتون اشنا باشیم :
در حقیقت PEP یا Python Enhancement Proposals به مستنداتی اطلاق میگردد که جهت ارائه اطلاعات به جامعه پایتون، یا توصیف یک ویژگی جدید برای پایتون یا فرآیندها یا محیط آن استفاده میشود. PEP باید مشخصات فنی مختصری از ویژگی ها و منطق برای یک قسمت خاص ارائه دهد. هر کدام از انها با یک شماره خاص مشخص میگردد:
برای مطالعه بیشتر میتوانید PEP1 که نحوه ایجاد و تایید PEP در پایتون میباشد را از لینک زیر ملاحظه کنید :
در پایتون PEP8 و PEP257 در خصوص رعایت اصول کد نویسی صحیح در پایتون چارچوب هایی را مشخص میکنند و عموما ابزارها لینت از این مستندات حهت بررسی قواعد نگارشی کد استفاده میکنند :در این خصوص در PEP8 موارد مربوط به نامگذاری توابع و متغیرها و کلاس ها و هم چنین روال فراخوانی کتابخانه ها پرداخته و در PEP257 نحوه استاندارد سازی docstring در پایتون را تشریح میکند .
۱- کتابخانه های عمومی پایتون
۲-کتابخانه های نصب شده
۳- کتابخانه های توسعه داده شده برای خود برنامه
برای مطالعه بیشتر میتوانید از لینک زیر جهت دسترسی به PEP8 استفاده کنید :
موارد مربوط به Docstring در پایتون:
در خصوص نحوه صحیح ایجاد docstring در پایتن نیز میتوانید به PEP257 به ادرس زیر رجوع کنید:
شما میتونید با نصب و تنظیم هر کدام از ابزارهای فوق هنگام نوشتن کد پایتون از صحیح و استاندارد بودن کد خود اطمینان حاصل کنید . این ابزارها با تحلیل مداوم کد شما همواره نسبت به بررسی قواعد نگارشی اقدام میکنند و در صورت وجود تفاوت ان را به شما اطلاع میدهند.
در انتها نحوه راه اندازی و تنظیم یکی از ابزارها به عنوان نمونه نشان داده شده که برای بقیه موارد نیز مشابه میباشد .
نصب اسان :
python -m pip install flake8
نصب در پایتون ۲ :
python2.7 install flake8
نصب در پایتون ۳ :
python3 install flake8
چک کردن یک فایل خاص با flake8 :
flake8 /path_to_your_code/file_name.py
چک کردن مسیر پروژه :
flake /path_to_your_project
چک کردن در خصوص یک کد خطا مشخص :
flake8 -select W54 /path_to_project
عدم بررسی یک کد خطا مشخص :
flake8 -ignore W54 /path_to_your_project
هم چنین شما میتونید بر روی IDE هم افزونه های مربوط به لینتیگ رو نصب کنید و به طور همزمان با کد نویسی نسبت به رفع خطاها شناسایی شده اقدام کنید. نحوه راه اندازی flake8 برای IDE های مختلف رو از لینک های پایین میتونید مشاهده کنید :
نحوه نصب روی ATOM :
نحوه نصب vscode:
https://code.visualstudio.com/docs/python/linting
نحوه تنظیم رو pycharm :
هم چنین اگر احتیاج به مستندات کامل در خصوص نحوه کار با این ماژول داشتید میتونید از فایل زیر هم استفاده کنید :
و در اخر لینک سورس پروژه در رو هم از گیت هاب میتونید ببنید :
