python中注释的方法,python引导符号
本文前言中不推荐使用的IDE配置标记示例
序
在python中,如果你有一个函数或类目前不工作,或者即将被放弃,但是你不想删除它,那么你可以把它标记为deprecated。其实我更想做什么?当我可以标记的函数或类在其他地方使用时,它可以有直观的提示。用java开发的童鞋,思路一定要清晰。只要java代码中的类或函数标有@Deprecated注释,删除线就会在所有使用它的地方被可视化标记。
那么PyCharm或者Idea是否也有利用Python插件检测和提示Python的能力呢?
是啊!
IDE PyCharm和Idea的配置非常智能,可以识别Python的函数或类是否被标记为弃用,并显示删除线。
Preferences-Editor-inspections,在搜索框中输入Deprecated,看看在Python中是否勾选。默认情况下应该选中它。
我们来看看描述:
这种检查突出显示了被标记为不推荐使用的Python函数、类或方法的用法(会引发DeprecationWarning或PendingDeprecationWarning)。
意思是:检查python的函数、类或类函数是否标记了deprecated(抛出DeprecationWarning或PendingDeprecationWarning警告),如果是,则高亮显示(实际上是删除线)。
标记已弃用的导入警告def some _ old _ function (x,y)的示例:#这一行警报代码被识别为警告。warn (some _ old _ function已弃用,弃用警告)返回x ysome _ old _ function (12,34)
关键是warnings . warn( some _ old _ function已弃用,贬值警告),PyCharm认可。
请注意,以上仅允许IDE识别放弃并使用删除线提示。
如果要生成doc帮助文档,可以安装不推荐使用的模块一起使用。
pip安装已弃用
安装后,您可以按如下方式使用它:
import warnings from deprecated . sphinx import deprecated warnings . filter warnings( always )@ deprecated(版本=1.0 ,原因=此函数即将删除)def some_old_function(x,y):warnings . warn( some _ old _ function已被弃用,depreciation warning)return x yif _ _ name _ _= _ _ main _ _ :some _ old _ function(12,34) help(some_old_function)
之后,结果如下:
@deprecated批注将更改函数的__doc__属性,您可以看到帮助文档被打印出来。如果要打印出警告信息,需要在前面加上warnings . filter warnings( always )。
因此您可以看到打印的报警信息。
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。