python中的内置属性__doc__和__name__（变量类型python的内置函数）

python中的内置属性__doc__和__name__（变量类型python的内置函数）

一、__doc__属性

前言

__doc__ 为python模块的内置属性【使用 方法名.__doc__ 调用】，__doc__ 为模块字符串，模块字符串写在Python文件的第一行，三个引号包含起来的字符串。

编写文档字符串的原因

因为规范的书写文档字符串可以通过sphinx等工具自动生成文档。

文档字符串的风格

①plain

# Plaindef foo1(a, b): """ """ return a + bif __name__ == '__main__': print(foo1.__doc__)

运行结果：

②Epytext

# Epytextdef foo(a, b): """ @param a: @param b: @return: """ return a + bif __name__ == '__main__': print(foo.__doc__)

运行结果：

③reStucturedText

# reStructuredTextdef foo2(a, b): """ :param a: :param b: :return: """ return a + bif __name__ == '__main__': print(foo2.__doc__)

运行结果：

④Numpy

# Numpydef foo3(a, b): """ Parameters ---------- a b Returns ------- """if __name__ == '__main__': print(foo3.__doc__)

运行结果：

⑤Google

# Googledef foo4(a, b): """ Args: a: b: Returns: """ return a + bif __name__ == '__main__': print(foo4.__doc__)

运行结果：

⑥Pycharm设置

settings->Tools->python integrated tools ->Docstrings->Docstring format

二、__name__属性

① __name__  是属于 python 中的内置类属性，代表对应程序名称。

②当 __name__ 在当前执行的文件中使用时，它的值为 __main__ ；但是当 __name__ 在被调用的模块中时，其值为被调用文件所在的路径。

③ __name__ 内置属性的实际应用。

在编写python程序时，经常是功能模块和业务逻辑模块分离，在写功能函数时，经常要进行调试函数是否正常，此时可以直接在功能模块最下面加上：

if __name__ == '__main__': # 需要调试的内容 pass

这样就可以在下方直接来测试函数的功能了。

同时在其他模块来调用这些函数时，由于此时 if 语句不成立，所以此时将不会执行下面的代码块；也就是说在在调用其他模块时，被调用的模块下方的 if 函数将不会被执行从而不会影响整个程序的正常使用。

去期待陌生，去拥抱惊喜。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。