Syntax

Final kann in einer von mehreren Formen verwendet werden

• Mit einem expliziten Typ unter Verwendung der Syntax Final[<Typ>]. Beispiel

  ID: Final[float] = 1
  

• Ohne Typannotation. Beispiel

  ID: Final = 1
  

  Der Typüberprüfer sollte seine üblichen Typinferenzmechanismen anwenden, um den Typ von ID zu bestimmen (hier wahrscheinlich int). Beachten Sie, dass dies im Gegensatz zu generischen Klassen *nicht* dasselbe ist wie Final[Any].

• In Klassenkörpern und Stub-Dateien können Sie die rechte Seite weglassen und einfach ID: Final[float] schreiben. Wenn die rechte Seite weggelassen wird, muss ein explizites Typargument für Final vorhanden sein.
• Schließlich, wie self.id: Final = 1 (optional auch mit einem Typ in eckigen Klammern). Dies ist *nur* in __init__ Methoden erlaubt, damit das finale Instanzattribut nur einmal bei der Erstellung einer Instanz zugewiesen wird.

Semantik und Beispiele

Die beiden Hauptregeln für die Definition eines finalen Namens sind

• Es kann *höchstens eine* finale Deklaration pro Modul oder Klasse für ein gegebenes Attribut geben. Es kann keine separaten Konstanten auf Klassen- und Instanzebene mit demselben Namen geben.
• Es muss *genau eine* Zuweisung an einen finalen Namen geben.

Das bedeutet, ein Typüberprüfer sollte weitere Zuweisungen an finale Namen in typüberprüftem Code verhindern

from typing import Final

RATE: Final = 3000

class Base:
    DEFAULT_ID: Final = 0

RATE = 300  # Error: can't assign to final attribute
Base.DEFAULT_ID = 1  # Error: can't override a final attribute

Beachten Sie, dass ein Typüberprüfer Final-Deklarationen nicht innerhalb von Schleifen zulassen muss, da die Laufzeit in nachfolgenden Iterationen mehrere Zuweisungen an dieselbe Variable sehen würde.

Zusätzlich sollte ein Typüberprüfer verhindern, dass finale Attribute in einer Unterklasse überschrieben werden

from typing import Final

class Window:
    BORDER_WIDTH: Final = 2.5
    ...

class ListView(Window):
    BORDER_WIDTH = 3  # Error: can't override a final attribute

Ein finales Attribut, das in einem Klassenkörper ohne Initialisierer deklariert wurde, muss in der __init__ Methode initialisiert werden (außer in Stub-Dateien)

class ImmutablePoint:
    x: Final[int]
    y: Final[int]  # Error: final attribute without an initializer

    def __init__(self) -> None:
        self.x = 1  # Good

Typüberprüfer sollten ein finales Attribut, das in einem Klassenkörper initialisiert wird, als Klassenvariable inferieren. Variablen sollten nicht sowohl mit ClassVar als auch mit Final annotiert werden.

Final kann nur als äußerster Typ bei Zuweisungen oder Variablenannotationen verwendet werden. Die Verwendung an einer anderen Stelle ist ein Fehler. Insbesondere kann Final nicht in Annotationen für Funktionsargumente verwendet werden

x: List[Final[int]] = []  # Error!

def fun(x: Final[List[int]]) ->  None:  # Error!
    ...

Beachten Sie, dass die Deklaration eines Namens als final nur garantiert, dass der Name nicht an einen anderen Wert gebunden wird, aber den Wert nicht unveränderlich macht. Unveränderliche ABCs und Container können in Kombination mit Final verwendet werden, um die Änderung solcher Werte zu verhindern

x: Final = ['a', 'b']
x.append('c')  # OK

y: Final[Sequence[str]] = ['a', 'b']
y.append('x')  # Error: "Sequence[str]" has no attribute "append"
z: Final = ('a', 'b')  # Also works

Typüberprüfer sollten Verwendungen eines finalen Namens, der mit einem Literal initialisiert wurde, so behandeln, als ob er durch das Literal ersetzt worden wäre. Zum Beispiel sollte Folgendes erlaubt sein

from typing import NamedTuple, Final

X: Final = "x"
Y: Final = "y"
N = NamedTuple("N", [(X, int), (Y, int)])