python abc

Python ABC

Eine Python -Implementierung der ABC -Software -Metrik:

Die ABC -Software -Metrik wurde 1997 von Jerry Fitzpatrick eingeführt, um die Nachteile des LOC zu überwinden. Die Metrik definiert einen ABC -Wert als Triplett von Werten, die die Größe einer Reihe von Quellcode -Anweisungen darstellen. Eine ABC -Bewertung wird berechnet, indem die Anzahl der Zuordnungen (a), die Anzahl der Zweige (b) und die Anzahl der Bedingungen (c) in einem Programm gezählt werden. ABC -Score kann auf einzelne Methoden, Funktionen, Klassen, Module oder Dateien in einem Programm angewendet werden.

Das Originalpapier von Fitzpatrick ist zum Zeitpunkt des Schreibens nur über den Wayback -Computer erhältlich, sodass auch eine Kopie davon in diesem Repo enthalten ist.

Das Papier listet die Zählregeln für C, C ++ und Java auf. Hier sind die Regeln, die diese Repo für Python verwendet:

• Fügen Sie eine zur Zählung der Zuordnung hinzu, wenn:
  • Auftreten eines Zuordnungsoperators (ohne Standardparameterzuweisungen).
• Fügen Sie eine zum Zählen der Filiale hinzu, wenn:
  • Auftreten eines Funktionsaufrufs/Wartezeit oder eines Klassenmethode -Aufrufs/-waarts.
  • Auftreten einer Klasse -Instanziierung.
• Fügen Sie eine zum Zustand hinzu, wenn:
  • Auftreten eines bedingten Operators.
  • Auftreten der folgenden Schlüsselwörter: else , elif except .
  • Auftreten einer assert -Erklärung ohne bedingten Bediener.

Verwendung

Installieren Sie die Anforderungen in Ihrer virtuellen Umgebung Ihrer Wahl. Anschließend sehen Sie die verfügbaren Befehlszeilenargumente:

$ python -m python_abc --help
usage: python_abc [-h] [--debug DEBUG] [--sort SORT] [--verbose VERBOSE] path

A python implementation of the ABC Software metric: https://en.wikipedia.org/wiki/ABC_Software_Metric

positional arguments:
  path               path to directory or file

optional arguments:
  -h, --help         show this help message and exit
  --debug DEBUG      display AST output for each element in the parsed tree
  --sort SORT        sort files from highest to lowest magnitude
  --verbose VERBOSE  display marked-up file

Gegebene file.py , die den folgenden Text enthält:

 if a and b :
    print ( a )
else :
    print ( b )

a = sum ( i for i in range ( 1000 ) if i % 3 == 0 and i % 5 == 0 )

def f ( n ):
    def inner ( n ):
        return n ** 2
    if n == 0 :
        return 1
    elif n == 1 :
        return n
    elif n < 5 :
        return ( n - 1 ) ** 2
    return n * pow ( inner ( n ), f ( n - 1 ), n - 3 )

Sie können die Barebones wie folgt ausgeben:

$ python -m python_abc /path/to/file.py
/path/to/file.py         < 1, 7, 10> (12.2)

Das Übergeben der verbose Flagge gibt mehr Details:

$ python -m python_abc file.py --verbose=true
cc    | if a and b:
b     |     print(a)
c     | else:
b     |     print(b)
      |
abbcc | a = sum(i for i in range(1000) if i % 3 == 0 and i % 5 == 0)
      |
      | def f(n):
      |     def inner(n):
      |         return n ** 2
c     |     if n == 0:
      |         return 1
cc    |     elif n == 1:
      |         return n
cc    |     elif n < 5:
      |         return (n - 1) ** 2
bbb   |     return n * pow(inner(n), f(n - 1), n - 3)
file.py          < 1, 7, 10> (12.2)

Wenn Sie den abstrakten Syntaxbaum für die Datei inspizieren möchten, können Sie das debug -Flag übergeben, das jeden Knoten vom Baum und dem daraus resultierenden Vektor ausdruiert.

Das path kann auch ein Pfad zu einem Verzeichnis sein. In diesem Fall werden alle Python-Dateien in diesem Verzeichnis (und seine Unterabrechnung) gescannt. An diesem Punkt kann es nützlich sein, das sort zu übergeben, um die Dateien nach ABC zu bewerten Größe:

$ python -m python_abc . --sort
./calculate.py                              < 18, 56, 23> (63.2)
./vector.py                                 < 12, 23, 11> (28.2)
./main.py                                    < 10, 23, 8> (26.3)
./tests/test_vector.py                       < 4, 19, 10> (21.8)
./tests/__init__.py                           < 4, 12, 1> (12.7)
./tests/test_radon_test_cases.py                < 1, 2, 1> (2.4)
./tests/test_calculate_condition.py             < 1, 2, 1> (2.4)
./tests/test_calculate_empty.py                 < 1, 2, 1> (2.4)
./tests/test_calculate_assignment.py            < 1, 2, 1> (2.4)
./tests/test_calculate_branch.py                < 1, 2, 1> (2.4)

Schließlich können Sie ein cores übergeben, um der Bibliothek zu sagen, wie viele CPU -Kerne sie verwenden sollen. Standardmäßig versucht die Bibliothek, alle auf Ihrem Computer verfügbaren Kerne zu verwenden.