pydocstyle - מקוון בענן

תָכְנִית:

שֵׁם

pydocstyle - תיעוד pydocstyle

(לשעבר pep257)

pydocstyle הוא כלי ניתוח סטטי לבדיקת תאימות ל-Python docstring
מוסכמות.

pydocstyle תומך ברוב זריזות 257 מחוץ לקופסה, אך אין לראות בכך א
יישום התייחסות.

1. התקן

התקנת pip pydocstyle

2. הפעלה

$ pydocstyle test.py
test.py:18 במחלקה מקוננת פרטית `meta`:
D101: המחרוזת חסרה
test.py:22 בשיטה ציבורית `method`:
D102: המחרוזת חסרה
...

3. תקן את הקוד שלך :)

תוכן:

נוהג

הַתקָנָה
השתמש פְּעִים או easy_install:

התקנת pip pydocstyle

לחלופין, ניתן להשתמש pydocstyle.py קובץ המקור ישירות - הוא עצמאי.

פיקוד קו מִמְשָׁק
נוֹהָג
שימוש: pydocstyle [אפשרויות] [ ...]

אפשרויות:
--גרסה הצג את מספר הגרסה של התוכנית ויציאה
-h, - עזרה להציג את הודעת העזרה הזו ולצאת ממנה
-e, --explain הצג הסבר של כל שגיאה
-s, --source הצג מקור עבור כל שגיאה
-d, --debug מידע על ניפוי באגים
-v, --פרטי סטטוס הדפסה מילוליים
--count הדפסת המספר הכולל של שגיאות עד stdout
--בחר= בחר את הרשימה הבסיסית של שגיאות מסומנות על ידי ציון
אילו שגיאות לבדוק (עם רשימה של פסיקים-
קודי שגיאה מופרדים). לדוגמה:
--select=D101,D202
--התעלם= בחר את הרשימה הבסיסית של שגיאות מסומנות על ידי ציון
מאילו שגיאות להתעלם (עם רשימה של מופרדות בפסיקים
קודי שגיאה). לדוגמה: --ignore=D101,D202
--מוסכמה= בחר את הרשימה הבסיסית של שגיאות מסומנות על ידי ציון
אמנה קיימת. מוסכמות אפשריות: pep257
--add-select= תקן את רשימת השגיאות שיש לבדוק על ידי ציון
עוד קודי שגיאה לבדיקה.
--add-ignore= תקן את רשימת השגיאות שיש לבדוק על ידי ציון
עוד קודי שגיאה שיש להתעלם מהם.
--match= בדוק רק קבצים שמתאימים בדיוק רגיל
ביטוי; ברירת המחדל היא --match='(?!test_).*\.py' אשר
מתאים לקבצים שלא מתחילים ב-'test_' אלא מסתיימים
עם '.py'
--match-dir=
חפש רק בכתובים התואמים בדיוק רגיל
ביטוי; ברירת המחדל היא --match-dir='[^\.].*', אשר
מתאים לכל הכתובות שלא מתחילות בנקודה

לחזור קופונים
┌──┬────────────────────────────────
│0 │ הצלחה - ללא הפרות │
├──┼────────────────────────────────
│1 │ נמצאו כמה הפרות קוד │
├──┼────────────────────────────────
│2 │ שימוש לא חוקי - ראה שגיאה │
│ │ הודעה │
└──┴─────────────────────────────────

תְצוּרָה קבצים
pydocstyle תומך INI-כמו קבצי תצורה. על מנת ש pydocstyle להשתמש בו, זה
חייב להיות בשם אחת מהאפשרויות הבאות, ויש לה א [pydocstyle] סָעִיף.

· setup.cfg

· tox.ini

· .pydocstyle

· .pydocstylerc

בעת חיפוש קובץ תצורה, pydocstyle מחפש אחד מהקבצים שצוינו
מֵעַל in זֶה מְדוּיָק להזמין. אם קובץ תצורה לא נמצא, הוא ממשיך לחפש אותו
למעלה בעץ הספריות עד שיימצא אחד או ישתמש בתצורת ברירת המחדל.

הערה:
למטרות תאימות לאחור, pydocstyle תומך בקבצי תצורה בשם
‎.pep257, כמו גם כותרת מקטע [pep257]. עם זאת, אלה נחשבים שהוצאו משימוש
והתמיכה תוסר בגרסה הגדולה הבאה.

זמין אפשרויות
לא כל אפשרויות התצורה זמינות בקבצי התצורה. אפשרויות זמינות
הם:

· כנס

· בחר

· להתעלם

· add_select

· add_ignore

· להתאים

· match_dir

ראה נוֹהָג למידע נוסף.

יְרוּשָׁה
כברירת מחדל, בעת מציאת קובץ תצורה, pydocstyle מנסה לרשת את ההורה
התצורה של הספרייה ומזג אותם לאלה המקומיים.

תהליך המיזוג הוא כדלקמן:

· אם אחד מ בחר, להתעלם or כנס צוין בתצורת הילד -
מתעלם מתצורת האב ומגדיר את קודי השגיאה החדשים לבדיקה. אחרת, פשוט
מעתיק את קודי השגיאה שנבדקו בהורה.

· אם הוספה-התעלם or הוסף-בחר צוינו, מוסיף או מסיר את קודי השגיאה שצוינו
מרשימת קודי השגיאה המסומנים.

· אם להתאים or match-dir צוינו - השתמש בהם. אחרת, השתמש בהורה.

על מנת לבטל זאת (שימושי עבור קובצי תצורה הממוקמים בשורש ה-repo שלך),
פשוט להוסיף ירושה=שקר לקובץ התצורה שלך.

הערה:
אם מישהו מ בחר, להתעלם or כנס צוינו ב-CLI, התצורה
קבצים לא ייקחו חלק בבחירה אילו קודי שגיאה ייבדקו. להתאים ו
match-dir עדיין ייכנס לתוקף.

דוגמה
[pydocstyle]
ירושה = שקר
התעלם = D100,D203,D405
match = *.py

ERROR קודים

הַקבָּצָה
┌─────────────────────────┬─────────────────────── ───────────┐
│חסר מסמכים │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D100 │ מחרוזת doc חסר בציבור │
│ │ מודול │
├─────────────────────────┼─────────────────────── ───────────┤
│D101 │ מחרוזת doc חסר בציבור │
│ │ מחלקה │
├─────────────────────────┼─────────────────────── ───────────┤
│D102 │ מחרוזת doc חסר בציבור │
│ │ שיטה │
├─────────────────────────┼─────────────────────── ───────────┤
│D103 │ מחרוזת doc חסר בציבור │
│ │ פונקציה │
├─────────────────────────┼─────────────────────── ───────────┤
│D104 │ מחרוזת doc חסר בציבור │
│ │ חבילה │
├─────────────────────────┼─────────────────────── ───────────┤
│D105 │ מחרוזת doc חסר בקסם │
│ │ שיטה │
├─────────────────────────┼─────────────────────── ───────────┤
│מרחב לבן נושאים │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D200 │ מחרוזת doc-שורה אחת צריכה להתאים ל│
│ │ שורה אחת עם מרכאות │
├─────────────────────────┼─────────────────────── ───────────┤
│D201 │ אין מותרות שורות ריקות לפני │
│ │ function docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D202 │ אין מותרות שורות ריקות לאחר │
│ │ function docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D203 │ נדרשת שורה ריקה אחת לפני │
│ │ class docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D204 │ נדרשת שורה ריקה אחת לאחר │
│ │ class docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D205 │ נדרשת שורה ריקה אחת בין │
│ │ שורת סיכום ותיאור │
└─────────────────────────┴─────────────────────── ───────────┘

│D206 │ יש להכניס את המחרוזת למסמך │
│ │ עם רווחים, לא טאבים │
├─────────────────────────┼─────────────────────── ───────────┤
│D207 │ מחרוזת מסמך מורחבת │
├─────────────────────────┼─────────────────────── ───────────┤
│D208 │ מחרוזת מסמך מוכנסת יתר על המידה │
├─────────────────────────┼─────────────────────── ───────────┤
│D209 │ סגירת מחרוזת דוקו מרובת שורות │
│ │ מרכאות צריכות להיות על │ נפרד
│ │ קו │
├─────────────────────────┼─────────────────────── ───────────┤
│D210 │ אין רווחים לבנים │
│ │ טקסט מקיף של מחרוזת doc │
├─────────────────────────┼─────────────────────── ───────────┤
│D211 │ אין מותרות שורות ריקות לפני │
│ │ class docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│ציטוטים נושאים │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D300 │ השתמש ב-""מרכאות כפולות משולשות""" │
├─────────────────────────┼─────────────────────── ───────────┤
│D301 │ השתמש ב-r""" אם יש קווים אחוריים ב-│
│ │ docstring │
├─────────────────────────┼─────────────────────── ───────────┤
│D302 │ השתמש ב-u""" עבור מחרוזות docstrings של Unicode │
├─────────────────────────┼─────────────────────── ───────────┤
│דוקסטרינג תוֹכֶן נושאים │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D400 │ השורה הראשונה צריכה להסתיים ב- │
│ │ נקודה │
├─────────────────────────┼─────────────────────── ───────────┤
│D401 │ השורה הראשונה צריכה להיות ב- │
│ │ מצב רוח ציווי │
├─────────────────────────┼─────────────────────── ───────────┤
│D402 │ השורה הראשונה לא צריכה להיות │
│ │ ה"חתימה" של הפונקציה │
├─────────────────────────┼─────────────────────── ───────────┤
│D403 │ מילה ראשונה בשורה הראשונה │
│ │ יש להשתמש באותיות גדולות כראוי │
└─────────────────────────┴─────────────────────── ───────────┘

בְּרִירַת מֶחדָל בדיקות
לא כל קודי השגיאה מסומנים כברירת מחדל. התנהגות ברירת המחדל היא לבדוק בלבד
קודי שגיאה שהם חלק מה- PEP257 כינוס רשמי.

כל קודי השגיאה לעיל נבדקים כברירת מחדל למעט D203.

pydocstyle הוא שינוי שם והמשך של pep257, פרויקט שנוצר על ידי ולדימיר קלשב.

מתוחזק עמיר רחום.

השתמש ב-pydocstyle באינטרנט באמצעות שירותי onworks.net