可爱的Python- pydoc和distutils模块
可爱的Python: pydoc和distutils模块
一年前，如果您问一个诚实的 Python 推广者，Python 是否缺少某些如 Perl 等其它语言所拥有的重要的东西。答案很可能会是“是”。这并不是说 Python 缺少一定范围的模块和包的支持(包括 Python 自身和扩展模块)。这当然也不是 Python 胜人一筹的明确的表达式和简洁的面向对象。
建立在 Python 社区之上
Python 所欠缺的东西就是被 Perl 开发者描述为“社会因素”的东西。但即使这里，欠缺社会因素也并不意味着缺少一个积极的、智能的以及有支持力的 Python 社区 ― Python 有很多这样的社区。一年前的 Python 极度缺乏的是用来共享 Python 代码的充分规划的基础结构。代码共享是特定的、分散的和非常平凡的工作。
改进 Python 社会基础的第一步可能是 Tim Middleton 建立的 Vaults of Parnassus 网站(请参阅本文后面的 参考资料)。Python 开发者第一次拥有了一个专门的地方，那里有(几乎)所有已提供的第三方模块、包和工具。但这个地方仍有一些缺陷，使得这个网站可能比 Comprehensive Perl Archive Network 少了些优势(不过外表比后者更美观)，Vaults 网站只是指向实际的资源位置，并不作为实际资源的镜像。网站由 Middleton 手工维护，有时候更新很慢;并且 Vex.Net (Vaults 坐落的站点)曾经有间歇断线的故障。但总的来说，Vaults of Parnassus 在建立强大的 Python 社区的架构先决条件方面提供了宝贵的资源。
有了这样一个公共站点，Python 社区所需的一切就是用一致的、可靠的方法安装所有这些可用的模块、包以及工具;再用同样简洁的方法指出它们所起的作用。随着标准 Python 发布的一些新标准模块也给出了解决方法。 pydoc
Ka-Ping Yee 曾创建了一个相当著名的模块，名叫 pydoc (比较而言: pydoc 可以做到 perldoc 所能做的任何事，并且做得更好、更漂亮:-)。对于 Python 2.1 来说， pydoc (以及它支持的 inspect )是标准库的一部分。而对于使用 Python 1.5.2、1.6 或者 2.0 版本的用户来说，下载并安装 pydoc 也很简单 ― 请立即下载(请参阅 参考资料)。 作为提供给阅读这篇 Python 文章的任何初学者的背景资料，Python 一直有些半正式的文档标准。这些标准并没有试图过度地限制开发者，而是给开发者提供“一种明显的写文档的方法。”幸运的是，通常情况下，Python 开发者所写的文档比使用其它语言的典型开发者所写的要好得多。
Python 文档之所以“优秀”的主要因素是使用所谓的“docstring”。虽然 docstring 实际上只是一个被称为 _doc_ 的变量，但还是有一个普遍使用的创建它们的快捷方式:只要在模块、函数 def 、类定义或方法 def 的头部放入一个简单的由(三重)引号括起来的字符串。此外，还有几个接近标准的模块级的“魔术”变量名被经常使用。尽管那些文档规则不太正式，但几乎所有第三方的模块和标准模块的文档都使用相同的模式。让我们来看一个使用大部分元素的简化示例:
清单 1: 附带典型文档的模块 mymod.py
#!/usr/bin/python
"""Show off features of [pydoc] module
This is a silly module to
demonstrate docstrings
"""
__author__ = 'David Mertz'
__version__= '1.0'
__nonsense__ = 'jabberwocky'
class MyClass:
"""Demonstrate class docstrings"""
def __init__ (self, spam=1, eggs=2):
"""Set default attribute values only
Keyword arguments:
― a processed meat product spam
eggs ― a fine breakfast for lumberjacks
"""
self.spam = spam
self.eggs = eggs
本文档为【可爱的Python- pydoc和distutils模块】，请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑，
图片更改请在作品中右键图片并更换，文字修改请直接点击文字进行修改，也可以新增和删除文档中的内容。
该文档来自用户分享，如有侵权行为请发邮件ishare@vip.sina.com联系网站客服，我们会及时删除。
[版权声明] 本站所有资料为用户分享产生，若发现您的权利被侵害，请联系客服邮件isharekefu@iask.cn，我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权，请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传，仅限个人学习分享使用，禁止用于任何广告和商用目的。
浙公网安备 33021202002483