Pandas官方文档如何快速区分类与实例?使用时易混淆该如何处理
Pandas文档区分类与实例的快速判断方法
你可以通过以下3个简单规则快速判断,不需要额外找命名约定说明:
- 看文档页首的类型标注
打开API页第一行的说明是最准确的判断依据:- 标注带
class前缀,比如示例1的class pandas.DataFrame(data=None, index=None, columns=None, dtype=None, copy=None),说明当前内容是类,可直接通过pd.类名原样调用,用来创建实例。 - 标注带
property/method前缀,且没有class前缀,比如示例2的property DataFrame.size,说明当前内容是类的实例属性/方法,文档里的DataFrame.xxx写法里的DataFrame是指代「该类的任意实例」,实际写代码时要替换成你自己创建的实例变量名。
- 标注带
- 看API路径的层级结构
文档标题里的API路径也可以辅助判断:- 路径最后一段是类名本身,比如
pandas.DataFrame,就是类 - 路径最后一段是
类名.xxx的后缀形式,不管后缀是属性还是方法,路径里的类名都是实例指代,需要替换成自己的变量。
- 路径最后一段是类名本身,比如
- 参考文档自带的示例代码
每个API页面下方都会附官方用法示例,直接看示例里的调用方式即可:如果示例是直接用pd.xxx调用,就是类级别的用法;如果是先创建实例再用实例名.xxx调用,就是实例级别的用法。
补充说明:这种
类名.属性/方法名的标注是Python官方文档的通用约定,不是pandas独有的设计,用来统一指代类所有实例共有的属性/方法,避免每个文档页都要重复定义实例变量名。
内容的提问来源于stack exchange,提问作者MiloNC
相关产品推荐
相关产品推荐

