לאובייקטים בפייטון יש attribute שנקרא __doc__ והוא למעשה מכיל את הדוקומנטציה של האובייקט. כשאנחנו נמצאים למשל ב IPython ויש לנו פונקציה שנרצה לקרוא בזריזות התיעוד בלי לצאת החוצה לדפדפן או לכלי אחר, פשוט נוח להציג את ה attribute למשל, עבור חבילת requests ועבור הפונקציה get של החבילה:
עכשיו אתם אומרים לעצמכם בטח שזו לא התצוגה הכי נוחה והכי מפורטת, אבל במקרים רבים זה כל מה שצריך. כמובן שניתן לשכלל את השימוש באובייקט ככה שהדוקומנטציה תוצג בצורה נאה יותר על המסך אבל את זה אני משאיר לכם ולכן כתרגיל ובכל מקרה אני לא חושב שבמקרה שצריך מעבר לתצוגה הזאת זה הפתרון הנכון. אני מציע את השימוש הזה רק במקרים בהם צריך מעט מידע נוסף על האוייבקט ורוצים להשאר מפוקסים על הקוד שכותבים.
אין תגובות:
הוסף רשומת תגובה