Wo finde ich geeignete Beispiele für die Docstring-Konventionen PEP 257?

Question

PEP 257 says:

eine leere Zeile einfügen vor und nach allen Docstrings (einzeilige oder mehrzeiligen), die eine Klasse Dokument - allgemein gesprochen, wird die der Klassenmethoden voneinander durch eine einzelne getrennte Leerzeile und die Docstring von dem ersten Verfahren durch eine Leerzeile versetzt werden muss; für Symmetrie, legte eine Leerzeile zwischen den Klasse-Header und dem docstring.

Aber ich kann anscheinend keinen Code finden, der das tatsächlich implementiert.

ich eingecheckt haben mehrere Standardmodule mit Python ausgeliefert 2.6, suchten auch speziell für diejenigen, wo Guido Name erwähnt wird. Aber auch der Code des rietveld Code-Review-Tool nicht entspricht IMHO nicht (siehe zB http://code.google.com/p/rietveld/source/browse/upload.py):

class CondensedHelpFormatter(optparse.IndentedHelpFormatter): 
    """Frees more horizontal space by removing indentation from group 
     options and collapsing arguments between short and long, e.g. 
     '-o ARG, --opt=ARG' to -o --opt ARG""" 

    def format_heading(self, heading): 
    return "%s:\n" % heading 

Diese docstring mehrzeilige nicht über eine Leerzeile in vor und die Leerzeile nach außerhalb der Schließung Anführungszeichen .

Diese Klasse von /usr/lib64/python2.6/site.py nicht eine Leerzeile vor, sondern eine Leerzeile vor und nach der Schließung Anführungszeichen hat.

class _Helper(object): 
    """Define the built-in 'help'. 
    This is a wrapper around pydoc.help (with a twist). 

    """ 

    def __repr__(self): 

Gibt es Beispiele zur Demonstration von PEP 257?

Vielen Dank im Voraus

Answer 1

keine direkte Antwort, aber wenn Sie mit PEP257 erfüllen möchten, können Sie ein Tool verwenden, schrieb ich: https://github.com/halst/pep257

ich zu war schockiert, wie viel Code zu sehen (auch in der Standardbibliothek) versucht nicht einmal, PEP257 zu entsprechen.

Wahrscheinlich sind die meisten Leute denken, dass ihre docstring-Stil macht Sinn, und ich dachte auch etwas umständlich zu dem PEP257 Stil, aber, nachdem es seit einiger Zeit fiel ich in der Liebe mit ihr mit, und denke, dass es die schönste Art ist, Docstrings zu schreiben. Ich folge immer PEP257 in jedem Aspekt, den ich kann, und schrieb das Tool, damit mehr Leute sehen können, wie sie ihren Stil verbessern können.

Als Beispiel hatte ich eine lustige Erfahrung mit PEP8 und pep8 tool: wenn ich es hat mir gefallen erste PEP8 lesen und dachte ich es folgen, aber wenn ich auf PEP8 meinen Code versucht Ich war schockiert, wie weit von PEP8 Ich bin, und wie besser mein Code aussieht, behebe ich diese Stilfehler.

Ich hoffe, die Leute werden ähnliche Erfahrung mit pep257 haben, und beginnen, PEP257 glücklich seitdem zu folgen.

Answer 2

Soweit ich sehen kann, das Dokument, das Sie verknüpft sagt:

eine leere Zeile nach alle Docstrings einlegen (einzeiligen oder mehrzeiligen), daß das Dokument eine Klasse - allgemein gesprochen Die Methoden der Klasse sind durch eine einzige Leerzeile voneinander getrennt, und der Docstring muss gegenüber der ersten Methode um eine Leerzeile versetzt werden.

(Hervorhebung von mir)

So sind die Beispiele, die Sie geben, sind alle richtig, da sie eine leere Zeile nach dem docstring haben, so dass die nächste Methode Erklärung mit einer Leerzeile zu trennen.