Jak liczyć wiersze kodu w Pythonie z wyjątkiem komentarzy i poleceń?

Question

Chcę zliczyć wiersze kodu w wieloplikowym projekcie Pythona tak dokładnie, jak to możliwe, ale bez uwzględniania komentarzy, docstrukcji lub pustych wierszy w sumie.

Najpierw próbowałem użyć cloc, który jest dostępny jako pakiet Debiana. Ale cloc traktuje większość docstrukcji jako kod - mimo że są komentarzami. (Aktualizacja:. już nie - najnowsze wersje cloc teraz traktują docstrings Python jako komentarze)

Zauważyłem kilka uwag poniżej mówiąc, że docstrings powinny być uwzględnione w całości, ponieważ mogą one być wykorzystywane przez kod, aby wpływać na zachowanie się runtime i dlatego liczą się jako część programów code/data/config. Znaczącym tego przykładem jest "ply", który prosi o pisanie funkcji za pomocą docstrukcji, które, jak pamiętam, zawierają gramatykę i wyrażenia regularne, które są kluczowe dla działania programu. Jednak wydaje mi się to bardzo rzadkim wyjątkiem. W większości przypadków docstrukcje zachowują się jak komentarze. W szczególności wiem, że to prawda dla całego kodu, który chcę zmierzyć. Dlatego chcę je wykluczyć jako takie z mojej liczby linii.

Answer 1

Prawdopodobnie prawidłowe jest dołączanie doctrings Pythona do liczby wierszy kodu. Normalnie komentarz zostanie odrzucona przez kompilator, ale docstrings są przetwarzane:

Zobacz PEP 257 - Docstring Conventions:

docstring jest ciągiem dosłowny, który występuje jako pierwsze pismo w moduł, funkcji, klasy lub definicja metody. Taki docstring staje się specjalnym atrybutem tego obiektu.

...

literały łańcuchowe występujące gdzie indziej w kodzie Pythona może również działać jako dokumentacji. nie są one rozpoznawane przez kompilator Pythona kodu bajtowego i nie są dostępne jako atrybuty obiektu Runtime ..

Innymi słowy, docstrings są skompilowane i stanowią, w bardzo realny sposób, kod program. Dodatkowo są one powszechnie używane przez doctest module do testowania jednostkowego, jako ciągi użycia dla narzędzi wiersza poleceń i tak dalej.

Answer 2

Czy spojrzał na http://www.ohloh.net/p/ohcount - zawsze była całkiem na pieniądze dla mnie - choć nie używam Python

Answer 3

komentarz linie mogą być linie kodu w Pythonie. Zobacz na przykład doctest.

Ponadto, będziesz mieć problemy, aby znaleźć sensowną/niezawodny sposób, aby rozważyć takim wypadku jako komentarz lub kod:

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

Wystarczy policzyć linie komentarz jako dobrze, myślę, że większość programistów będzie zgadzam się, że jest to dobry środek dla tego, co faktycznie próbujesz zmierzyć.

Answer 4

Tahar nie liczy docstrukcji.Oto jego funkcja 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