flake8-class-attributes-order

一个用于flake8的报告，用于报告错误的类属性顺序和类级别逻辑。

验证器可以提取类属性类型：文档字符串、属性、嵌套类、GLOBAL_VAR等。如果检测到Django模型字段，验证器可以检测字段是否链接到另一个表（外键、通用键等）。

解决每个属性类型后，验证器检查属性顺序。

默认配置检查以下属性顺序

• __new__
• __init__
• __post_init__
• 其他魔术方法
• @property
• @staticmethod
• @classmethod
• 其他方法
• 私有方法

如果顺序被破坏，验证器将报告。

除了方法之外，验证器还会检查其他属性方法：文档字符串、嵌套类、常量、属性等。

此外，验证器还会检查类是否有类级别逻辑，如果有则报告。以下是一个例子

class PhoneForm(forms.Form):
    phone = forms.CharField(17, label='Телефон'.upper())

    # this should happen in __init__!
    phone.widget.attrs.update({'class': 'form-control phone'})

安装

pip install flake8-class-attributes-order

配置

严格模式

还有一个预先配置的顺序，对私有子类型更加严格

• __new__
• __init__
• __post_init__
• 其他魔术方法
• @property
• @staticmethod
• @classmethod
• 其他方法
• 私有 @property
• 私有 @staticmethod
• 私有 @classmethod
• 其他私有方法

要启用严格验证，请设置您的配置文件中的标志

[flake8]
use_class_attributes_order_strict_mode = True

手动顺序配置

可以通过 class_attributes_order 配置设置手动配置顺序。

例如，如果您希望将 class Meta 放在常量和字段之后

[flake8]
class_attributes_order =
    field,
    meta_class,
    nested_class,
    magic_method,
    property_method,
    static_method,
    class_method,
    method,
    private_method

可配置选项

* 如果未提供，将使用其超类型顺序

** 如果未定义，则将在验证期间忽略这些基类型及其所有子类型（除非已定义）。建议至少设置 nested_class、field 和 method

您可以选择配置的详细程度。例如，您可以定义每个受支持的魔术方法的顺序（如__new__、__str__等），或将magic_method设置为允许它们之间的任何顺序，甚至只需使用method

示例

DEBUG = True


class User:
    def fetch_info_from_crm(self):
        pass

    LOGIN_FIELD = 'email'  # wtf? this should be on top of class definition!


class UserNode:
    class Meta:
        model = User

    if DEBUG:  # not great idea at all
        def is_synced_with_crm(self):
            pass

用法

$ flake8 test.py
test.py:5:5: CCE001 User.fetch_info_from_crm should be after User.LOGIN_FIELD
test.py:15:5: CCE002 Class level expression detected model UserNode, line 15

在Python 3.7.x和flake8 3.7.5上进行了测试。

错误代码

贡献

我们非常希望您为我们的项目做出贡献。这很简单

• 创建一个问题，报告您发现的错误或您拥有的建议。等待维护者的批准。
• 创建一个pull请求。确保所有检查都是绿色的。
• 如果有任何审查评论，请修复它们。
• 保持优秀。

以下是一些有用的提示

• 您可以使用make check运行所有检查和测试。请在TravisCI之前这样做。
• 我们使用BestDoctor python styleguide。
• 我们尊重Django CoC。做得好，不要胡说。