פונקציית העזרה בפייתון (help())

פונקציית העזרה ב-Python משמשת לקבלת תיעוד של מודול, מחלקה, פונקציה, משתנים וכו'. השיטה הזו בדרך כלל משמשת עם מסוף מקרנו של Python כדי לקבל פרטים על אובייקטים ב-Python.

פונקציית עזר של Python

סינטקסיס של פונקציית עזר של Python הוא:

help([object])

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

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

אם ברצונך לצאת מקונסול העזר, הקלד quit. ניתן גם לקבל את התיעוד של העזר ישירות ממקונסול Python על ידי מעבר פרמטר לפונקציית העזר.

>>> help('collections')

>>> help(print)

>>> help(globals)

בוא נראה מהו הפלט של פונקציית העזר עבור פונקציית globals().

>>> help('builtins.globals')

Help on built-in function globals in builtins:

builtins.globals = globals()
    Return the dictionary containing the current scope's global variables.
    
    NOTE: Updates to this dictionary *will* affect name lookups in the current global scope and vice-versa.

הגדרת help() עבור מחלקות ופונקציות מותאמות אישית

אנו יכולים להגדיר את פלט הפונקציה help() עבור המחלקות והפונקציות המותאמות אישית שלנו על ידי הגדרת מחרוזת תיעוד (docstring). כברירת מחדל, מחרוזת ההערה הראשונה בגוף של שיטה משמשת כמחרוזת התיעוד שלה. היא מוקפת בשלושה גרשיים כפולים. נניח שיש לנו קובץ Python בשם python_help_examples.py עם הקוד הבא.

def add(x, y):
    """
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
    """
    return x + y


class Employee:
    """
    Employee class, mapped to "employee" table in Database
    """
    id = 0
    name = ''

    def __init__(self, i, n):
        """
        Employee object constructor
        :param i: integer, must be positive
        :param n: string
        """
        self.id = i
        self.name = n

שימו לב שהגדרנו מחרוזת תיעוד עבור פונקציה, מחלקה ושיטותיה. עליך לעקוב אחר פורמט מסוים לתיעוד, יצרתי חלק מהן באופן אוטומטי באמצעות סביבת הפיתוח PyCharm. מדריך docstring של NumPy הוא מקום טוב לקבל רעיונות לגבי הדרך הנכונה לתיעוד עזרה. בואו נראה איך לקבל את מחרוזת התיעוד הזו כתיעוד עזר בקונסולת Python. תחילה, עלינו לבצע את הסקריפט הזה בקונסולה כדי לטעון את הפונקציה וההגדרות של המחלקה שלנו. נוכל לעשות זאת באמצעות הפקודה exec().

>>> exec(open("python_help_examples.py").read())

נוכל לוודא שהפונקציות וההגדרות של המחלקה קיימות באמצעות הפקודה globals().

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

שימו לב ש-'Employee' ו-'add' קיימים במילון תחום הגלובלי. כעת נוכל לקבל את מחרוזת התיעוד עזר באמצעות פונקציית help(). בואו נסתכל על כמה מהדוגמאות.

>>> help('python_help_examples')

>>> help('python_help_examples.add')

Help on function add in python_help_examples:

python_help_examples.add = add(x, y)
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
(END)

>>> help('python_help_examples.Employee')

>>> help('python_help_examples.Employee.__init__')


Help on function __init__ in python_help_examples.Employee:

python_help_examples.Employee.__init__ = __init__(self, i, n)
    Employee object constructor
    :param i: integer, must be positive
    :param n: string
(END)

סיכום

פונקציית העזרה של Python מאוד מועילה לקבלת פרטים על מודולים, מחלקות ופונקציות. זהו תרגום מתוך המשפט המקורי שלך עבור המסמך שלי. זה תמיד שיטה מיטבית להגדיר מחרוזות תיעוד (docstrings) עבור המחלקות והפונקציות המותאמות אישית כדי להסביר את שימושם.

ניתן לבדוק סקריפט Python מלא ועוד דוגמאות ב-Python מתוך מאגר ה-GitHub שלנו.

הפנייה: תיעוד רשמי