Skip to content
Sarj Code Standards

prefer-self-type-annotation

Prefer Self for self-returning methods and alternate constructors.

SARJ078 Rule source Tests Catalog JSON

Why

Self preserves the concrete subclass type when an inherited method returns its receiver or constructs through its class receiver.

Fix

Import Self from typing (or typing_extensions on Python before 3.11) and use it as the return annotation.

Examples

Before — flagged Fluent method names its enclosing class
app/builder.py
from typing import final




class Builder:
    @final
    def set_name(self, name: str) -> "Builder":
        self.name = name
        return self
After — preferred Fluent method preserves subclass type
app/builder.py
from typing import Self, final




class Builder:
    @final
    def set_name(self, name: str) -> Self:
        self.name = name
        return self