使用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数据统计的一些小技巧
Jul 21 Python
python 数据清洗之数据合并、转换、过滤、排序
Feb 12 Python
python之PyMongo使用总结
May 26 Python
Python字符串拼接六种方法介绍
Dec 18 Python
TensorFlow损失函数专题详解
Apr 26 Python
Python+OpenCV目标跟踪实现基本的运动检测
Jul 10 Python
详解pandas DataFrame的查询方法(loc,iloc,at,iat,ix的用法和区别)
Aug 02 Python
Python 脚本拉取 Docker 镜像问题
Nov 10 Python
python调用函数、类和文件操作简单实例总结
Nov 29 Python
keras实现图像预处理并生成一个generator的案例
Jun 17 Python
tensorflow基于CNN实战mnist手写识别(小白必看)
Jul 20 Python
基于Django快速集成Echarts代码示例
Dec 01 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
玩转虚拟域名◎+ .
2006/10/09 PHP
PHP 基于文件头的文件类型验证类函数
2012/05/01 PHP
php去掉文件前几行的方法
2015/07/29 PHP
img的onload的另类用法
2008/01/10 Javascript
jquery.messager.js插件导致页面抖动的解决方法
2013/07/14 Javascript
简介JavaScript中getUTCMonth()方法的使用
2015/06/10 Javascript
JavaScript function函数种类详解
2016/02/22 Javascript
JS检测页面中哪个HTML标签触发点击事件的方法
2016/06/17 Javascript
使用node.js搭建服务器
2017/05/20 Javascript
JavaScript实现二维坐标点排序效果
2017/07/18 Javascript
AngularJS实现的JSONP跨域访问数据传输功能详解
2017/07/20 Javascript
Vue动态修改网页标题的方法及遇到问题
2019/06/09 Javascript
JavaScript实现旋转木马轮播图
2020/03/16 Javascript
微信小程序 button样式设置为图片的方法
2020/06/19 Javascript
vue实现循环滚动列表
2020/06/30 Javascript
简单介绍Ruby中的CGI编程
2015/04/10 Python
在ironpython中利用装饰器执行SQL操作的例子
2015/05/02 Python
简单了解Django模板的使用
2017/12/20 Python
Python基于pyCUDA实现GPU加速并行计算功能入门教程
2018/06/19 Python
Django unittest 设置跳过某些case的方法
2018/12/26 Python
python调用staf自动化框架的方法
2018/12/26 Python
python使用参数对嵌套字典进行取值的方法
2019/04/26 Python
tensorflow 只恢复部分模型参数的实例
2020/01/06 Python
使用SimpleITK读取和保存NIfTI/DICOM文件实例
2020/07/01 Python
修复iPhone的safari浏览器上submit按钮圆角bug
2012/12/24 HTML / CSS
美国专营婴幼儿用品的购物网站:buybuy BABY
2017/01/01 全球购物
汤米巴哈马官方网站:Tommy Bahama
2017/05/13 全球购物
Viking Direct荷兰:购买办公用品
2019/06/20 全球购物
MaBelle玛贝尔香港官网:香港钻饰连锁店
2019/09/09 全球购物
Footshop乌克兰:运动鞋的最大选择
2019/12/01 全球购物
信息技术毕业生自荐信范文
2014/03/13 职场文书
党员专题组织生活会发言材料
2014/10/17 职场文书
考研英语复习计划
2015/01/19 职场文书
爸爸的三轮车观后感
2015/06/16 职场文书
python实现A*寻路算法
2021/06/13 Python
Python list列表删除元素的4种方法
2021/11/01 Python