Fragen zu Assert

[Luckie]

Ich bin jetzt in einem Code über Assert gestolpert. In meinem Buch steht dazu (frei übersetzt):

Zitat:

Benutzen sie Assert um Annahmen, die sie im Code treffen zu dokumentieren bzw. zu erwzingen.

Und weiter:

Zitat:

Man benutzt Assert, um bedingungen zu spezifizieren, die wahr sein müssen, damit der Code korrekt arbeitet.

Aber irgendwie kann ich mit der Erklärung nichts anfangen. Ein Beispiel wäre:

Delphi-Quellcode:

Assert(FileExists(Filename));

Aber was bringt das?

[choose]

Hallo Luckie,

Stichworte zu diesem Thema sind: Design by Contract, invariants, how to use assertions, precondition postcondition. Die Programmiersprache Eiffel biete die Zusicherung von Invarianten sogar direkt als Sprachkonstrukt eiffel invariants.

[Niels]

Ich hab nur folgendes gefunden:

EAssertionFailed ist die Exception-Klasse. Sie wird aufgerufen, wenn an die Prozedur Assertion der bool'sche Ausdruck False übergeben wird.

Ich schätz mal dass du dann einfach ne Message bekommst...so ungefähr

Delphi-Quellcode:

Assert(Liste <> nil, 'Keine Einträge vorhanden');

Ob das nun dafür gedacht ist oder net... ka :)

[nailor]

Code:

Use Assert as a debugging tool to test that conditions assumed to be true are never violated. Assert provides an opportunity to intercept an unexpected condition and halt a program rather than allow execution to continue under unanticipated conditions.

Statt das irgenwo ne Exception rausgeworfen wird, sagt der dir, dass genau an der einen Stelle, wo du totsicher von true ausgingst, soch false rauskam. d.h. du solltest davor schaun, was schiefgelaufen ist. ist also wie gesagt zum debuggen gut. Beispiel:

Delphi-Quellcode:

procedure TForm1.FormCreate(Sender: TObject);
var
  a: boolean;
begin
a := false;
assert(a);
IchGehFreiwilligInDieHoelle(not a);
end;

...so hab ich es verstanden...

[sakura]

Hi,

wir haben gerade noch folgenden Link aufgegabelt und der dokumentiert das sehr schön:
http://www.idev.ch/index.php?option=...tid=4&Itemid=3

...:cat:...

[negaH]

Der große Vorteil von Asserts ist das sie per Compilerschalter deaktivierbar sind. D.h. während der Programmierung arbeitet man mit Assert(FileExists(), 'Datei nicht vorhanden'); und wenn alles ordentlich funktioniert wird im Productioncode ohne DebugInfo und Assertitions recompiliert. Der Compiler erzeugt dann keinerleit Code mehr für die Asserts.

Gruß Hagen

[phlux]

Ich hab noch diesen Link gefunden, verweist allerdings auf ein Word Dokument:
http://mitglied.lycos.de/AJSchmidt/D...ehlersuche.doc

Geht auch wieder um die Fehlersuche mit Assert ;)

[Luckie]

Also, ich habe mal etwas rumgespielt und getestet. Betrachten wir mal folgenden Code:

Delphi-Quellcode:

procedure TForm1.Button1Click(Sender: TObject);
begin
  Assert(FileExists('c:\test.txt'), 'Datei gibbet nitt');
end;

Mit der Annahme dass es diese Datei nicht gibt. Dann bricht Assert den Programmablauf ab und gibt eine Fehlermeldung aus. Das könnte man jetzt auch mit if's und try-excepts lösen. Aber der Unterschied ist der:

Zitat:

---------------------------
Project1
---------------------------
Datei gibbet nitt (D:\Programmierung\Delphi\Programme\Unit1.pas, Zeile 29)
---------------------------
OK
---------------------------

Diese Meldung erscheint, wenn man die Exe aus dem Explorer startet. Das bemerkenswerte ist, dass auch die Unit und die Zeile in der der Fehler auftrat bzw. die Annahme nicht korrekt war ausgegeben wird. Für den Endbenutzer eine nicht sehr Hilfreiche Fehlermeldung, dafür aber für den Entwickler um so hilfreicher.

Fazit: In Testversionen kann ein Assert für den Entwickler hilfreicher sein, als eine normale Fehlermeldung genriert durch eine Exception oder eine Messagebox in einem else-Zweig einer if-Bedingung.

[Luckie]

Zitat:

Zitat von negaH

Der große Vorteil von Asserts ist das sie per Compilerschalter deaktivierbar sind. D.h. während der Programmierung arbeitet man mit Assert(FileExists(), 'Datei nicht vorhanden'); und wenn alles ordentlich funktioniert wird im Productioncode ohne DebugInfo und Assertitions recompiliert. Der Compiler erzeugt dann keinerleit Code mehr für die Asserts.

Ja, genau da sahbe ich auch gerade rausgefunden. Werde ich in den nächsten Projekten mal versuchen zu nutzen. :wink:

[nailor]

Zitat:

Zitat von Luckie

Diese Meldung erscheint, wenn man die Exe aus dem Explorer startet. Das bemerkenswerte ist, dass auch die Unit und die Zeile in der der Fehler auftrat bzw. die Annahme nicht korrekt war ausgegeben wird.

Das ist mir noch garnicht aufgefallen. Das ist in der Tat sehr hilfreich!

[flomei]

:gruebel: Das heisst, dass bei einer "fertigen", also kompilierten, EXE diese Fehlermeldungen auftauchen und anzeigen wo im Quelltext dieser Fehler aufgetreten ist? :roll:
Was kann mir das bringen???

MfG Florian :hi:

[choose]

Der Zweck von Assertions liegt in der Zusicherung von Zuständen. Also zB so triviale Dinge wie

Delphi-Quellcode:

function Uppercase(const AString: string): string;
begin
  //do some logic here

  Assert(Length(Result)=Length(AString), 'Length of Result differs from input');
  Assert(IsEveryCharACapital(Result), 'Not every char of Result is a capital');
end;

(Postconditions) bzw beim Testen von PreConditions

Delphi-Quellcode:

procedure FillRect(const ACanvas: TCanvas; const APoint: TPoint;
  const AnotherPoint: TPoint);
begin
  Assert(Assigned(ACanvas), 'Canvas cannot be nil');
  Assert((APoint.X<AnotherPoint.X) and (APoint.Y<=AnotherPoint.Y),
    'First Point must be "smaller" than second');

  //do some logic here
end;

Interessant ist dieses Konstrukt zur "Dokumentation" und Zusicherung von Zwischenständen, damit Dritte schneller erkennen und sicherstellen können, dass die Fehlerquelle nicht in fremdem Code zu suchen ist, weil sonst die Assertions "angeschlagen" hätten:

Delphi-Quellcode:

// doing foo now
SomeComplicatedLogig(WithAComplexFormular,
  AndSomeMoreParams);
Assert(EnsureFooWasDone, 'Foo was not done');

// doing bar now
AndAgainSome;
VeryObfuscatedCode;
AndEvenMoreCodeThatIsNotObvious;
Assert(EnsureBarWasDone, 'Bar was not done');

Dinge, die die Programmlogik beeinflussen sollten nicht als Assertions formuliert werden und auch im zweiten skizzierten Fall ist es fragwürdig, ob ACanvas nicht lieber mit einer Exception "gesichert" werden sollte... Aber hier gibt es unterschiedliche Meinungen...

[flomei]

D.h. Assert ist nur so was ähnliches wie try ... except? :roll:

MfG Florian :hi:

[choose]

Zitat:

Zitat von flomei

Das heisst, dass [...] diese Fehlermeldungen [...] anzeigen wo im Quelltext dieser Fehler aufgetreten ist? :roll: Was kann mir das bringen???

Du hast dann die Möglichkeit, den exakten Ursprung des Fehlers in den zu zugehörigen Sourcen der Version beim Kunden aus dem VersionKontrollSystem auszuchecken und zu überprüfen, was genau nicht geklappt hat.
In der Tat ist ein Stack durch Exceptionwrapping bei ausreichend fein granulierten Klassen idR hilfreicher...

[flomei]

:roll: Also für Fehlerkorrektur "vor Ort" !?!
Ich brauch sowas zum Glück noch nicht... :)

MfG Florian :hi:

[choose]

Zitat:

Zitat von flomei

D.h. Assert ist nur so was ähnliches wie try ... except?

Assertions sind in Delphi mithilfe von Exceptions implementiert, ja.
Beide Konstrukte verfolgen aber unterschiedliche Ansätze: Während bei Assertions (siehe zweites Posting) Invarianten und Vor-/Nachbedinungen nach dem "Vetragskonzept" zugesichert werden und anderfalls ein Abbruch (hier: in Form einer Exception) initiiert wird,

Code:

//hier gilt mit Sicherheit A
ArbeitenUnterDieserPrämisse;
//hier gilt nun mit Sicherheit B und A

sollen Exceptions den Entwickler auf denkbare Fehlersituationen aufmerksam machen und die Behandlung eben dieser unvermeidbaren Situationen von der tatsächlichen Logik entkoppeln, um verwirrende Konstrukte zu vermeiden und klar zu kommunizieren was passieren könnte, wenn man eine Methode verwendet:

Code:

EineMethode; //könnte Fehler A verursachen
EineAndereMethode; //könnte Fehler A oder B verursachen

Code:

//in diesem Abschnitt:
  VerwendenVon EineMethode;
  Verwendenvon EineAndereMethode;
//könnten Fehler A oder B auftreten!

[phlux]

Wie lauten die Compilerschalter zum Deaktivieren denn`?`?

[Luckie]

Rat mal wo du das findest und unter welchen Stichwort.

[nailor]

Zitat:

Zitat von Luckie

Rat mal wo du das findest und unter welchen Stichwort.

^^Das ist Luckies Art, Leute weiterzubilden. Hätte auch einfach "in der OH" schreiben können und diesen:

Code:

$ASSERTIONS ON/OFF   (long form)
$C +/-   (short form)

Ausschnitt posten können...

[Luckie]

Das war ein virtueller Schlag auf den Hinterkopf und du weißt doch, dass selbige das Denkvermögen erhöhen. :zwinker:

[nailor]

Schon, aber nicht alle Leute wollen selber denken! :mrgreen:

[Luckie]

Zitat:

Zitat von Nailor

Schon, aber nicht alle Leute wollen selber denken! :mrgreen:

Und genasu diese stehen auf meiner persönlichen Abschussliste. :evil: