Łańcuch dokumentu w języku Python: potrójny podwójny cytat v. Podwójny cytat

Question

Jaki jest preferowany sposób pisania ciągu do dokumentu w języku Python?

""" lub "

W książce Dive Into Python: http://www.diveintopython.net/getting_to_know_python/documenting_functions.html, autor przewiduje następujący przykład:

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

    Returns string.""" 

W innym rozdziale: http://www.diveintopython.net/object_oriented_framework/index.html#fileinfo.divein, autor zapewnia Inny przykład:

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

Obie składnia działają. Jedyna różnica polega na tym, że """ umożliwia nam pisanie wielu wierszy dokumentu.

Czy jest jakakolwiek inna różnica?

Answer 1

Z PEP8 Style Guide:

• PEP 257 opisuje dobre konwencje docstring. Zauważ, że większość ważniejsze, „” „który kończy docstring multiline powinny być na linii przez siebie, np:

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

• dla jednego docstrings liniowej, to jest w porządku, aby utrzymać zamknięcie«»” na w tej samej linii.

PEP 257 zaleca stosowanie potrójnych cudzysłowów, nawet dla docstrings jeden online:

• Potrójne cudzysłowy są wykorzystywane chociaż łańcuch pasuje na jednej linii. To ułatwia późniejsze rozszerzenie.

Należy pamiętać, że nawet standardowa biblioteka Python sama nie stosuje się do tych zaleceń. Na przykład,

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

Answer 2

Oboje są strunami, więc nie ma różnicy. Korzystny styl jest potrójne cudzysłowy (PEP 257):

Dla spójności, zawsze używaj """triple double quotes""" wokół docstrings.

Użyj r"""raw triple double quotes""", jeśli używasz odwrotnych ukośników w swoich docstrings. W przypadku kodu Unicode użyj polecenia u"""Unicode triple-quoted strings""".

Answer 3

Nie, raczej nie. Jeśli piszesz do pliku, używanie potrójnych cytatów może być idealne, ponieważ nie musisz używać "\ n", aby przejść do następnego wiersza.Upewnij się, że cytaty, które zaczynasz i kończysz, są tego samego typu (podwójne lub potrójne cytaty). Tutaj jest wiarygodnym źródłem, jeśli masz jakieś pytania:

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