IndentationError z komentarza w python

Question

Jak to się dzieje, że python reaguje na wcięcia komentarza?

def foo(): 
    """ 
    Random comment 
    """ 
    return True 

działa, ale:

def foo(): 
""" 
Random comment 
""" 
    return True 

nie działa, rzucając IndentationError.

Wydaje mi się dziwne, ponieważ komentarze nie powinny być niczym więcej niż komentarzami. A tak przy okazji, to działa:

def foo(): 
# Another random comment 
    return True 

Answer 1

Potrójny cytat nie jest komentarzem; to jest doktryna metody. Możesz uzyskać do niego dostęp na przykład pod numerem foo.__doc__ później lub na przykład sformatować za pomocą help(foo). Potrącenie (""" lub ''') jest specyficzną dla Pythona metodą określania string literal, w której znaki nowej linii nie muszą być znakowane.

Jako taki jest częścią treści funkcji i dlatego musi zostać dopasowany. W rzeczywistości każdy ciąg występujący jako first statement of a function jest traktowany jako docstring, pojedyncze cytowanie też by działało. Ta sama sztuczka działa również w przypadku klas i modułów.

Wiele narzędzi może wykorzystać ten ciąg dokumentacji; na przykład w tej informacji można wstawić doctest tests. Zobacz PEP 257 dla konwencji dotyczących formatowania tego ciągu. Komentarze, z drugiej strony, są zawsze oznaczone przez # (gdzie nie jest częścią literału ciągłego) i są ignorowane do końca wiersza. Jeśli cała linia zawiera komentarz, cała linia jest ignorowana, podobnie jak linia z białymi znakami. Zobacz documentation on comments.

Answer 2

Potrójnie cytowany ciąg nie jest komentarzem, jest literałem ciągowym. Nie jest ona przypisana ani użyta w żaden sposób przez twój kod, ale wciąż jest to zwykły ciąg i musi pasować do składni Pythona. (W tym przypadku jest to docstring, ale nie ma to nic wspólnego z tym, czy wcięcie ma dla niego znaczenie, czy nie).

# to sposób na komentarze.