如何在python3中标记方法或类为废弃方法并在PyCharm中展示

一、背景：

使用过 Idea 做 java 开发的童鞋肯定很清楚，在 java 代码中的类或者方法只要标记了 @Deprecated 注解，在所有使用它的地方都会有删除线很直观的将其标记出来。那么，我们在使用 PyCharm 进行Python开发时应该如何做到 deprecated 检测并提示呢？

二、示例代码

# -*- coding: utf-8 -*-
import warnings


def test_deprecated(value: str) -> str:
    """
    deprecated测试方法
    :return: value
    """
    warnings.warn("此方法已废弃，不推荐使用", DeprecationWarning)
    return value

如上示例代码，只需导入warnings，并在需要废弃的方法中添加代码 warnings.warn("提示语，自定义", DeprecationWarning) 即可。

三、效果展示