时间戳

首页 > 解决方案 > 理解 Python 函数文档的指南

python - 理解 Python 函数文档的指南

问题描述

是否有关于如何阅读和理解 Python 文档的指南/说明？例如，help(pd.concat)产生以下文本

concat(objs: Union[Iterable[Union[ForwardRef('DataFrame'), ForwardRef('Series')]], Mapping[Union[Hashable, NoneType], Union[ForwardRef('DataFrame'), ForwardRef('Series')]]], axis=0, join='outer', ignore_index: bool = False, keys=None, levels=None, names=None, verify_integrity: bool = False, sort: bool = False, copy: bool = True) -> Union[ForwardRef('DataFrame'), ForwardRef('Series')]
...
keys : sequence, default None
        If multiple levels passed, should contain tuples. Construct
        hierarchical index using the passed keys as the outermost level.
levels : list of sequences, default None
        Specific levels (unique values) to use for constructing a
        MultiIndex. Otherwise they will be inferred from the keys.

我不知道它的含义keys和levels帮助文档中的含义。（特定）级别（in levels）是否与（多个）级别（in keys）相同？帮助文档是否仅适用于开发人员？参数是否有字典/索引？为什么函数的帮助文档中没有每个参数的示例？

标签： python

解决方案

对于这种功能。最好阅读文档而不是文档。由于篇幅限制，该文档是一个简明的摘要。

您可能需要文档，例如pd.concat

推荐阅读