pandas.describe_option

pandas.describe_option(pat='', _print_desc=True)

打印一个或多个已注册选项的描述。

不带参数调用以获取所有已注册选项的列表。

参数:

patstr, 默认 “”

字符串或字符串正则表达式模式。空字符串将返回所有选项。对于正则表达式字符串，所有匹配的键将显示其描述。

_print_desc布尔值, 默认为 True

如果为真（默认），描述将被打印到标准输出。否则，描述将以字符串形式返回（用于测试）。

返回:

None

如果 _print_desc=True。

str

如果作为字符串的描述(s) 如果 _print_desc=False。

参见

get_option

获取指定选项的值。

set_option

设置指定选项或选项的值。

reset_option

将一个或多个选项重置为其默认值。

备注

有关所有可用选项，请查看 用户指南。

例子

>>> pd.describe_option("display.max_columns")  
display.max_columns : int
    If max_cols is exceeded, switch to truncate view...