🌄 🍽️ 🏢 Private Methoden ohne Unterstriche und Schnittstellen in Python 👎 🎭 😌

Hallo Habr. Vor kurzem war ich verrückt nach Design - Zugriffsmodifikatoren und Schnittstellen, dann habe ich es in die Programmiersprache Python portiert. Ich frage unter kat - ich teile die Ergebnisse und wie es funktioniert. Für Interessierte gibt es am Ende des Artikels einen Link zum Projekt auf Github.

Zugriffsmodifikatoren

Zugriffsmodifikatoren beschränken den Zugriff auf Objekte - auf Methoden ihrer Klasse oder auf untergeordnete Klassen - auf Methoden ihrer übergeordneten Klasse. Durch die Verwendung von Zugriffsmodifikatoren können Daten in der Klasse ausgeblendet werden, sodass niemand außerhalb die Arbeit dieser Klasse stören kann.

Private Methoden sind nur innerhalb der Klasse verfügbar, geschützt (innerhalb) - innerhalb der Klasse und in untergeordneten Klassen.

Wie private und geschützte Methoden in Python implementiert werden

Spoiler - auf der Ebene der Übereinstimmung, dass Erwachsene sie einfach nicht außerhalb des Klassenzimmers anrufen. Vor privaten Methoden müssen Sie einen doppelten Unterstrich schreiben, bevor Sie einen geschützten. Und Sie können trotz ihres "eingeschränkten" Zugriffs weiterhin auf die Methoden zugreifen.

class Car: def _start_engine(self): return "Engine's sound." def run(self): return self._start_engine() if __name__ == '__main__': car = Car() assert "Engine's sound." == car.run() assert "Engine's sound." == car._start_engine()

Folgende Nachteile können festgestellt werden:

Wenn die Methode _start_engine einige Klassenvariablen aktualisiert oder den Status beibehalten und nicht nur eine „dumme Berechnung“ zurückgegeben hat, könnten Sie etwas für die zukünftige Arbeit mit der Klasse beschädigt haben. Sie erlauben sich nicht, etwas im Motor Ihres Autos zu reparieren, weil Sie dann nirgendwo hingehen, oder?
Der Fließpunkt des vorherigen - um sicherzustellen, dass Sie "sicher" (das Aufrufen der Methode schadet der Klasse selbst nicht) eine geschützte Methode verwenden können - müssen Sie den Code untersuchen und Zeit verbringen.
Die Autoren der Bibliotheken hoffen, dass niemand die geschützten und privaten Methoden der Klassen verwendet, die Sie in Ihren Projekten verwenden. Daher können sie die Implementierung in jeder Version ändern (was sich aufgrund der Abwärtskompatibilität nicht auf öffentliche Methoden auswirkt, aber Sie werden darunter leiden).
Der Autor der Klasse, Ihr Kollege, erwartet, dass Sie die technische Verschuldung des Projekts nicht durch eine geschützte oder private Methode außerhalb der von ihm erstellten Klasse erhöhen. Schließlich muss derjenige, der es umgestaltet oder modifiziert (private Klassenmethode), sicherstellen (z. B. durch Tests), dass seine Änderungen Ihren Code nicht beschädigen. Und wenn sie es brechen, muss er Zeit damit verbringen, dieses Problem zu lösen (mit einer Krücke, weil er es gestern braucht).
Vielleicht stellen Sie sicher, dass andere Programmierer keine geschützten oder privaten Methoden für die Codeüberprüfung verwenden und „dafür schlagen“, also verbringen Sie Zeit.

So implementieren Sie geschützte Methoden mithilfe einer Bibliothek

 from accessify import protected class Car: @protected def start_engine(self): return "Engine's sound." def run(self): return self.start_engine() if __name__ == '__main__': car = Car() assert "Engine's sound." == car.run() car.start_engine()

Der Versuch, die Methode start_engine außerhalb der Klasse aufzurufen , führt zu folgendem Fehler (die Methode ist gemäß der Zugriffsrichtlinie nicht verfügbar):

 Traceback (most recent call last): File "examples/access/private.py", line 24, in <module> car.start_engine() File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/accessify/main.py", line 92, in private_wrapper class_name=instance_class.__name__, method_name=method.__name__, accessify.errors.InaccessibleDueToItsProtectionLevelException: Car.start_engine() is inaccessible due to its protection level

Verwenden der Bibliothek:

Sie müssen keine hässlichen (subjektiven) Unterstriche oder doppelten Unterstriche verwenden.
Sie erhalten eine schöne (subjektive) Methode zum Implementieren von Zugriffsmodifikatoren im Code - private und geschützte Dekorateure.
Übertragen Sie die Verantwortung von der Person auf den Dolmetscher.

Wie es funktioniert:

Der private oder geschützte Dekorator - der "höchste" Dekorator - wird vor der Klassenmethode ausgelöst , die als privater oder geschützter Zugriffsmodifikator deklariert wurde.
Mithilfe der integrierten Inspect- Bibliothek ruft der Dekorateur das aktuelle Objekt aus dem Aufrufstapel ab - inspect.currentframe () . Dieses Objekt verfügt über die folgenden Attribute, die für uns nützlich sind: den Namespace (lokale) und den Link zum vorherigen Objekt aus dem Aufrufstapel (das Objekt, das die Methode mit dem Zugriffsmodifikator aufruft).

(Sehr vereinfachte Darstellung)
inspect.currentframe (). f_back - Verwenden Sie dieses Attribut, um zu überprüfen, ob sich das vorherige Objekt aus dem Aufrufstapel im Klassenkörper befindet oder nicht. Schauen Sie sich dazu den Namespace - f_locals an . Wenn der Namespace ein self- Attribut enthält, wird die Methode innerhalb der Klasse aufgerufen, wenn nicht, außerhalb der Klasse. Wenn Sie eine Methode mit einem privaten oder geschützten Zugriffsmodifikator außerhalb der Klasse aufrufen, tritt ein Zugriffsrichtlinienfehler auf.

Schnittstellen

Schnittstellen sind ein Vertrag über die Interaktion mit einer Klasse, die sie implementiert. Die Schnittstelle enthält die Methodensignaturen (den Namen der Funktionen, die Eingabeargumente) und die Klasse, die die Schnittstelle implementiert, implementiert nach den Signaturen die Logik. Zusammenfassend können Sie sicher sein, dass beide Objekte dieser Klassen dieselben Methoden haben, wenn zwei Klassen dieselbe Schnittstelle implementieren.

Beispiel

Wir haben eine Benutzerklasse , die das Speicherobjekt verwendet , um einen neuen Benutzer zu erstellen.

 class User: def __init__(self, storage): self.storage = storage def create(self, name): return storage.create_with_name(name=name)

Sie können den Benutzer mit DatabaseStorage.create_with_name in der Datenbank speichern.

 class DatabaseStorage: def create_with_name(self, name): ...

Sie können den Benutzer mit FileStorage.create_with_name in Dateien speichern .

 class FileStorage: def create_with_name(self, name): ...

Aufgrund der Tatsache, dass die Signaturen der Methoden create_with_name (Name, Argumente) für die Klassen gleich sind, muss sich die Benutzerklasse keine Gedanken darüber machen, für welches Objekt sie ersetzt wurde, wenn beide dieselben Methoden haben. Dies kann erreicht werden, wenn die Klassen FileStorage und DatabaseStorage dieselbe Schnittstelle implementieren ( dh sie sind an den Vertrag gebunden, um eine Methode mit Logik darin zu definieren).

 if __name__ == '__main__': if settings.config.storage = FileStorage: storage = FileStorage() if settings.config.storage = DatabaseStorage: storage = DatabaseStorage() user = User(storage=storage) user.create_with_name(name=...)

So arbeiten Sie mit Schnittstellen mithilfe der Bibliothek

Wenn eine Klasse eine Schnittstelle implementiert, muss die Klasse alle Methoden der Schnittstelle enthalten . Im folgenden Beispiel enthält die HumanInterface-Schnittstelle die eat-Methode, und die Human-Klasse implementiert sie, implementiert jedoch nicht die eat-Methode.

 from accessify import implements class HumanInterface: @staticmethod def eat(food, *args, allergy=None, **kwargs): pass if __name__ == '__main__': @implements(HumanInterface) class Human: pass