pep257 - آنلاین در ابر

برنامه:

نام

مستندات pep257 - pep257

pep257 یک ابزار تجزیه و تحلیل استاتیک برای بررسی انطباق با پایتون است PEP 257.

فهرست:

طریقه استفاده

فرمان لاین رابط
استفاده
استفاده: pep257 [گزینه ها] [ ...]

گزینه های ارسال:
--ورژن نمایش شماره نسخه برنامه و خروج
-h ، - کمک کنید این پیام راهنما را نشان دهید و خارج شوید
-e، --explain نمایش توضیح هر خطا
-s، --source نشان می دهد منبع برای هر خطا
--انتخاب= با مشخص کردن لیست اصلی خطاهای بررسی شده را انتخاب کنید
کدام خطاها را بررسی کنیم (با لیستی از کاما-
کدهای خطای تفکیک شده). مثلا:
--select=D101,D202
--نادیده گرفتن= با مشخص کردن لیست اصلی خطاهای بررسی شده را انتخاب کنید
کدام خطاها را نادیده بگیرید (با لیستی از کاما از هم جدا شده اند
کدهای خطا). به عنوان مثال: --ignore=D101,D202
--کنوانسیون= با مشخص کردن لیست اصلی خطاهای بررسی شده را انتخاب کنید
یک کنوانسیون موجود قراردادهای احتمالی: pep257
--add-select= لیست خطاهای مورد بررسی را با مشخص کردن اصلاح کنید
کدهای خطای بیشتری برای بررسی
--add-ignore= لیست خطاهای مورد بررسی را با مشخص کردن اصلاح کنید
کدهای خطای بیشتری برای نادیده گرفتن
--تطابق= فقط فایل هایی را که دقیقا مطابقت دارند بررسی کنید منظم
اصطلاح؛ پیش فرض --match='(?!test_).*\.py' است که
فایل هایی را که با "test_" شروع نمی شوند اما به پایان می رسند مطابقت می دهد
با '.py'
--match-dir=
فقط آدرس هایی را جستجو کنید که دقیقا مطابقت دارند منظم
اصطلاح؛ پیش فرض --match-dir='[^\.].*' است که
با همه تیرهایی که با نقطه شروع نمی شوند مطابقت دارد
-d، --debug چاپ اطلاعات اشکال زدایی
-v، --اطلاعات وضعیت چاپ کامل
- تعداد کل خطاها را در stdout چاپ کنید

برگشت رمز
┌──┬──────────────
│0 │ موفقیت - بدون تخلف │
├──┼──────────────────
│1 │ برخی تخلفات کد پیدا شد │
├──┼──────────────────
│2 │ استفاده غیرقانونی - خطا را ببینید │
│ │ پیام │
└──┴──────────────

پیکر بندی فایل ها
pep257 پشتیبانی از INIفایل های پیکربندی مانند برای pep257 برای استفاده از آن، باید باشد
تحت عنوان setup.cfg, tox.ini or .pep257 و یک [pep257] بخش.

هنگام جستجوی یک فایل پیکربندی، pep257 به دنبال یکی از فایل های مشخص شده در بالا می گردد
in که دقیق سفارش. اگر فایل پیکربندی پیدا نشد، به دنبال آن می گردد
درخت دایرکتوری تا زمانی که یکی پیدا شود یا از پیکربندی پیش فرض استفاده کند.

در دسترس گزینه
همه گزینه های پیکربندی در فایل های پیکربندی موجود نیستند. گزینه های موجود
هستند:

· مجمع

· را انتخاب کنید

· چشم پوشی از

· add_select

· add_ignore

· همخوانی داشتن

· match_dir

مشاهده استفاده برای اطلاعات بیشتر بخش

وراثت
به طور پیش فرض، هنگام یافتن یک فایل پیکربندی، pep257 سعی می کند پدر و مادر را به ارث ببرد
پیکربندی دایرکتوری و ادغام آنها با موارد محلی.

فرآیند ادغام به شرح زیر است:

· اگر یکی از را انتخاب کنید, چشم پوشی از or مجمع در پیکربندی فرزند مشخص شد -
پیکربندی والد را نادیده می گیرد و کدهای خطای جدید را برای بررسی تنظیم می کند. در غیر این صورت، به سادگی
کدهای خطای بررسی شده والدین را کپی می کند.

· اگر اضافه کردن - نادیده گرفتن or افزودن-انتخاب مشخص شد، کدهای خطای مشخص شده را اضافه یا حذف می کند
از لیست کدهای خطای بررسی شده

· اگر همخوانی داشتن or مسابقه- کارگردان مشخص شد - از آنها استفاده کنید. در غیر این صورت، از والدین استفاده کنید.

به منظور غیرفعال کردن این (مفید برای فایل های پیکربندی واقع در ریشه مخزن شما)،
به سادگی اضافه کنید ارث بردن = نادرست به فایل پیکربندی شما

توجه:
اگر هر یک از را انتخاب کنید, چشم پوشی از or مجمع در CLI، پیکربندی مشخص شد
فایل‌ها در انتخاب کدهای خطا که بررسی شوند، هیچ نقشی ندارند. همخوانی داشتن و
مسابقه- کارگردان همچنان اعمال خواهد شد.

مثال
[pep257]
ارث بردن = نادرست
نادیده گرفتن = D100,D203,D405
مطابقت = *.py

ERROR کد ها

گروه بندی
┌─────────────────────────┬─────────────────────── ───────────┐
│گم دوره قاعدگی │
├─────────────────────────┼─────────────────────── ───────────┤
│D100 │ عدم وجود رشته مستند در عموم │
│ │ ماژول │
├─────────────────────────┼─────────────────────── ───────────┤
│D101 │ عدم وجود رشته مستند در عموم │
│ │ کلاس │
├─────────────────────────┼─────────────────────── ───────────┤
│D102 │ عدم وجود رشته مستند در عموم │
│ │ روش │
├─────────────────────────┼─────────────────────── ───────────┤
│D103 │ عدم وجود رشته مستند در عموم │
│ │ تابع │
├─────────────────────────┼─────────────────────── ───────────┤
│D104 │ عدم وجود رشته مستند در عموم │
│ │ بسته │
└─────────────────────────┴─────────────────────── ───────────┘

│D105 │ رشته مستند در جادو وجود ندارد │
│ │ روش │
├─────────────────────────┼─────────────────────── ───────────┤
│فضای سفید مسائل مربوط به │
├─────────────────────────┼─────────────────────── ───────────┤
│D200 │ رشته سند یک خطی باید روی │ قرار گیرد
│ │ یک خط با نقل قول │
├─────────────────────────┼─────────────────────── ───────────┤
│D201 │ قبل از │ هیچ خط خالی مجاز نیست
│ │ تابع docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D202 │ بعد از │ هیچ خط خالی مجاز نیست
│ │ تابع docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D203 │ 1 خط خالی قبل از │ لازم است
│ │ کلاس docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D204 │ 1 خط خالی بعد از │ لازم است
│ │ کلاس docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D205 │ 1 خط خالی بین │ لازم است
│ │ خلاصه خط و شرح │
├─────────────────────────┼─────────────────────── ───────────┤
│D206 │ Docstring باید دارای تورفتگی │ باشد
│ │ با فاصله، نه برگه ها │
├─────────────────────────┼─────────────────────── ───────────┤
│D207 │ Docstring کم تورفتگی دارد │
├─────────────────────────┼─────────────────────── ───────────┤
│D208 │ Docstring بیش از حد تورفتگی دارد │
├─────────────────────────┼─────────────────────── ───────────┤
│D209 │ بسته شدن رشته اسناد چند خطی │
│ │ نقل قول باید در یک │ جداگانه باشد
│ │ خط │
├─────────────────────────┼─────────────────────── ───────────┤
│D210 │ فضای خالی مجاز نیست │
│ │ متن مدار بسته اطراف │
├─────────────────────────┼─────────────────────── ───────────┤
│D211 │ قبل از │ هیچ خط خالی مجاز نیست
│ │ کلاس docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│نقل قول ها مسائل مربوط به │
├─────────────────────────┼─────────────────────── ───────────┤
│D300 │ استفاده از """سه گیومه دوبل""" │
├─────────────────────────┼─────────────────────── ───────────┤
│D301 │ از r""" در صورت وجود بک اسلش در │ استفاده کنید
│ │ docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D302 │ از u""" برای رشته های اسناد یونیکد استفاده کنید │
├─────────────────────────┼─────────────────────── ───────────┤
│Docstring محتوا مسائل مربوط به │
├─────────────────────────┼─────────────────────── ───────────┤
│D400 │ خط اول باید با │ خاتمه یابد
│ │ دوره │
├─────────────────────────┼─────────────────────── ───────────┤
│D401 │ خط اول باید در │ باشد
│ │ حال امری │
├─────────────────────────┼─────────────────────── ───────────┤
│D402 │ خط اول نباید │ باشد
│ │ "امضا" تابع │
└─────────────────────────┴─────────────────────── ───────────┘

به طور پیش فرض چک
همه کدهای خطا به طور پیش فرض بررسی نمی شوند. رفتار پیش فرض این است که فقط بررسی شود
کدهای خطا که بخشی از PEP257 کنوانسیون رسمی

همه کدهای خطای بالا به جز D203 به طور پیش فرض بررسی می شوند.

ایجاد شده توسط ولادیمیر کلشف.

نگهداری شده توسط امیر راچوم.

با استفاده از خدمات onworks.net از pep257 به صورت آنلاین استفاده کنید