使用Python3内置文档高效学习以及官方中文文档


Posted in Python onMay 19, 2019

概述

从前面的对Python基础知识方法介绍中,我们几乎是围绕Python内置方法进行探索实践,比如字符串、列表、字典等数据结构的内置方法,和大量内置的标准库,诸如functools、time、threading等等,而我们怎么快速学习掌握并学会使用这个Python的工具集呢? 我们可以利用Python的内置文档大量资源既可以掌握许多关于Python工具集的基本使用。

dir函数

Python中内置的dir函数用于提取某对象内所有属性的方法,,诸如对象的方法及属性

L = [1, 2, 3, 4]
print(dir(L))
print([])

示例结果:

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

可以看到我们可以传入某实例对象查看其属性,也可以直接传入其内置类型的空对象查看对应属性,我们甚至还可以直接传入类型的名称得到对应的属性列表:

print(dir(list))

示例结果:

['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__delslice__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__getslice__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__setslice__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

虽然我们获得了对象的属性,但我们仍然不知道这些属性方法的含义,那么我们可以利用文档字符串帮助我们继续学习对象属性。

文档字符串:doc

文档字符串是由Python自动生成的,而生成的内内容和位置取决于我们的放置方式,文档字符串也是一段注释,放在模块文件、函数以及类语句的顶端,然后Python会自动封装这个字符串,即成为所谓的文档字符串,通过对象的__doc__进行查看。

def two_sum(x, y):
 '''
 Used to calculate the sum of two numbers
 '''
 return x + y


print(two_sum.__doc__)

示例结果:

Used to calculate the sum of two numbers

以上示例就实现了对一个函数(用于计算两数之和)绑定文档字符串并查看其文档字符串的过程。我们也可以查看一些内置类型的某属性的具体使用方法,比如查看列表对象中pop的具体含义和用法

L = [1, 2, 3, 4]
print(L.pop.__doc__)

示例结果:

L.pop([index]) -> item -- remove and return item at index (default last).
Raises IndexError if list is empty or index is out of range.

PyDoc:help函数

我们可以利用Python中help函数工具更加友好结构化的展示对象的文档字符串和其他的信息,对于对于某些较大的对象help内容会分成几段,甚至可以进行交互展示对象的详细信息。

help(list)

交互结果:

Help on class list in module __builtin__:

class list(object)
 |  list() -> new empty list
 |  list(iterable) -> new list initialized from iterable's items
 |
 |  Methods defined here:
 |
 |  __add__(...)
 |      x.__add__(y) <==> x+y
 |
 |  __contains__(...)
 |      x.__contains__(y) <==> y in x
 |
 |  __delitem__(...)
 |      x.__delitem__(y) <==> del x[y]
 |
 |  __delslice__(...)
 |      x.__delslice__(i, j) <==> del x[i:j]
 |
-- More  --

比如我们可以通过help查看列表的所有详细信息和属性的用法等,通过回车键查看更多的信息。

官方中文文档

对于英文阅读有一定困难的小伙伴,新出Python官方中文文档是较好的学习体验教程:docs.python.org/zh-cn/3/,从入门教程,标准库,在到Python高级特性应有尽有,算是不错的学习资源和一本常用的**“Python字典”**。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
python批量修改文件后缀示例代码分享
Dec 24 Python
python文件和目录操作函数小结
Jul 11 Python
几个提升Python运行效率的方法之间的对比
Apr 03 Python
Python验证码识别处理实例
Dec 28 Python
Python3学习urllib的使用方法示例
Nov 29 Python
pygame实现雷电游戏雏形开发
Nov 20 Python
Windows 安装 Anaconda3+PyCharm的方法步骤
Jun 13 Python
梅尔频率倒谱系数(mfcc)及Python实现
Jun 18 Python
python框架flask入门之路由及简单实现方法
Jun 07 Python
Python使用jpype模块调用jar包过程解析
Jul 29 Python
python基于exchange函数发送邮件过程详解
Nov 06 Python
Python基于Tkinter开发一个爬取B站直播弹幕的工具
May 06 Python
python反编译学习之字节码详解
May 19 #Python
python从入门到精通 windows安装python图文教程
May 18 #Python
详解用Python实现自动化监控远程服务器
May 18 #Python
Python实现打砖块小游戏代码实例
May 18 #Python
如何在Python中实现goto语句的方法
May 18 #Python
OpenCV搞定腾讯滑块验证码的实现代码
May 18 #Python
Python3匿名函数lambda介绍与使用示例
May 18 #Python
You might like
php+html5基于websocket实现聊天室的方法
2015/07/17 PHP
PHP的Yii框架入门使用教程
2016/02/15 PHP
php字符集转换
2017/01/23 PHP
JavaScript 替换Html标签实现代码
2009/10/14 Javascript
详细讲解JS节点知识
2010/01/31 Javascript
jQuery学习4 浏览器的事件模型
2010/02/07 Javascript
extjs tabpanel限制选项卡数量实现思路及代码
2013/04/02 Javascript
Jquery实现动态切换图片的方法
2015/05/18 Javascript
举例详解JavaScript中Promise的使用
2015/06/24 Javascript
jQuery代码实现表格中点击相应行变色功能
2016/05/09 Javascript
AngularJs Understanding the Controller Component
2016/09/02 Javascript
BootStrap使用file-input插件上传图片的方法
2016/09/05 Javascript
js实现拖拽功能
2017/03/01 Javascript
jQuery插件HighCharts绘制的2D堆柱状图效果示例【附demo源码下载】
2017/03/14 Javascript
vue axios 简单封装以及思考
2018/10/09 Javascript
微信上传视频文件提示(推荐)
2018/11/22 Javascript
微信小程序实现跳转的几种方式总结(推荐)
2019/04/24 Javascript
webpack4 SplitChunks实现代码分隔详解
2019/05/23 Javascript
elementUI select组件使用及注意事项详解
2019/05/29 Javascript
基于Express框架使用POST传递Form数据
2019/08/10 Javascript
[54:58]完美世界DOTA2联赛PWL S2 LBZS vs Rebirth 第一场 11.25
2020/11/25 DOTA
Python3.x中自定义比较函数
2015/04/24 Python
Python赋值语句后逗号的作用分析
2015/06/08 Python
python编写弹球游戏的实现代码
2018/03/12 Python
一篇文章弄懂Python中所有数组数据类型
2019/06/23 Python
解决django同步数据库的时候app models表没有成功创建的问题
2019/08/09 Python
Python定时从Mysql提取数据存入Redis的实现
2020/05/03 Python
伦敦最著名的老字号百货公司:Selfridges(塞尔福里奇百货)
2016/07/25 全球购物
米兰网婚纱礼服法国网上商店:Milanoo法国
2016/08/20 全球购物
Stuarts London美国/加拿大:世界领先的独立男装零售商之一
2019/03/18 全球购物
美国体育用品商店:Academy Sports + Outdoors
2020/01/04 全球购物
惠普新加坡官方商店:HP Singapore
2020/04/17 全球购物
法律六进活动方案
2014/03/13 职场文书
专科应届毕业生求职信
2014/06/04 职场文书
公务员年度考核评语
2014/12/31 职场文书
python 实现德洛内三角剖分的操作
2021/04/22 Python