使用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 相关文章推荐
使用Node.js和Socket.IO扩展Django的实时处理功能
Apr 20 Python
python的paramiko模块实现远程控制和传输示例
Oct 13 Python
浅谈Matplotlib简介和pyplot的简单使用——文本标注和箭头
Jan 09 Python
python 判断网络连通的实现方法
Apr 22 Python
python实现微信机器人: 登录微信、消息接收、自动回复功能
Apr 29 Python
pandas实现将dataframe满足某一条件的值选出
Jun 12 Python
解决py2exe打包后,总是多显示一个DOS黑色窗口的问题
Jun 21 Python
python groupby 函数 as_index详解
Dec 16 Python
tensorflow pb to tflite 精度下降详解
May 25 Python
pytorch--之halfTensor的使用详解
May 24 Python
写一个Python脚本下载哔哩哔哩舞蹈区的所有视频
May 31 Python
python cv2图像质量压缩的算法示例
Jun 04 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
有关JSON以及JSON在PHP中的应用
2010/04/09 PHP
支持中文和其他编码的php截取字符串函数分享(截取中文字符串)
2014/03/13 PHP
PHP动态规划解决0-1背包问题实例分析
2015/03/23 PHP
javascript基础的动画教程,直观易懂
2007/01/10 Javascript
JavaScript执行效率与性能提升方案
2012/12/21 Javascript
商城常用滚动的焦点图效果代码简单实用
2013/03/28 Javascript
js 获取(接收)地址栏参数值的方法
2013/04/01 Javascript
js读取注册表的键值示例
2013/09/25 Javascript
js验证真实姓名与身份证号是否匹配
2015/10/13 Javascript
详解JavaScript逻辑Not运算符
2015/12/04 Javascript
jquery实现简单的遮罩层
2016/01/08 Javascript
利用jQuery的动画函数animate实现豌豆发射效果
2016/08/28 Javascript
炫酷的js手风琴效果
2016/10/13 Javascript
RGB和YUV 多媒体编程基础详细介绍
2016/11/04 Javascript
js Canvas绘制圆形时钟教程
2017/02/06 Javascript
纯JS单页面赛车游戏制作代码分享
2017/03/03 Javascript
使用vue如何构建一个自动建站项目
2018/02/05 Javascript
p5.js入门教程之平滑过渡(Easing)
2018/03/16 Javascript
webpack开发环境和生产环境的深入理解
2018/11/08 Javascript
基于Node的Axure文件在线预览的实现代码
2019/08/28 Javascript
vue实现抖音时间转盘
2019/09/08 Javascript
js实现全选和全不选功能
2020/07/28 Javascript
[01:07:41]IG vs VGJ.T 2018国际邀请赛小组赛BO2 第一场 8.18
2018/08/19 DOTA
详解Django框架中的视图级缓存
2015/07/23 Python
python实现用户答题功能
2018/01/17 Python
python自动发送邮件脚本
2018/06/20 Python
符合语言习惯的 Python 优雅编程技巧【推荐】
2018/09/25 Python
Python selenium根据class定位页面元素的方法
2019/02/26 Python
解决python调用自己文件函数/执行函数找不到包问题
2020/06/01 Python
纯css3使用vw和vh实现自适应的方法
2018/02/09 HTML / CSS
土耳其新趋势女装购物网站:Addax
2020/01/07 全球购物
土建资料员岗位职责
2014/01/04 职场文书
党员学习十八大感想
2014/01/17 职场文书
生日寄语大全
2014/04/08 职场文书
大一新生军训新闻稿
2015/07/17 职场文书
python用tkinter开发的扫雷游戏
2021/06/01 Python