CodeQL 文档

类方法的第一个参数未命名为“cls”

ID: py/not-named-cls
Kind: problem
Security severity: 
Severity: recommendation
Precision: high
Tags:
   - maintainability
   - readability
   - convention
Query suites:
   - python-security-and-quality.qls

点击查看 CodeQL 代码库中的查询

类方法、新方法或任何元类方法的第一个参数应称为 cls。这样可以使参数的用途对其他开发人员更清晰。

建议

根据 PEP 8 中的样式指南建议,将第一个参数的名称更改为 cls

示例

在本例中,make() 的第一个参数是 klass,应将其更改为 cls 以便于理解。

class Entry(object):
    @classmethod
    def make(klass):
        return Entry()

参考资料

  • ©GitHub, Inc.
  • 条款
  • 隐私