¿Cómo contar las líneas de código en Python excluyendo los comentarios y las cadenas de documentos?

Question

Quiero contar las líneas de código en un proyecto de Python de varios archivos con la mayor precisión posible, pero sin incluir comentarios, cadenas de documentos ni líneas en blanco en el total.

Intenté por primera vez el uso de cloc, que está disponible como un paquete de Debian. Pero cloc trata la mayoría de las cadenas de documentos como código, a pesar de que son comentarios. (Actualización:. Ya no - las versiones recientes de cloc ahora el tratamiento de cadenas de documentación de Python como comentarios)

noto algunos comentarios a continuación decir que las cadenas de documentación deben ser incluidos en el total, ya que pueden ser utilizados por el código para influir en el comportamiento en tiempo de ejecución y, por lo tanto, cuenta como parte de los programas code/data/config. Un ejemplo prominente de esto es 'ply', que le pide que escriba funciones con docstrings que, según recuerdo, contienen gramática y expresiones regulares que son fundamentales para el funcionamiento del programa. Sin embargo, esto me parece ser una rara excepción. La mayoría de las veces, las cadenas de documentos actúan como comentarios. Específicamente, sé que es cierto para todo el código que quiero medir. Así que quiero excluirlos como tales de mi conteo de líneas.

Answer 1

Probablemente sea correcto incluir las cadenas de Python en un recuento de "líneas de código". Normalmente un comentario sería descartada por el compilador, pero docstrings se analiza:

Ver PEP 257 - Docstring Conventions:

Una cadena de documentación es una cadena literal que se presenta como la primera instrucción un módulo, función, clase o definición de método. Tal docstring se convierte en el atributo especial __doc__ de ese objeto.

...

literales de cadena que ocurre en otros lugares en código Python también puede actuar como documentación. no son reconocidos por el compilador de bytecode de Python y no son accesibles como atributos de los objetos en tiempo de ejecución ..

En otras palabras, las cadenas de documentación se compila y se constituyen, de una manera muy real, el código de la programa. Además, son comúnmente utilizados por doctest module para pruebas unitarias, como cadenas de uso para utilidades de línea de comandos, y así sucesivamente.

Answer 2

¿Has mirado en http://www.ohloh.net/p/ohcount - siempre ha sido bastante en el dinero para mí - aunque yo no uso pitón

Answer 3

Las líneas de comentario puede ser líneas de código en Python. Ver doctest por ejemplo.

Por otra parte, tendrá problemas para encontrar una manera sensata/fiable para considerar un caso como este como un comentario o código:

foo = ('spam', 
     '''eggs 
      eggs 
      eggs''' 
     '''more spam''', 
     'spam') 

contar sólo las líneas de comentario así, creo que la mayoría de los programadores acuerde que es una buena medida para lo que sea que realmente esté tratando de medir.

Answer 4

Tahar no cuenta las cadenas de documentos.Aquí está su función count_loc:

def count_loc(lines): 
    nb_lines = 0 
    docstring = False 
    for line in lines: 
     line = line.strip() 

     if line == "" \ 
      or line.startswith("#") \ 
      or docstring and not (line.startswith('"""') or line.startswith("'''"))\ 
      or (line.startswith("'''") and line.endswith("'''") and len(line) >3) \ 
      or (line.startswith('"""') and line.endswith('"""') and len(line) >3) : 
      continue 

     # this is either a starting or ending docstring 
     elif line.startswith('"""') or line.startswith("'''"): 
      docstring = not docstring 
      continue 

     else: 
      nb_lines += 1 

    return nb_lines