python中的__doc__,__name__
来源:互联网 发布:windows键锁定 编辑:程序博客网 时间:2024/05/16 19:10
模块的name
每个模块都有一个名称,在模块中可以通过语句来找出模块的名称。这在一个场合特别有用——就如前面所提到的,当一个模块被第一次输入的时候,这个模块的主块将被运行。假如我们只想在程序本身被使用的时候运行主块,而在它被别的模块输入的时候不运行主块,我们该怎么做呢?这可以通过模块的name属性完成。
使用模块的name
例 使用模块的name
#!/usr/bin/python# Filename: using_name.pyif __name__ == '__main__': print 'This program is being run by itself'else: print 'I am being imported from another module'(源文件:code/using_name.py)输出$ python using_name.pyThis program is being run by itself$ python>>> import using_nameI am being imported from another module>>>
它如何工作
每个Python模块都有它的name,如果它是’main‘,这说明这个模块被用户单独运行,我们可以进行相应的恰当操作。
DocStrings
Python有一个很奇妙的特性,称为 文档字符串 ,它通常被简称为 docstrings 。DocStrings是一个重要的工具,由于它帮助你的程序文档更加简单易懂,你应该尽量使用它。你甚至可以在程序运行的时候,从函数恢复文档字符串!
使用DocStrings
例 使用DocStri#!/usr/bin/python
Filename: func_doc.py
def printMax(x, y):
”’Prints the maximum of two numbers.
The two values must be integers.'''x = int(x) # convert to integers, if possibley = int(y)if x > y: print x, 'is maximum'else: print y, 'is maximum'
printMax(3, 5)
print printMax.doc件:code/func_doc.py)
输出
$ python func_doc.py5 is maximumPrints the maximum of two numbers. The two values must be integers.
它如何工作
在函数的第一个逻辑行的字符串是这个函数的 文档字符串 。注意,DocStrings也适用于模块和类,我们会在后面相应的章节学习它们。
文档字符串的惯例是一个多行字符串,它的首行以大写字母开始,句号结尾。第二行是空行,从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。
你可以使用doc(注意双下划线)调用printMax函数的文档字符串属性(属于函数的名称)。请记住Python把 每一样东西 都作为对象,包括这个函数。我们会在后面的类一章学习更多关于对象的知识。
如果你已经在Python中使用过help(),那么你已经看到过DocStings的使用了!它所做的只是抓取函数的doc属性,然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(printMax)。记住按q退出help。
自动化工具也可以以同样的方式从你的程序中提取文档。因此,我 强烈建议 你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令,与help()类似地使用DocStrings。
- python中的__doc__,__name__
- Python语言中的__name__和__doc__
- python的 __name__和__doc__属性
- Python中的__doc__
- python学习[1]_python中的__name__属性和__doc__属性使用示
- python __init__.py __name__ __doc__ __file__ argv[0] 浅析
- self、__doc__、__init__、__name__
- python __doc__
- python中的__name__小议
- Python中的 __name__
- Python中的__name__属性
- Python中的__name__属性
- python中的__name__和__main__
- python中的__name__的使用
- python 文件中的__name__是什么?
- python 模块中的 __name__ 变量
- python模块中的__name__使用
- python __doc__
- Android应用层View绘制流程与源码分析
- 认识<hr>标签,添加水平横线
- Callable、Future和FutureTask
- <address>标签,为网页加入地址信息
- SpringMVC i18n国际化资源文件路径配置
- python中的__doc__,__name__
- 大一下学期我的c++学习方面实践体会
- 暴力枚举算法之谁做的好事
- Linux 文件系统与设备文件系统 (二)—— sysfs 文件系统与Linux设备模型
- 批注:C++设计模式——工厂方法模式:合并
- 学习算法导论过程的汇总
- Timer和TimerTask(转载)
- Java线程面试题 Top 50
- 省赛总结