Best practice für die Verwendung von assert?

Question

1. Gibt es ein Leistungs- oder Code-Wartungsproblem beim Verwenden von assert als Teil des Standardcodes, anstatt es nur für Debugging-Zwecke zu verwenden?

   Ist

   assert x >= 0, 'x ist kleiner als null'

   besser oder schlechter als

   if x < 0:
       raise Exception('x ist kleiner als null')

2. Gibt es auch eine Möglichkeit, eine Geschäftsregel festzulegen wie if x < 0 raise error, die immer überprüft wird, ohne das try/except/finally, so dass, wenn zu irgendeinem Zeitpunkt im Code x kleiner als 0 ist, ein Fehler ausgelöst wird, wie wenn Sie am Anfang einer Funktion assert x < 0 festlegen, überall innerhalb der Funktion, wo x kleiner als 0 wird, wird eine Ausnahme ausgelöst?

Answer 1

Asserts sollten verwendet werden, um Bedingungen zu testen, die niemals passieren sollten. Der Zweck ist es, frühzeitig abzustürzen, falls sich das Programm in einem fehlerhaften Zustand befindet.

Ausnahmen sollten für Fehler verwendet werden, die theoretisch auftreten können, und Sie sollten fast immer Ihre eigenen Ausnahmeklassen erstellen.

---

Zum Beispiel, wenn Sie eine Funktion schreiben, um aus einer Konfigurationsdatei in ein dict zu lesen, sollte falsche Formatierung in der Datei einen ConfigurationSyntaxError auslösen, während Sie assert verwenden können, um sicherzustellen, dass Sie nicht None zurückgeben.

---

In Ihrem Beispiel, wenn x ein Wert ist, der über eine Benutzeroberfläche oder aus einer externen Quelle festgelegt wird, ist eine Ausnahme am besten.

Wenn x nur von Ihrem eigenen Code im selben Programm festgelegt wird, verwenden Sie eine Assertion.

Answer 2

"assert" Anweisungen werden entfernt, wenn die Kompilierung optimiert wird. Also ja, es gibt sowohl Leistungs- als auch funktionale Unterschiede.

Der aktuelle Code-Generator erzeugt keinen Code für eine "assert" Anweisung, wenn eine Optimierung zum Kompilierungszeitpunkt angefordert wird. - Python 2 Docs Python 3 Docs

Wenn Sie assert verwenden, um Anwendungsfunktionalitäten zu implementieren und dann die Bereitstellung für die Produktion optimieren, werden Sie von "Aber-es-funktioniert-im-Dev-Modus" Problemen geplagt.

Siehe PYTHONOPTIMIZE und -O -OO

Answer 3

Um automatisch einen Fehler zu werfen, wenn x während der Funktion kleiner als null wird. Sie können Klassendeskriptoren verwenden. Hier ist ein Beispiel:

class LessThanZeroException(Exception):
    pass

class variable(object):
    def __init__(self, value=0):
        self.__x = value

    def __set__(self, obj, value):
        if value < 0:
            raise LessThanZeroException('x ist kleiner als null')

        self.__x  = value

    def __get__(self, obj, objType):
        return self.__x

class MyClass(object):
    x = variable()

>>> m = MyClass()
>>> m.x = 10
>>> m.x -= 20
Traceback (most recent call last):
  File "", line 1, in 
  File "my.py", line 7, in __set__
    raise LessThanZeroException('x ist kleiner als null')
LessThanZeroException: x ist kleiner als null

Answer 4

Die vier Zwecke von assert

Angenommen, Sie arbeiten an 200.000 Zeilen Code mit vier Kollegen Alice, Bernd, Carl und Daphne. Sie rufen Ihren Code auf, sie rufen Ihren Code auf.

Dann hat assert vier Aufgaben:

1. Informieren Sie Alice, Bernd, Carl und Daphne darüber, was Ihr Code erwartet.
   Angenommen, Sie haben eine Methode, die eine Liste von Tupeln verarbeitet und die Programmlogik kann brechen, wenn diese Tupel nicht unveränderlich sind:

   def meineMethode(listeVonTupeln):
       assert(all(type(tp)==tuple for tp in listeVonTupeln))

   Dies ist verlässlicher als äquivalente Informationen in der Dokumentation und viel einfacher zu pflegen.

2. Informieren Sie den Computer darüber, was Ihr Code erwartet.
   assert erzwingt korrektes Verhalten von den Aufrufern Ihres Codes. Wenn Ihr Code Alices und Bernds Code aufruft und Bernds Code Ihren aufruft, dann ohne das assert, wenn das Programm in Alices Code abstürzt, könnte Bernd annehmen, dass es Alices Schuld war, Alice untersucht und könnte davon ausgehen, dass es Ihre Schuld war, Sie untersuchen und sagen Bernd, dass es tatsächlich seine war. Viel Arbeit geht verloren.
   Mit asserts wird schnell klar, wer einen Aufruf falsch gemacht hat, sie werden schnell erkennen, dass es ihr Fehler war, nicht Ihrer. Alice, Bernd und Sie alle profitieren. Spart immense Mengen an Zeit.

3. Informieren Sie die Leser Ihres Codes (einschließlich Ihnen selbst) darüber, was Ihr Code an einem bestimmten Punkt erreicht hat.
   Angenommen, Sie haben eine Liste von Einträgen und jeder von ihnen kann sauber sein (was gut ist) oder er kann smorsh, trale, gullup oder twinkled sein (was alles nicht akzeptabel ist). Wenn es smorsh ist, muss es unsmorshed sein; wenn es trale ist, muss es baludoed werden; wenn es gullup ist, muss es getrottet werden (und dann möglicherweise auch gepaced); wenn es twinkled ist, muss es noch einmal twinkled werden, außer an Donnerstagen. Sie verstehen: Es ist kompliziert. Aber das Endergebnis ist (oder sollte sein), dass alle Einträge sauber sind. Das Richtige(TM) ist, die Wirkung Ihrer Reinigungsschleife zusammenzufassen als

   assert(all(entry.isClean() for entry in meineListe))

   Diese Aussage erspart jedem eine Kopfschmerzen, der verstehen will, was genau die wunderbare Schleife erreicht. Und die häufigsten dieser Personen werden wahrscheinlich Sie selbst sein.

4. Informieren Sie den Computer darüber, was Ihr Code an einem bestimmten Punkt erreicht hat.
   Sollten Sie jemals vergessen, einen Eintrag zu pacen, der nach dem Trotten benötigt wird, wird das assert Ihren Tag retten und verhindern, dass Ihr Code später Brüche bei der lieben Daphne verursacht.

In meinen Augen sind die beiden Zwecke von Dokumentation (1 und 3) und Schutz (2 und 4) von assert gleichermaßen wertvoll.
Die Information der Menschen kann sogar mehr wert sein als die Information des Computers, weil sie die Fehler verhindern kann, die das assert einfangen soll (im Fall von 1) und viele weitere Fehler in jedem Fall.

Answer 5

Zusätzlich zu den anderen Antworten werfen Assertions selbst Ausnahmen, aber nur AssertionError. Aus utilitaristischer Sicht sind Assertions nicht geeignet, wenn Sie eine feine Kontrolle darüber benötigen, welche Ausnahmen Sie abfangen.