主页 / 问题 / 606453
Accepted
alecxe
Asked:2020-12-22 12:18:24 +0000 UTC2020-12-22 12:18:24 +0000 UTC

禁止显式继承对象

  • 772

问题描述：

在 Python-2.x 中，如果你想声明一个新式类，你必须显式继承自object，如下所示：

class A(object):
    def __init__(self, prop):
        self.prop = prop

在 Python-3.x 中，类被隐式声明为继承object自，你可以简单地写：

class A:
    def __init__(self, prop):
        self.prop = prop

但是，类声明的两种变体都可以在 3.x 中使用。

问题：

是否有可能在静态代码分析和诸如 之类的工具的帮助下pylint，flake8禁止类声明的第一个过时版本？

请不要过于严厉地判断 - 这是我在 en.SO 上的第一个问题。

python

1 个回答

  1. Best Answer

    首先，让我们手动检查一下，以便大致了解 PyLint 到底做了什么。要检查的文件示例（让它成为tester.py）：

    class MyClass(object):
    pass


class MyAnotherClass(MyClass):
    pass


class MyNormalClass:
    pass


class MyStringInteger(str, int, object):
    pass

    现在是一个将检查源代码的脚本示例：

    import ast

MODULE_PATH = "tester.py"
with open(MODULE_PATH, "r", encoding="utf8") as f:
    MODULE_AS_STRING = f.read()

root = ast.parse(source=MODULE_AS_STRING)
nodes_gen = ast.walk(root)
for node in nodes_gen:
    if type(node) is ast.ClassDef:
        print("Yo! Found class definition. Classname: ", node.name)
        bases_list = []
        for bc in node.bases:
            bases_list.append(bc.id)
        print("Base classes:", ', '.join(bases_list))

    结果：

    Yo! Found class definition. Classname:  MyClass
Base classes: object
Yo! Found class definition. Classname:  MyAnotherClass
Base classes: MyClass
Yo! Found class definition. Classname:  MyNormalClass
Base classes: 
Yo! Found class definition. Classname:  MyStringInteger
Base classes: str, int, object

    该脚本以文本形式打开模块，然后将其转换为抽象语法树 (AST)，您已经可以使用这棵树了。Pylint 的工作方式大致相同，但使用NodeVisitor遍历树。此访问者在找到元素时调用某些方法。例如，visit_classdef遇到类定义时调用。visit_callfunc遇到函数调用时调用。等等 - 常量、assert数学运算以及语言中的所有内容。为了给pylint自己附加一个时髦的东西，你需要编写如下类（pylint_plugin.py 文件）：

    from pylint.checkers import BaseChecker, utils
from pylint.interfaces import IAstroidChecker

BASE_ID = 56

def register(linter):
    print("Registering pylint plugin...")
    linter.register_checker(MyClassChecker(linter))
    print("Yo! Registered!")


class MyClassChecker(BaseChecker):

    __implements__ = IAstroidChecker
    MESSAGE_ID = "bad_classes_with_object"

    msgs = {
        'W%d01' % BASE_ID: ("%s classname has some problems with object...",
                        MESSAGE_ID,
                        "Please rewrite")
    }

    # Обязательно необходимо определить этот аттрибут
    name = "object_inheritance_checker"

    @utils.check_messages(MESSAGE_ID)
    def visit_classdef(self, node):
        for bc in node.bases:
        # Внимание - это уже класс astroid.Name
        if bc.name == 'object':
            print("MY CLASSES PRINT! YO!", node)
            self.add_message(msg_id=self.MESSAGE_ID, node=node, args=node.name)

    文档pylint不亮，所以我不完全确定插件的正确性，它被写成“只是为了工作”（唉）。为了自己编写，您将需要以下内容（所有内容均在https://pylint.readthedocs.io/en/latest/reference_guide/custom_checkers.html中进行了描述）：

    1. 一个register(linter)会告诉你使用额外检查的函数。必须linter.register_checker为所有附加检查调用此函数。

    2. 实际上，这些类是跳棋（访问者）。这些类必须定义：

      • 名称（属性name）——实际上是检查的名称。
      • 优先级（属性priority）必须小于零。
      • 消息字典msgs。该词典应具有以下结构：msgs = {'message-id': ('displayed-message', 'message-symbol', 'message-help')}. message_id必须是唯一的，并且不与现有的冲突。它由标识符 - 组成C, W, E, F, R，意思是Convention - соглашение, Warning - предупреждение, Error - ошибка, Fatal - ужасная ошибка and Refactoring - переделать。此外，message_id 由一个 4 位数字组成。我见过的几乎所有项目都使用自己的某种类型BASE_ID和消息编号。那。message_id限制为 5 个字符。为什么这样做是不可思议的。
      • 实际上，检查代码中某些结构的函数本身。已经提到visit_<node_name>我们需要检查类及其后代的定义 - 所以让我们这样做吧。在函数本身中，您需要注意它pylint使用的不是本机模块ast，而是模块astroid以及相应的所有节点astroid。

    如果所有这些都完成了，插件就准备好了，可以这样调用：

    pylint --load-plugins "pylint_plugin" tester.py

    最后会有这样的报告：

    Messages

--------


+------------------------+------------+
|message id              |occurrences |
+========================+============+
|missing-docstring       |5           |
+------------------------+------------+
|too-few-public-methods  |3           |
+------------------------+------------+
|bad_classes_with_object |2           |
+------------------------+------------+

    2 个坏类 - 如上所述。

    • 12

相关问题