python abc

Python ABC

Uma implementação do Python da métrica de software ABC:

A métrica de software ABC foi introduzida por Jerry Fitzpatrick em 1997 para superar as desvantagens do LOC. A métrica define uma pontuação ABC como um trigêmeo de valores que representam o tamanho de um conjunto de instruções de código -fonte. Uma pontuação ABC é calculada contando o número de atribuições (a), número de ramificações (b) e número de condicionais (c) em um programa. A pontuação ABC pode ser aplicada a métodos, funções, classes, módulos ou arquivos individuais em um programa.

O artigo original de Fitzpatrick está, no momento da redação deste artigo, disponível apenas na Wayback Machine; portanto, uma cópia também está incluída neste repositório.

O artigo lista as regras de contagem para C, C ++ e Java, então aqui estão as regras que este repo usa para o Python:

• Adicione um à contagem de tarefas quando:
  • Ocorrência de um operador de atribuição (excluindo atribuições de parâmetros padrão).
• Adicione um à contagem da filial quando:
  • Ocorrência de uma chamada de função/aguarda ou um método de classe chamada/aguarda.
  • Ocorrência de uma instanciação de classe.
• Adicione um à contagem de condições quando:
  • Ocorrência de um operador condicional.
  • Ocorrência das seguintes palavras -chave: else , elif , except .
  • Ocorrência de uma declaração assert sem um operador condicional.

Uso

Instale os requisitos em seu ambiente virtual de escolha, então você pode ver os argumentos da linha de comando disponíveis:

$ 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

Dado file.py que contém o seguinte texto:

 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 )

Você pode obter a saída BareBones da seguinte maneira:

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

Passar a bandeira verbose dará mais detalhes:

$ 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)

Se você deseja inspecionar a árvore de sintaxe abstrata para o arquivo, poderá passar o sinalizador debug , que imprimirá cada nó da árvore e o vetor que resultou dela.

O argumento path também pode ser um caminho para um diretório; nesse caso, todos os arquivos python nesse diretório (e seus subdiretos) serão digitalizados; nesse momento, pode ser útil passar o sinalizador sort para classificar os arquivos por ABC magnitude:

$ 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)

Finalmente, você pode passar em um argumento cores para informar à biblioteca quantos núcleos da CPU usam. Por padrão, a biblioteca tentará usar todos os núcleos disponíveis em sua máquina.