Class methods should use self as first argument

Docs > Datadog Security > Code Security > Static Code Analysis (SAST) > SAST Rules > Class methods should use self as first argument

Metadata

ID: python-best-practices/class-methods-use-self

Language: Python

Severity: Error

Category: Best Practices

Description

In a class method (that is not a class method nor a static method), the first argument must be self by convention.

Learn More

Non-Compliant Code Examples

class Foo:
    def bar(bar):  # use def bar(self) instead
        pass

Compliant Code Examples

class Foo:
    @staticmethod
    def static_method(bar):
        pass

    @classmethod
    def class_method(bar):
        pass

    def __call__(cls, *args, **kwargs):
        pass

class IFoo(Interface): # zope interfaces won't get flagged
    def method(i):
        pass

How to use this rule

1
2
rulesets:
  - python-best-practices     # Rules to enforce Python best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Security scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Security documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products