IndentationError from comment in python

Question

¿Cómo es que python reacciona a indentaciones de un comentario?

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

funciona, pero:

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

no funciona, lanzando una IndentationError.

Me parece raro ya que los comentarios no deberían ser nada más que comentarios. Y, por cierto, esto funciona:

def foo(): 
# Another random comment 
    return True 

Answer 1

La cadena tripple-citada no es un comentario; es el docstring del método. Puede acceder a él con foo.__doc__ más tarde, por ejemplo, o tenerlo formateado para usted con help(foo). Tripple-quoting (""" o ''') es un método específico de python para especificar un string literal donde no es necesario escaparse de las nuevas líneas.

Como tal, es parte del cuerpo de la función y, por lo tanto, debe sangrar para que coincida. De hecho, cualquier cadena que aparezca como first statement of a function se trata como una docstring, las comillas simples también funcionarían. El mismo truco funciona también para clases y módulos.

Muchas herramientas pueden hacer uso de esta cadena de documentación; puede incrustar doctest tests en esta información, por ejemplo. Consulte PEP 257 para conocer las convenciones sobre el formato de esta cadena.

Comentarios sobre la otra parte, son siempre denotado por un # (donde no es parte de una cadena literal) y se ignoran hasta el final de una línea. Si toda la línea contiene un comentario, se ignorará toda la línea, al igual que una línea con espacios en blanco. Vea el documentation on comments.

Answer 2

La cadena de comillas triples no es un comentario, es una cadena literal. No es asignado o usado de ninguna manera por tu código, pero sigue siendo una cadena regular y debe ajustarse a la sintaxis de Python. (En este caso, resulta ser la docstring, pero eso no tiene nada que ver con si la sangría importa o no).

# es la forma de obtener comentarios.