Python-doc-Zeichenfolge: Triple-Double-Quote vs. Doppeltes Zitat

Question

Was ist die bevorzugte Art, Python-Doc-String zu schreiben?

""" oder "

Im Buch Dive Into Python: http://www.diveintopython.net/getting_to_know_python/documenting_functions.html, der Autor das folgende Beispiel:

def buildConnectionString(params): 
    """Build a connection string from a dictionary of parameters. 

    Returns string.""" 

In einem anderen Kapitel: http://www.diveintopython.net/object_oriented_framework/index.html#fileinfo.divein stellt der Autor ein anderes Beispiel:

def stripnulls(data): 
    "strip whitespace and nulls" 
    return data.replace("\00", "").strip() 

Beide Syntax funktioniert. Der einzige Unterschied zu mir ist, dass """ uns erlaubt, mehrzeiliges Dokument zu schreiben.

Gibt es einen Unterschied anders als das?

Answer 1

Vom PEP8 Style Guide:

• PEP 257 beschreibt gut docstring Konventionen. Beachten Sie, dass die meisten wichtiger ist, die „“ „dass endet ein mehrzeiliges docstring auf einer Linie für sich allein sein sollte, zum Beispiel:

  """Return a foobang 
  
  Optional plotz says to frobnicate the bizbaz first. 
  """ 
  

• Für einzeiler Docstrings, es okay ist, die Schließung zu halten‚auf‘“ gleiche Zeile.

PEP 257 empfiehlt dreifache Anführungszeichen, auch für einzeilige Docstrings:

• Triple-Zitate auch verwendet werden, wenn die Zeichenfolge auf einer Zeile passen. Diese macht es leicht, sie später zu erweitern.

Beachten Sie, dass nicht einmal die Python-Standardbibliothek selbst diese Empfehlungen konsequent befolgt. Zum Beispiel

• abcoll.py
• ftplib.py
• functools.py
• inspect.py

Answer 2

Sie sind beide Saiten, also gibt es keinen Unterschied. Die bevorzugte Art ist triple doppelte Anführungszeichen (PEP 257):

Aus Gründen der Einheitlichkeit immer """triple double quotes""" um Docstrings zu verwenden.

Verwenden Sie r"""raw triple double quotes""", wenn Sie Backslashes in Ihren Docstrings verwenden. Verwenden Sie für Unicode-Docstrings u"""Unicode triple-quoted strings""".

Answer 3

Nein, nicht wirklich. Wenn Sie in eine Datei schreiben, ist die Verwendung von dreifachen Anführungszeichen ideal, da Sie "\ n" nicht verwenden müssen, um eine Zeile nach unten zu setzen.Stellen Sie nur sicher, dass die Anführungszeichen, mit denen Sie beginnen und enden, vom selben Typ sind (doppelte oder dreifache Anführungszeichen). Hier ist eine zuverlässige Ressource, wenn Sie weitere Fragen haben:

http://docs.python.org/release/1.5.1p1/tut/strings.html