使用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使用arp欺骗伪造网关的方法
Apr 24 Python
使用PyInstaller将Python程序文件转换为可执行程序文件
Jul 08 Python
Python常用内置模块之xml模块(详解)
May 23 Python
Python cookbook(数据结构与算法)保存最后N个元素的方法
Feb 13 Python
Python button选取本地图片并显示的实例
Jun 13 Python
Django  ORM 练习题及答案
Jul 19 Python
关于Python-faker的函数效果一览
Nov 28 Python
在pycharm中为项目导入anacodna环境的操作方法
Feb 12 Python
pytorch实现seq2seq时对loss进行mask的方式
Feb 18 Python
Django ORM 查询表中某列字段值的方法
Apr 30 Python
Python分类测试代码实例汇总
Jul 23 Python
Python 代码调试技巧示例代码
Aug 11 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
SSI指令
2006/11/25 PHP
关于shopex同步ucenter的redirect问题,导致script不运行
2013/04/10 PHP
php实现阿拉伯数字和罗马数字相互转换的方法
2015/04/17 PHP
php简单备份与还原MySql的方法
2016/05/09 PHP
php接口实现拖拽排序功能
2018/04/23 PHP
PHP实现的CURL非阻塞调用类
2018/07/26 PHP
laravel数据库查询结果自动转数组修改实例
2021/02/27 PHP
通过ifame指向的页面高度调整iframe的高度
2006/10/05 Javascript
jValidate 基于jQuery的表单验证插件
2009/12/12 Javascript
JQuery扩展插件Validate 3通过参数设置错误信息
2011/09/05 Javascript
jquery教程ajax请求json数据示例
2014/01/13 Javascript
JS 对象(Object)和字符串(String)互转方法
2016/05/20 Javascript
jQuery Select下拉框操作小结(推荐)
2016/07/22 Javascript
微信小程序 页面传值详解
2017/03/10 Javascript
ztree实现权限横向显示功能
2017/05/20 Javascript
vue-resource 拦截器(interceptor)的使用详解
2017/07/04 Javascript
Angular.js中angular-ui-router的简单实践
2017/07/18 Javascript
详解vue-cli 构建项目 vue-cli请求后台接口 vue-cli使用axios、sass、swiper
2018/05/28 Javascript
如何能分清npm cnpm npx nvm
2019/01/17 Javascript
python 图片验证码代码分享
2012/07/04 Python
python实现的正则表达式功能入门教程【经典】
2017/06/05 Python
python获取本机所有IP地址的方法
2018/12/26 Python
浅谈python requests 的put, post 请求参数的问题
2019/01/02 Python
Python基础教程之异常详解
2019/01/10 Python
python将字符串list写入excel和txt的实例
2019/07/20 Python
python正则表达式匹配不包含某几个字符的字符串方法
2019/07/23 Python
Django中使用CORS实现跨域请求过程解析
2019/08/05 Python
python爬取百度贴吧前1000页内容(requests库面向对象思想实现)
2019/08/10 Python
python连接PostgreSQL数据库的过程详解
2019/09/18 Python
python库skimage给灰度图像染色的方法示例
2020/04/27 Python
selenium+python实现基本自动化测试的示例代码
2021/01/27 Python
请介绍一下Ant
2016/07/22 面试题
员工团队活动方案
2014/08/28 职场文书
法制演讲稿
2014/09/10 职场文书
市场营销计划书范文
2015/01/16 职场文书
python超详细实现完整学生成绩管理系统
2022/03/17 Python