Argumente/Parameter wo prüfen ? (solved) (Allgemeines zu Perl)

[thread]19283[/thread]

Argumente/Parameter wo prüfen ? [solved]

Tags: perl5 OOP modern perl Similar Threads

Readers: 15

Articles: hide open all | hide show old branches

+20 replies
der_thomas

2014-09-15 18:44

User since
2013-09-07
158 articles
BenutzerIn

Hallo,

ich bin gerade dabei ein Modul neu zu schreiben, diesmal objektorientiert.
Tabellentool

Dazu hätte ich grundsätzliche Designfrage:
Wo sollen übergebene Parameter geprüft werden, in den Objekt- oder Klassenmethoden oder beim Aufrufer ?

als Beispiel:

$objekt->machwas(5)

Die Methode 'machwas' kann nur funktionieren wenn ein Wert zw 0 und 9 übergeben wird.

$objekt->machwas(foo) oder machwas(-1) würden also fehlschlagen und ungeprüft zu einem Programmabbruch oder zu einem fehlerhaft arbeitenden Methode führen.

Bisher handhabte ich das so dass die Verantwortung der Überprüfung der zu übergebenen Argumente, wenn also überhaupt eine Prüfung notwendig war, beim Aufrufer lag.

Ist das so üblich, oder gibt es da ein Design Pattern ?

thomas
Last edited: 2014-09-15 20:03:20 +0200 (CEST)
- GwenDragon
  
  2014-09-15 19:19
  User since
  2005-01-17
  14835 articles
  Admin1
  Code (perl): (dl )
  
  1 2 3 4 5 6 7 8 9 10
  
  sub machwas { my $self = shift; my $parm = shift; die 'Parameter of ' . __PACKAGE__ . '->machwas() must be between 0..9' if $parm<0 or $parm >9; #d machdies und das }
  
  die Drachin Gwen
  
  Meine Perl-Artikel · perldev – verschiedene Perl-Versionen unter Windows starten
- +12 replies
- rosti
  
  2014-09-15 19:36
  User since
  2011-03-19
  3566 articles
  BenutzerIn
  Quote
  Wo sollen übergebene Parameter geprüft werden, in den Klassenmethoden oder beim Aufrufer ?
  
  Mach Dir ersteinmal klar, was eine Klassenmethode ist: Sie wird mit dem Namen der Klasse aufgerufen, z.B.:
  
  Code (perl): (dl )
  
  1 2 3
  
  use Class; Class->method(); Class->new(); # das kennen wir alle
  
  Etwas ausführlicher:
  
  Code (perl): (dl )
  
  1 2 3 4 5 6 7
  
  use Class; # Klassenmethode my $instance = Class->new(); # Erstelle Objekt, eine Instanz der Klasse # Mit der Instanz eine Methode aufrufen $instance->foo();
  
  Argumente prüfen und Fehlerbehandlung, Unterscheide zwischen:
  1) Fehler die ein Programmierer in der Anwendung der Class-API macht
  2) Fehler die ein Benutzer bei einer Eingabe ins Programm macht
  
  Wenn Du eigene Module schreibst, hast Du die Möglichkeit, beide Fälle im Modul abzuhandeln. Hier ist ein Beispiel von mir: http://rolfrost.de/sca.pm
  Die unterschiedliche Handhabe:
  Fehler zu (1): Es wird eine Exception mit croak() geworfen, der Programmierer bekommt einen Backtrace und sieht, an welcher Stelle er im Code die API nicht richtig anwendet
  Fehler zu (2): Es wird eine Exception geworfen mit die(), der Backtrace wird unterdrückt und die Meldung kann bis zum Endbenutzer durchgereicht werden.
  
  Es liegt an Deinem Gesamtkonzept, inwieweit Du mit dem Exception-Model umgehen kannst, d.h., der Meldetexte einer Exception kann auch über eine entsprechende Methode bis zum Endbenutzer durchgereicht werden. Auf diese Art und Weise lässt sich einiges an Code vereinfachen.
  
  Nun zu Deiner Methode, möglich wäre:
  
  Code (perl): (dl )
  
  $object->machwas(5);
  
  1) Dein Programm stellt sicher, dass nur einstellige Zahlen reinkommen
  2) machwas(99) wirft eine Exception, wenn die Zahl nicht zwischen 0..9 liegt
  
  Z.B. in einer Webanwendung:
  
  Code (perl): (dl )
  
  1 2
  
  $object->machwas(5) or return $gui->Fehlerseite( title => 'Eingabefehler', descr => 'Die Zahl muss zwischen 0..9 liegen' );
  
  Und: Sei froh, dass Du in Perl (noch) keinen typecast machen musst, so wie in JavaScript ( http://rolfrost.de/scaligerclass.html )
  http://blog.rolfrost.de/
  
  The art of steam.
  - +11 replies
  - der_thomas
    
    2014-09-15 20:00
    
    User since
    2013-09-07
    158 articles
    BenutzerIn
    
    Stimmt natürlich, ich meinte natürlich Objektmethoden - ändert aber an der grundsätzlichen Fragestellung nichts.
    Um aber andere nicht zu verwirren ändere ich es oben ab.
    Danke für den Hinweis.
    Last edited: 2014-09-15 20:02:21 +0200 (CEST)
    - +10 replies
    - rosti
      
      2014-09-15 20:45
      
      User since
      2011-03-19
      3566 articles
      BenutzerIn
      
      Ok ;)
      
      Dann kommen wir jetzt zum Thema Getter und Setter. Also, wenn Dein
      
      Code (perl): (dl )
      
      $obj->foo(5);
      
      ein Setter ist, der die Instanz selbst verändert, dann sollte die Prüfung, ob Argumente passen, auf jeden Fall in der Methode selbst erfolgen. Denn in diesem Fall könnten fehlerhafte Argumente die Instanz (Objekt) unbrauchbar machen, so dass eine Fortführung des Programms nicht mehr sinnvoll ist.
      http://blog.rolfrost.de/
      
      The art of steam.
      - +9 replies
      - der_thomas
        
        2014-09-16 21:47
        
        User since
        2013-09-07
        158 articles
        BenutzerIn
        
        Gut, es scheint offenbar üblich zu sein diese Prüfungen in der Methode vorzunehmen. Dass derjenige der die Methode nutzt (den Nutzen hat ;) ) auch dafür verantwortlich ist dass der Methode vernünftige Argumente zukommen, erscheint mir zwar genauso logisch, aber gut.... vermutlich tut man sich, wenn man so eine Klasse später wieder nutzt, leichter wenn man auf falsche Argumente hingewiesen wird (Und man muss diese Prüfungen nicht bei jedem möglichen Aufrufer wieder aufs neue machen)
        
        Nun muss ich mir nur noch eine konsistente Art der Fehlerbehandlung überlegen.
        (Mit 'Konsistent meine ich, alle Methoden dieser Klasse sollten das gleich handhaben)
        'die' will ich wenn irgend möglich vermeiden.
        Vermutlich werde ich es so machen dass im Falle eines unbrauchbaren Arguments per 'return' zurückgesprungen wird und eine Fehlermeldung entweder in
        - einer Objektvariable '$self->{-error}', #langsam
        - oder direkt als Rückgabewert mit return, #muss immer ausgwertet werden, wenn ein Rückgabewert erwartet wird
        - oder mit einer wirklich globalen Variable #unsauber
        ...zum Aufrufer kommt.
        Wie und ob dass dann vom Aufrufer ausgewertet wird will ich jetzt nicht festlegen um die Klasse so flexibel wie möglich zu halten.
        ....aber das ist nun ein eigenes Thema...
        
        Ich danke euch für eure Gedanken zum Thema, die Frage des Threads ist gelöst.
        
        thomas
        
        +8 replies
        
        rosti
        
        2014-09-16 22:17
        
        User since
        2011-03-19
        3566 articles
        BenutzerIn
        
        Noch was zur Fehlerbehandlung, viele CPAN- u.a. Perl-Module verwenden Carp. So wird bereits bei der Erstellung einer Instanz eine Exception geworfen, wenn die API nicht richtig angewandt wird:
        
        Code (perl): (dl )
        
        1 2
        
        my $obj = Class->new( -foo => 123 ) or die $@; my $obj = Class->new( -foo => 123 ) or print $@;
        
        Was steckt dahinter? Vorab, ob Du in Deiner main (Anwendung) die() verwendest oder nicht, ist eine andere Sache. In beiden Fällen wird die Instanz gar nicht erst erstellt und in $@ steht drin, warum das so ist. In der Class->new() selbst wird die Exception mit croak("Falsches Argument") geworfen, damit der Anwender der Klasse (Anwender der API) einen Backtrace bekommt. Und der zeigt nicht auf die Zeile im Modul, sondern auf die Zeile in der Anwendung. Mehr Infos als Carp::croak liefert Carp::confess und die beiden anderen Methoden erzeugen Warnungen mit Backtrace.
        
        Und ja, $@ ist eine globale Variable. Abgefragt wie obenstehend ist das jedoch atomar, in $@ kann nichts anderes stehen, als das, was bei der Instanzerstellung schiefgegangen ist.
        
        Das Exception-Model kannst auch Du für gewöhnlichen Methodenaufrufe verwenden:
        
        Code (perl): (dl )
        
        $obj->foo('29.2.1901') or die $@;
        
        Das vereinfacht die Fehlerbehandlung und braucht keine Sondervereinbarungen für Rückgabewerte. Das Modul Error schließlich ermöglicht try{}catch{} wie das in anderen PLs üblich ist.
        http://blog.rolfrost.de/
        
        The art of steam.
        
        +7 replies
        
        pq
        
        2014-09-17 12:27
        
        User since
        2003-08-04
        12209 articles
        Admin1
        
        irgendwie fehlt mir da ein eval. wenn du es nicht im aufruf schreibst, müsste es in der methode gemacht werden. finde ich persönlich dann wieder nicht so toll, da der aufrufer sich selbst um die überprüfung des rückgabewertes kümmern muss. stört mich auch bei open(), chdir() usw.
        Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- Damian Conway in "Perl Best Practices"
        lesen: Wie frage ich & perlintro brian's Leitfaden für jedes Perl-Problem
        
        +6 replies
        
        rosti
        
        2014-09-17 12:48
        
        User since
        2011-03-19
        3566 articles
        BenutzerIn
        
        Code (perl): (dl )
        
        1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
        
        #!/usr/bin/perl use strict; use warnings; use Carp qw(confess); # Einfache Instanz der main my $m = bless{}; # Fehlerbehandlung in der main: # Script sterben lassen $m->ziffer() or die $@; # Ziffer von 0..9 # Fehlerbehandlung in der Methode: # Exception werfen sub ziffer{ my $self = shift; my $z = shift; return eval{ confess "Kein Argument übergeben" if ! defined $z; confess "Keine Ziffer übergeben" if $z !~ /^\d$/; # weitere Anweisungen # dürfen Exceptions werfen, wenn irgendwas nicht passt # die letzte Anweisung ist ein wahrer Wert (returned) 1; }; }
        
        brief: Carp::croak() und Carp::confess() werfen Excptions, confess() und cluck() muss expliziet angegeben werden, damit es importiert wird; confess() ist verbose zu croak();
        Carp::carp() und Carp::cluck() erzeugen Warnungen, cluck() ist verbose zu carp().
        
        Anstatt eine Kontrollstruktur if/else aufzusetzen, wird einfach eine Ex. geworfen, wenn irgendwas nicht passt. Das Werfen der Ex erfolgt in einem eval-Block, die Meldung wird in $@ bekanntgegeben.
        
        $@ wird zur Fehlerbehandlung in der main herangezogen, Beispiel s.o.
        Die Prüfung ob gültiges Argument beim Aufruf der Methode erfolgt in der Methode. Die Fehlerbehandlung in der main nimmt einfach nur den Text, der in $@ zu finden ist, wenn die Methode keinen wahren Wert zurückliefert.
        
        Die Methode kann auch beliebig andere Werte zurückliefern und gilt als erfolgreich ausgeführt, solange die letzte Zeile im eval-Block einen Ausdruck hat, der wahr ergibt.
        Last edited: 2014-09-17 13:16:47 +0200 (CEST)
        http://blog.rolfrost.de/
        
        The art of steam.
        
        pq
        
        2014-09-17 13:05
        
        User since
        2003-08-04
        12209 articles
        Admin1
        
        war mir schon klar. ändert nichts an meiner aussage.
        
        auch dein edit nicht.
        Last edited: 2014-09-17 13:26:53 +0200 (CEST)
        Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- Damian Conway in "Perl Best Practices"
        lesen: Wie frage ich & perlintro brian's Leitfaden für jedes Perl-Problem
        
        +4 replies
        
        der_thomas
        
        2014-09-18 21:28
        
        User since
        2013-09-07
        158 articles
        BenutzerIn
        
        Danke rosti für die Erklärung und den Code, hab das nun mal eingebaut - funktioniert so wie gewollt, Super !
        
        Und wenn ich es richtig deute, also das was meine um Deinen Code ergänzte methode betrifft, passiert einfach nichts wenn ich zwar z.b.
        
        Code (perl): (dl )
        
        1 2 3
        
        return eval{ croak "Kein Argument übergeben" if ! defined $arg{column}; ....
        
        verwende, das aber in bestimmten Fällen beim Aufrufer nicht mittels
        
        Code (perl): (dl )
        
        $objekt->del_column(column => $spalte) or warn $@;
        
        sondern einfach mit:
        
        Code (perl): (dl )
        
        $objekt->del_column(column => $spalte);
        
        aufrufe.
        D.h. der Code der Methode wird nicht weiter ausgeführt, es passiert einfach nichts...Richtig so ?
        
        Ob das Sinn macht ist eine andere Frage, mir gehts erstmal nur ums Verständnis, was genau da also abläuft.
        
        thomas
        
        +3 replies
        
        rosti
        
        2014-09-18 22:07
        
        User since
        2011-03-19
        3566 articles
        BenutzerIn
        
        Quote
        D.h. der Code der Methode wird nicht weiter ausgeführt, es passiert einfach nichts...Richtig so ?
        
        Jaha, Du hast es ;)
        Also: Ab der Stelle, wo eine Exception fällt (croak, die, confess) hält das Script an. Passiert das in einem eval-Block, wird die Exception aufgefangen, Meldung (Begründung) in $@ und Du kannst außerhalb vom eval-Block entscheiden, wie es weitergehen könnte.
        
        Noch ein schönes Beispiel für die Objekterstellung:
        
        Code (perl): (dl )
        
        1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
        
        # Konstruktor einer Klasse sub new{ my $class = shift; # Name der Klasse # Argumente in @_ z.B. als Hash # hier können wir default-Werte setzen # da ist auch gleich zu sehen, was fakt ist my %cfg = ( foo => undef, bar => '', @_); # @_ überschreibt die vorbelegten Werte # Pflichtfelder setzen wir auf undef return eval{ # Argumente prüfen # wenn was nicht passt, Exception schmeißen # code hierzu... my $self = bless{ # Attribute foo => $cfg{foo} or croak "foo wurde nicht übergeben", }, $class; # letzte Zeile im Block ist der returnvalü $self; # das wird zurückgegeben, wenn alles geklappt hat }; } # und draußen... my $obj = Class->new(%argumente) || do{ # hier machen wir das, was notwendig ist, wenn # das Objekt nicht erstellt werden konnte # Reason in $@ };
        
        Last edited: 2014-09-18 22:11:15 +0200 (CEST)
        http://blog.rolfrost.de/
        
        The art of steam.
        
        +2 replies
        
        der_thomas
        
        2014-09-19 21:39
        
        User since
        2013-09-07
        158 articles
        BenutzerIn
        
        Super, dann mache ich das so
        
        Was mir bisher noch nicht so gefallen hat, nämlich die Ausgabe der Fehlermeldung in der Konsole (kann ja sein dass man nur mit einer GUI ohne Konsole arbeitet) ist nun auch gelöst:
        
        Code (perl): (dl )
        
        1 2 3 4 5 6 7
        
        $objekt->del_column(column => $spalte) or errormessage($@); ... ... sub errormessage { print "************Error************\n"; print @_; }
        
        Je nach Frontend kann ich das statt mit print auch in einem Textfeld einer GUI ausgeben, oder in einer Datei speichern.
        
        thomas
        
        rosti
        
        2014-09-19 21:52
        
        User since
        2011-03-19
        3566 articles
        BenutzerIn
        
        Genau ;)
        
        Und wenn
        
        Code (perl): (dl )
        
        $objekt->del_column(column => $spalte) or errormessage($@);
        
        in einer sub stattfindet und Du willst, dass dass die nicht weitermacht, geht auch
        
        Code (perl): (dl )
        
        $objekt->del_column(column => $spalte) or return errormessage($@);
        
        kurz und schmerzlos ;)
        
        Oder ganz raus mit exit($errno); # $errno 0..255 falls das OS mitreden soll.
        http://blog.rolfrost.de/
        
        The art of steam.
- +6 replies
- lichtkind
  
  2014-09-15 19:38
  
  User since
  2004-03-22
  5701 articles
  ModeratorIn + EditorIn
  
  wenns mal nicht so schnell sein muss , benutz Moose. Definier einen subtyp der nur zahlenzwischen 0 und 9 erlaubt (sybtyping of Int) und benutz in den Signaturen diesen typ. siehe:
  
  https://metacpan.org/pod/Moose::Manual::Types#SUBT...
  Tutorien in der Wiki, mein zeug:
  kephra, baumhaus, garten, gezwitscher
  
  Es beginnt immer mit einer Entscheidung.
  - +5 replies
  - der_thomas
    
    2014-09-16 21:51
    
    User since
    2013-09-07
    158 articles
    BenutzerIn
    
    Ja, in dem Fall wäre das eine Alternative, aber ich habe mich bisher mit Moose kaum beschäftigt und gefühlt erscheint es mir für das bißchen was ich da mache zu groß - so in der Art Vorschlaghammer und Mücke ;)
    Aber das mag auch ein Vorurteil sein ?
    
    thomas
    - +4 replies
    - lichtkind
      
      2014-09-17 20:32
      
      User since
      2004-03-22
      5701 articles
      ModeratorIn + EditorIn
      
      naja man muss ja nicht alles benutzen und es ist nur bei startup langsamer und will natürlich sein 2-5Meg Ram oder es gibt auch eine Moo-Erweiterung für:
      https://metacpan.org/pod/MooX::Types::MooseLike
      Last edited: 2014-09-18 21:57:58 +0200 (CEST)
      Tutorien in der Wiki, mein zeug:
      kephra, baumhaus, garten, gezwitscher
      
      Es beginnt immer mit einer Entscheidung.
      - +3 replies
      - der_thomas
        
        2014-09-18 21:33
        
        User since
        2013-09-07
        158 articles
        BenutzerIn
        
        Ich muss mich mit Moose einfach mal in Ruhe beschäftigen, dass es im laufenden Betrieb nicht langsamer ist wusste ich z.B. (auch) noch nicht.
        
        thomas
        
        +2 replies
        
        lichtkind
        
        2014-09-18 22:00
        
        User since
        2004-03-22
        5701 articles
        ModeratorIn + EditorIn
        
        mit MooseX sind es 10 MB plus aber ansonst sind sich leute einig das startup penalty weit höher ist als im laufenden betrieb. natürrlich kostet der parametercheck auch was aber das teure an Moose ist der MOP. wenn der einmal geladen ist wird schon ziemlich brutal wegoptimeirt wenn was nicht gebraucht wird. deswegen wollen wir ja eine mop im core , damit das wesentlich schneller (in C) läuft.
        Tutorien in der Wiki, mein zeug:
        kephra, baumhaus, garten, gezwitscher
        
        Es beginnt immer mit einer Entscheidung.
        
        der_thomas
        
        2014-09-19 21:43
        
        User since
        2013-09-07
        158 articles
        BenutzerIn
        
        Dazu habe ich eine vielleicht etwas naive Frage:
        
        Moose gibts ja schon eine Weile und ist produktiv im Einsatz, warum will man nicht gleich Moose in den Core übernehmen ?
        MOP ist ja, wenn ich es richtig verstanden habe, nur das Grundkonstrukt auf dem Moose dann aufbaut.
        
        thomas

View all threads created 2014-09-15 18:44.