Python-PEP 8 docstring line Länge

Ich habe vor kurzem damit begonnen, herauszufinden wäre es eine gute Idee zu Folgen, PEP 8. Ich habe meine editor-Anzeige der 80-Spalte markieren-und jetzt bin versucht, wrap-Zeilen, um es in passen. Meine Frage ist diese. In PEP-8 heißt es:

Begrenzen alle Linien zu maximal 79 Zeichen.

Sinn macht.

[...] Für fließende lange Textblöcke (docstrings oder Kommentare), die Begrenzung der Länge auf 72 Zeichen ist empfohlen.

Warum 72? Warum nicht 79 Ordnung für docstrings oder Kommentare?

  • Ich bin ein bisschen verwirrt. Ist die 72-Zeichen-Begrenzung für Kommentare inklusive Einrückung oder nicht?
  • Auch die engen Spalten von longform-text mehr lesbar ist, denke Zeitungen.
InformationsquelleAutor Claudiu | 2013-03-15
  1. 11

    Ich glaube, es ist ein Kater aus der text-Dokumente:

    Am Ende der Schreibmaschine Alter, die meisten Entwürfe waren darauf ausgerichtet, 72
    CPL, abgeleitet von einer Steigung von 12 Zeichen pro Zoll, multipliziert mit 6
    Zoll (siehe zum Beispiel IBM-Schreibmaschine). Damit wäre gewährleistet, dass mindestens 1
    Zoll für jeden Rand, mit der US-Regierung an der Zeit, dass
    standardisiert auf 8 1/2×11" - Papier.

    Quelle

    Viele nur-text-Dokumente noch entsprechen 72 CPL aus der tradition heraus.

    Ich denke, dies ist nur als docstrings werden Häufig verwendet, in Kontexten außerhalb von code, so macht es Sinn, entsprechen dem Stil, den die meisten nur-text-Dokumente verwenden, um zu versuchen und bleiben so konsistent wie möglich. Zum Beispiel, den text von man Seiten sind in der Regel verpackt zu 72 Zeichen. Durch die Begrenzung docstrings zu 72 Zeichen, die Ausgabe von help() Spiegel dieser.

    Diese Frage an Programmierer kann auch relevant sein.

    • Als Kommentar - das ist alles eine Vermutung - ich habe keine Quelle, die besagt, dass dies ist der Grund, es ist nur wahrscheinlicher scheint mir -, wenn jemand hat etwas zu konkretisieren, ich hätte Interesse.
    • Es ist eine gute Vermutung aber.
    • Der text wurde Hinzugefügt von Guido in dieses changeset so müsste man ihn bitten, für seine Quelle. Es könnte sein, detailliert auf die Mailinglisten.
    • Nachdem durchforstet die Liste von Archiven aus der ganzen Zeit, die ich nicht finden, jede Diskussion über die Veränderung. Was Guido Quelle basiert diese auf ist nicht offenbart es.
    InformationsquelleAutor Gareth Latty
  2. 3

    Docstrings sind in der Regel eingerückt mit Ihrer Funktion beginnen und enden mit dreifachen Anführungszeichen:

    def foo(bar, baz):
    """Frobnicate the foobars into baz

    Parameters are ham and spammed.

    """

    Ist 79 - 4 - 3 = 72 Zeichen nach Links.

    • Ich bin mir ziemlich sicher, dass die 72-Zeichen beschränken soll, um diese.
    • Hrm, vielleicht. Selbst nicht sicher, aber haben Sie vielleicht einen Punkt mit deiner Antwort zu.
    • Das gilt nur für die erste Zeile der docstring, richtig? Nach diesem, Sie werden nur eingeschränkt bis 79 - 4 = 75 Zeichen. Wie kann man es machen einfach zu respektieren 72 Verjährung nach der ersten Zeile?
    • Meine interpretation dieser Antwort ist, dass nur die erste Zeile würde mit begrenzt auf 72 Zeichen, die nachfolgenden Zeilen bekommen würde 75. Wenn Sie nicht einverstanden sind, müssen Sie manuell prüfen, ob diese Beschränkung oder verwenden Sie eine linter, unterstützt die Prüfung dieser Einschränkung.
    • Aber ich LIEBE diese interpretation ist =D Ist es PEP-konform?
    • es ist, wenn Sie interpretieren, das PEP auf diese Weise. Das ist das Problem hier, der PEP ist offen für mehrere Interpretationen.
    • Ich hatte nie in Betracht gezogen PEP wie eine religion-Buch so weit.. aber hey, es nicht so Aussehen? 😉
    • Das macht keinen Sinn. Wenn dein limit ist 72, Ihr Einrücken oder quote hat null Einfluss auf das, es sei denn, irgendwie Sie sagen, die Linie der Länge minus Einrücken und dreifach zitieren muss weniger als 72. Zum Beispiel, eine Klasse Methoden hat 2 Einzüge (mindestens), aber der docstring line length limit ist noch 72, jedoch werden die verfügbaren Zeichen ändert sich mit dem zweiten Gedankenstrich.

    InformationsquelleAutor Martijn Pieters
  3. 2

    Dem Grund, dass die Linien sollten 79 Zeichen ist, so dass Sie passen in einen 80 Zeichen breiten terminal (offensichtlich gibt es Sie noch). Der Grund dafür, dass die 72-Zeichen verwendet werden, die auf der docstring ist, dass dies bedeutet, dass Sie haben gleichen Abstand auf beiden Seiten (docstrings sind eingerückt, nachdem alle) und immer noch fit in den 80 Zeichen Breite.

    • Aber nicht 80 Zeichen passen in einen 80 Zeichen breiten terminal auch?!
    • Haben Sie eine Quelle für diese?
    InformationsquelleAutor cwallenpoole
Schreibe einen Kommentar