Блог

Допустим, у меня есть следующая функция:

 def get_fullname(first: str, last: str = "Miller"):
    """
    :param first: First name
    :param last: Last name
    :return: Fullname
    """
    return f"{first} {last}"
  

Я знаю, что могу получить кучу информации о функции, используя inspect модуль:

 import inspect
spec = inspect.getfullargspec(get_fullname)
print(spec)
# FullArgSpec(args=['first', 'last'], varargs=None, varkw=None, defaults=('Miller',), kwonlyargs=[], kwonlydefaults=None, annotations={'first': <class 'str'>, 'last': <class 'str'>})
  

Могу ли я программно получить описания этих аргументов? Не похоже, что это возможно, но просто убедиться. Похоже, что это PyCharm способ указания типов.

Вы можете установить и использовать docstring_parser :

 import docstring_parser

def get_fullname(first: str, last: str = "Miller"):
    """
    :param first: First name
    :param last: Last name
    :return: Fullname
    """
    return f"{first} {last}"

doc = docstring_parser.parse(get_fullname.__doc__)
for param in doc.params:
    print(param.arg_name, param.description)
print(doc.returns.description)
  

Это выводит:

 first First name
last Last name
Fullname
  

Существует встроенный .__doc__ атрибут для таких вещей, как функции и классы (без установки дополнительных модулей). Например:

 def get_fullname(first: str, last: str = "Miller"):
    """
    :param first: First name
    :param last: Last name
    :return: Fullname
    """
    return "{first} {last}"
print(get_fullname.__doc__)
  

Дает:

     :param first: First name
    :param last: Last name
    :return: Fullname
  

Не уверен, что это то, что вы собираетесь найти. Это просто печатает строку документа напрямую и не анализирует ее, как ответ @blhsing