Wie Sie wissen, die Funktion Rückgabe-Typ und die argument-Typen?

Während ich bin mir bewusst, das duck-typing Konzept von Python, habe ich manchmal etwas Mühe mit der Art der Argumente der Funktionen oder der Typ des Rückgabewerts der Funktion.

Nun, wenn ich schrieb, die Funktion selber, ich kenne den Typen. Aber was, wenn jemand nutzen will und rufe meine Funktionen an, wie ist er/Sie erwartet, dass Sie die Typen?
Ich gewöhnlich geben Sie Informationen in die Funktion den docstring (wie: "...the id argument should be an integer..." und "... the function will return a (string, [integer]) tuple.")

Aber sucht die Informationen in den docstring (und man es dort als Programmierer) wirklich, wie es gemacht werden soll?

Edit: Während die meisten Antworten scheinen direkt in Richtung "ja, Dokument!" Ich glaube, das ist nicht immer sehr einfach für den "komplexen" Typen.
Zum Beispiel: wie beschreiben prägnant in einem docstring, der eine Funktion liefert eine Liste von Tupeln, wobei jedes Tupel der form (node_id, Knotenname, uptime_minutes) und die Elemente sind jeweils in einen string -, string-und integer?

Der docstring PEP, die Dokumentation gibt keine Richtlinien auf.

Ich denke, das Gegenargument wird sein, dass in diesem Fall Klassen verwendet werden sollten, aber ich finde python sehr flexibel, da es erlaubt die übergabe um diese Dinge mit Listen und Tupeln, d.h. ohne Klassen.

  • Die kurze Antwort ist "ja". Die lange Antwort ist "ja, natürlich". Ich weiß nicht, ob Sie sich angeschaut haben viel Python-code, aber man sollte wohl update die Frage, um anzugeben, welche Pakete Sie tatsächlich nutzen, so können wir Sie direkt zu code können Sie Lesen, um zu sehen, wie Dinge getan werden in der library-code, den Sie eigentlich gerade benutzen.
  • Ich bin derzeit am kämpfen mit dem mechanize-Paket, aber ich denke, es ist nur (leider) schlecht dokumentiert.
  • Python ist cool, da kann man eine Menge Quellcode schreiben schnell und Sie müssen nicht sorgen zu machen über ganz Banale Dinge wie return-Typen, argument-Typen, Laufzeit, Leistung, Menschen, verwenden und pflegen Sie Ihre spaghetti-code für die nächsten 10 Jahre, etc.. Seufz.
InformationsquelleAutor Rabarberski | 2011-03-17
  1. 66

    Gut, die Dinge haben sich ein wenig etwas geändert seit 2011! Jetzt gibt es geben Sie Hinweise in Python 3.5 die Sie verwenden können, zu kommentieren, Argumente und return-Typ der Funktion. Zum Beispiel diese:

    def greeting(name):
  return 'Hello, {}'.format(name)

    kann nun geschrieben werden als dieser:

    def greeting(name: str) -> str:
  return 'Hello, {}'.format(name)

    Wie können Sie nun sehen, Typen, die irgendeine Art von optionalen statische Typ-Prüfung, die Ihnen und Ihrem Typ-checker untersuchen Ihren code.

    weitere Erklärung, die ich vorschlagen, einen Blick auf die blog-post-Typ-Hinweise in PyCharm blog.

    • Beachten Sie, dass eine Typbestimmung syntax wurde auch vorgeschlagen, für Python 2.7 hier in der gleichen PEP-0484. Und es funktioniert in PyCharm, zumindest aus v 2017.3 .
    • Wenn die Begrüßung-Funktion mit genau derselben definition gibt ein Objekt vom Typ int kein Fehler erhöhen. Also, was ist die Verwendung von diese Art der Art der überprüfung, wenn Sie erwähnen den Rückgabetyp explizit, aber nicht gehorchen, die Herrschaft und zurück, andere Art von Objekt ?
    InformationsquelleAutor Rsh
  2. 16

    Dies ist, wie dynamische Sprachen arbeiten. Es ist nicht immer eine gute Sache, obwohl, vor allem, wenn die Dokumentation schlecht ist - jemand versucht, auf eine schlecht dokumentierte python-framework? Manchmal müssen Sie zurückkehren, um das Lesen der Quelle.

    Hier sind einige Strategien, um Probleme zu vermeiden mit duck typing:

    • erstellen Sie eine Sprache für Ihr problem domain
    • dies wird Ihnen helfen, zu Namen, Sachen richtig
    • Typen benutzen zu repräsentieren Konzepte in der Domäne Sprache
    • name Funktion Parameter anhand der domain die Sprache Vokabular

    Auch einer der wichtigsten Punkte:

    • halten Daten so lokal wie möglich!

    Sollte es nur ein paar gut definiert und dokumentiert Typen werden herumgereicht. Alles andere sollte offensichtlich sein, indem Sie sich den code: nicht komisch parameter-Typen kommen von weit Weg, dass Sie nicht herausfinden können, durch suchen in der Nähe von dem code...

    Verwandte, (und auch mit docstrings), es ist eine Technik, die in python aufgerufen doctests. Verwenden Sie, dass zu dokumentieren, wie Sie Ihre Methoden sind zu erwarten - und haben schöne unit-test-Abdeckung in der gleichen Zeit!

    • Danke, das sind die Vorschläge, die ich suchte...
    • Numpy-Dokumentation ist ein gutes repräsentatives Beispiel für die Philosophie erklärte in der Antwort oben.
    InformationsquelleAutor Daren Thomas
  3. 6

    Ja, solltest du docstrings verwenden, um Ihre Klassen und Funktionen, die mehr freundlich zu anderen Programmierern:

    Mehr: http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring

    Einige Editoren erlauben Ihnen, zu sehen, docstrings während der Eingabe, so ist es wirklich die Arbeit erleichtert.

    • +1: Dokument, es ist die einzige vernünftige Möglichkeit, und das ist der Fall für statisch typisierte Sprachen. Rückgabetypen sind ein unbedeutender Bruchteil des gesamten Bildes.
    InformationsquelleAutor Maciej Ziarko
  4. 4

    Besuchte ich die coursera-Kurs, es war die Lektion, in der wir unterrichtet wurden, über design-Rezept.

    Unten docstring format fand ich sehr nützlich.

    def area(base, height): 
"'(Zahl, Anzahl ) -> Anzahl #**TypeContract** 
Zurück die Fläche des tring mit Abmessungen base #**Beschreibung** 
und Höhe 

>>> - Bereich(10,5) #**Beispiel ** 
25.0 
>> - Bereich(2.5,3) 
3.75 
"' 
return (Basis * Höhe) /2

    Ich denke, wenn docstrings geschrieben sind, in dieser Weise, könnte es helfen, eine Menge an Entwickler.

    Link zum video [Tun Sie das video zu sehen] : https://www.youtube.com/watch?v=QAPg6Vb_LgI

    InformationsquelleAutor murarisumit
  5. 2

    Ja, es ist.

    In Python eine Funktion nicht immer haben, um eine variable des gleichen Typs (obwohl dein code wird besser lesbar, wenn Sie Ihre Funktionen immer wieder den gleichen Typ). Das bedeutet, dass Sie können nicht geben Sie einen einzigen return-Typ der Funktion.

    In der gleichen Weise, die Parameter nicht immer die gleichen zu geben.

    InformationsquelleAutor thomson_matt
  6. 1

    Ja, da es ein dynamisch geben Sie die Sprache 😉

    Lesen dieser Referenz: PEP 257

    InformationsquelleAutor Alois Cochard
  7. 1

    Zum Beispiel: wie beschreiben Sie kurz und prägnant in einem docstring, der eine Funktion liefert eine Liste von Tupeln, wobei jedes Tupel der form (node_id, Knotenname, uptime_minutes) und die Elemente sind jeweils in einen string -, string-und integer?

    Ähm... Es gibt keine "knappe" Beschreibung dazu. Es ist Komplex. Sie haben entwickelt, um es zu Komplex sein. Und es erfordert eine umfangreiche Dokumentation, in der docstring.

    Sorry, aber die Komplexität ist -- gut -- Komplex.

    • OK. Off-topic (Art): aber was wäre eine sauberere design dann? Klassen?
    • Nicht unbedingt. Komplexität klingt unausweichlich. Prägnant ist nicht immer erreichbar oder gar wünschenswert.
    • Eine offensichtliche Weise zu dokumentieren, diese Art der Sache wird durch die Verwendung etwas ähnlich wie Java-generics, in: list<Tupel<int, str, int>>. Aber das ist nicht die Python-Weg, zum besseren oder zum schlechteren.
    InformationsquelleAutor S.Lott
  8. 0

    Docstrings (und Dokumentation im Allgemeinen). Python 3 bietet (optional) Funktion Anmerkungen, wie beschrieben in PEP 3107 (aber nicht weglassen, docstrings)

    InformationsquelleAutor Steven
  9. -3

    Habe ich in Python eine Menge, so ist es nicht nur eine seichte Antwort; Bitte verwenden Sie eine statisch typisierte Sprache wie Go oder Maschinenschrift für die Produktion verwenden. Es ist ein coding horror zu versuchen, herauszufinden, Typen in leicht komplexe Anwendungen mit dynamisch typisierten Sprachen

    InformationsquelleAutor Alex Punnen
Schreibe einen Kommentar