在 Python 中打印函数的文档字符串

作者

在 Python 中打印函数的文档字符串

Print the docstring of a function in Python

使用该__doc__属性打印函数的文档字符串，例如
print(my_function.__doc__). 该__doc__属性返回函数的文档字符串。

主程序
def do_math(a, b):
    """Returns the sum of two numbers."""

    print(do_math.__doc__)
    return a + b


# Returns the sum of two numbers.
# 25
print(do_math(10, 15))

# 👇️ Returns the sum of two numbers.
print(do_math.__doc__)

我们使用该__doc__属性来打印函数的文档字符串。

该__doc__属性返回函数的文档字符串，或者None如果函数没有文档字符串。
主程序
def do_math(a, b):
    """Returns the sum of two numbers."""

    # 👇️ print docstring from inside of a function
    print(do_math.__doc__)
    return a + b


print(do_math.__doc__)  # 👉️ Returns the sum of two numbers.

# -------------------------------------

# 👇️ without docstring
def example():
    pass


print(example.__doc__)  # 👉️ None

__doc__如果需要从函数内部打印函数的文档字符串，也可以使用该属性。

如果您需要在交互模式下打印函数的文档字符串，请使用该
help()函数。

主程序
def do_math(a, b):
    """Returns the sum of two numbers."""

    return a + b


# Help on function do_math in module __main__:

# do_math(a, b)
#     Returns the sum of two numbers.
# (END)
print(help(do_math))

该__doc__属性还可用于打印您导入的函数和方法的文档字符串。

主程序
from functools import partial

# partial(func, *args, **keywords) - new function with partial application
# of the given arguments and keywords.
print(partial.__doc__)

可以使用相同的方法打印您导入的整个模块的文档字符串。

主程序
import functools

# functools.py - Tools for working with functions and callable objects
print(functools.__doc__)

–

发表评论