2021-02-08 05:55:32 +00:00
|
|
|
"""
|
|
|
|
Example checker detecting deprecated functions/methods. Following example searches for usages of
|
|
|
|
deprecated function `deprecated_function` and deprecated method `MyClass.deprecated_method`
|
|
|
|
from module mymodule:
|
|
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
$ cat mymodule.py
|
|
|
|
def deprecated_function():
|
|
|
|
pass
|
|
|
|
|
|
|
|
class MyClass:
|
|
|
|
def deprecated_method(self):
|
|
|
|
pass
|
|
|
|
|
|
|
|
$ cat mymain.py
|
|
|
|
from mymodule import deprecated_function, MyClass
|
|
|
|
|
|
|
|
deprecated_function()
|
|
|
|
MyClass().deprecated_method()
|
|
|
|
|
|
|
|
$ pylint --load-plugins=deprecation_checker mymain.py
|
|
|
|
************* Module mymain
|
|
|
|
mymain.py:3:0: W1505: Using deprecated method deprecated_function() (deprecated-method)
|
|
|
|
mymain.py:4:0: W1505: Using deprecated method deprecated_method() (deprecated-method)
|
|
|
|
|
|
|
|
------------------------------------------------------------------
|
|
|
|
Your code has been rated at 3.33/10 (previous run: 3.33/10, +0.00)
|
|
|
|
"""
|
|
|
|
|
|
|
|
import astroid
|
|
|
|
|
|
|
|
from pylint.checkers import BaseChecker, DeprecatedMixin, utils
|
|
|
|
from pylint.interfaces import IAstroidChecker
|
|
|
|
|
|
|
|
|
2021-02-20 21:01:03 +00:00
|
|
|
class DeprecationChecker(DeprecatedMixin, BaseChecker):
|
2021-02-08 05:55:32 +00:00
|
|
|
"""Class implementing deprecation checker."""
|
|
|
|
|
2021-02-20 21:01:03 +00:00
|
|
|
# DeprecationMixin class is Mixin class implementing logic for searching deprecated methods and functions.
|
2021-02-21 12:56:05 +00:00
|
|
|
# The list of deprecated methods/functions is defined by implementing class via deprecated_methods callback.
|
|
|
|
# DeprecatedMixin class is overriding attributes of BaseChecker hence must be specified *before* BaseChecker
|
2021-02-20 21:01:03 +00:00
|
|
|
# in list of base classes.
|
|
|
|
|
2021-02-08 05:55:32 +00:00
|
|
|
__implements__ = (IAstroidChecker,)
|
|
|
|
# The name defines a custom section of the config for this checker.
|
|
|
|
name = "deprecated"
|
|
|
|
|
|
|
|
@utils.check_messages(
|
|
|
|
"deprecated-method",
|
|
|
|
)
|
|
|
|
def visit_call(self, node):
|
|
|
|
"""Called when a :class:`.astroid.node_classes.Call` node is visited.
|
|
|
|
|
|
|
|
See :mod:`astroid` for the description of available nodes.
|
|
|
|
|
|
|
|
:param node: The node to check.
|
|
|
|
:type node: astroid.node_classes.Call
|
|
|
|
"""
|
|
|
|
try:
|
|
|
|
for inferred in node.func.infer():
|
|
|
|
# Calling entry point for deprecation check logic.
|
|
|
|
self.check_deprecated_method(node, inferred)
|
|
|
|
except astroid.InferenceError:
|
|
|
|
return
|
|
|
|
|
|
|
|
def deprecated_methods(self):
|
|
|
|
"""Callback method called by DeprecatedMixin for every method/function found in the code.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
collections.abc.Container of deprecated function/method names.
|
|
|
|
"""
|
|
|
|
return {"mymodule.deprecated_function", "mymodule.MyClass.deprecated_method"}
|
|
|
|
|
|
|
|
|
|
|
|
def register(linter):
|
|
|
|
"""This required method auto registers the checker.
|
|
|
|
|
|
|
|
:param linter: The linter to register the checker to.
|
|
|
|
:type linter: pylint.lint.PyLinter
|
|
|
|
"""
|
|
|
|
linter.register_checker(DeprecationChecker(linter))
|