QoCode — Análisis de calidad de código

01 /

Seleccionar solución del alumno

↑

Clic para seleccionar o arrastrar y soltar

Archivos .py individuales o .zip — no se pueden mezclar

✓

02 /

Elegir qué evaluar

Legibilidad legibilidad ▶

Calidad semántica de nombres ▶

Evalúa si los nombres de variables, funciones y parámetros reflejan de forma clara y comprensible su propósito dentro del programa, facilitando la interpretación del código sin necesidad de analizar su implementación.

Nombres engañosos por cardinalidad Nombre singular para una colección, plural para un escalar, o variable de iteración en plural

Nombres ilegibles o poco informativos Nombre de un solo carácter, sin vocales, con patrón letra-dígito, o no reconocible como palabra del español

Gramática inconsistente Procedimiento con nombre sustantivo, función pura con verbo de efecto, o variable booleana con nombre no predicativo

Nombres incompletos Función cuyo nombre es un verbo solo sin complemento (calcular, obtener, guardar)

Estilismo de nombres ▶

Evalúa la coherencia y el formato visual de los nombres en el código, considerando aspectos como longitud y estilo de escritura, con el objetivo de mantener una nomenclatura uniforme y fácil de recorrer.

Nombres excesivamente largos Nombres cuya longitud supera los 50 caracteres y dificulta el escaneo fluido del código

Errores ortográficos en nombres Palabras mal escritas en identificadores, detectadas contra diccionarios de español e inglés

Uso inconsistente de casing Mezcla de camelCase, snake_case u otros estilos cuando uno es claramente predominante (>70%)

Uso de palabras reservadas Uso de nombres de variables o funciones que colisionan con built-ins de Python (ej: list, input, type)

Calidad semántica de los valores ▶

Evalúa la calidad semántica de los valores utilizados en el código, considerando si estos mantienen un significado comprensible a lo largo del programa y evitando prácticas que oculten o confundan su interpretación, como el uso de magic numbers o cambios de significado en una misma variable.

Uso de magic numbers Constantes numéricas sin nombre cuyo significado no es evidente por el contexto

Reasignación de variables Reutilización de una misma variable para representar distintos conceptos

Formato de código ▶

Evalúa la estructura visual y la consistencia del formato del código, considerando aspectos como indentación, uso de espacios y organización de los bloques, con el objetivo de facilitar la identificación de su estructura lógica y mejorar su legibilidad.

Uso/abuso de indentación, espacios y saltos de línea Espacios alrededor de operadores, espacios innecesarios en paréntesis, espacios al final de línea

Declaración de variables lejos de su uso Variables declaradas más de 2 líneas antes de su primera referencia

Múltiples sentencias en una misma línea Más de una instrucción por línea, lo cual reduce la claridad y dificulta la lectura secuencial

Mantenibilidad mantenibilidad ▶

Simplificable ▶

Agrupa el código que puede simplificarse con cambios locales sin introducir nuevas construcciones. El objetivo es reducir la complejidad del flujo de control para favorecer la comprensión del programa y facilitar la detección de errores.

Else-if explícitoUna rama else que contiene solo un if

Ifs anidadosIfs anidados que se pueden evitar usando una conjunción

Condiciones secuenciales idénticasIfs consecutivos que testean la misma condición

If-else redundanteUn if-else con ambas ramas solamente retornando True o False

No Early ReturnUna condición que ejecuta un código más largo en la rama positiva y código más corto en la negativa

Else/elif redundanteUso de else cuando la rama positiva termina con return, break o continue

Elif redundanteLa condición del elif siempre es verdadera si se alcanza

If-elif reordenableUn if-elif-else cuyas condiciones pueden simplificarse reordenando las ramas

Condición negada de un if-elseUn if que su condición está negada y tiene una rama else

Operación aritmética repetidaUso repetido de la misma operación aritmética sobre una expresión

Comparación redundante con un booleanoExpresión booleana comparada con una constante booleana

Operador redundanteUsos innecesarios como --, ~~, ++, not not

Operación identidadSe realiza una operación en la expresión dando como resultado su valor original (ej: x+0, x-0, x*1, x/1)

Disyunción o conjunción con constante booleanaSe utiliza una constante booleana Falso en una conjunción o una constante booleana Verdadero en una disyunción

Expresión booleana negada simplificableExpresión booleana negada que se puede simplificar

Casteo de tipos redundanteSe aplica un casteo de tipos al resultado de una función o expresión que ya devuelve un resultado de ese tipo (STR, INT, FLOAT, BOOL)

Ciclo redundanteCiclo con una sola iteración

While true innecesarioCiclo while true que contiene un if con un break

Variable intermedia redundanteUn valor o resultado almacenado en una variable que se puede usar directamente en la expresión que la utiliza

Actualización innecesaria de variableOperaciones calculadas adentro de un loop innecesariamente

Comparación con sí mismoSe compara por igualdad una variable con sí misma

Ciclo con casos especiales para bordesCasos especiales para la primera o última iteración

Expresión booleana con mucha lógicaEl if, while o return tiene una expresión booleana con 5 o más condiciones que se evaluan

Ciclos secuenciales fusionablesCiclos que iteran sobre la misma estructura y se pueden fusionar en uno solo (si no importa el orden de las operaciones)

Parte de condición redundanteUna condición donde una parte implica la otra

Operación ConstanteSe realiza una operación en la expresión dando como resultado una constante (sin importar el valor que tenían las variables)

Match reemplazable por un ifSe utiliza un match con solamente dos casos donde uno es un patrón literal y el segundo es simplemente '_'

Código sin efecto ▶

Agrupa el código que no afecta el resultado de la ejecución. Su presencia suele deberse a lógica obsoleta o mal diseñada, y produce ruido innecesario que dificulta la comprensión del programa. Todos los defectos de esta categoría se resuelven eliminando código, sin necesidad de reordenarlo ni de incorporar nuevas construcciones.

Variable sin efectoUna variable que no se usa o se le asigna un valor que nunca se lee o no afecta el resultado final

Parámetro sin usarLa función tiene un parámetro que nunca se usa en su cuerpo

Módulo importado sin usarSe importa un módulo que no se usa

Código inalcanzableCódigo que nunca se ejecuta

Código sin efectoCódigo no tiene efecto en la ejecución

Incremento explícito de variable de control en un ciclo 'for'Cambiar el valor de la variable de control en un ciclo 'for' al final de una iteración no tiene efecto

Uso de printSe utiliza print() en el código

Pass redundanteSe utiliza pass y no tiene efecto en la ejecución

Código comentadoCódigo comentado

Continue redundante al final de un cicloSe usa continue al final de un ciclo, lo que no tiene efecto en la ejecución

Clausula if vacíaUna rama redundante que solamente contiene pass

Construcción inadecuada ▶

Se centra en detectar código que resultaría más explícito y simple usando una construcción diferente del lenguaje. Una construcción adecuada comunica de forma explícita la intención del programador, reduciendo la distancia entre el código y el problema que resuelve.

While como forUn ciclo while con la cantidad de iteraciones conocidas antes de su inicio

Indexación redundante en forIterar sobre los índices accediendo (no modificando) solo de un índice a la vez

Simulación de móduloIncrementar y resetear el valor de una variable en lugar de usar el operador %

For como whileUn ciclo for que se ejecuta una cantidad excesiva de veces tratando de replicar la funcionalidad de un ciclo while con un break

Índice explícito en foreachUn loop estilo for-each con el índice incrementado de forma separada

If para min/maxSe utiliza un if para determinar el mínimo/máximo de dos valores, en lugar de usar las funciones min()/max()

Valor absoluto implicitoCondición compuesta equivalente a una sola condición utilizando valor absoluto

Bandera booleana en lugar de abstracciónUna variable booleana asignada según una condición y utilizada en lugar de crear una función auxiliar para calcular un valor

Returns inconsistentes o sin un valor explícito al final de una funciónA veces retorna un valor de forma explicita y otras veces devuelve None de forma implicita, o bien solamente está al final de una función y no devuelve un valor de forma explícita

Switch duplicadoSe evalua una variable repetidas veces por igualdad con diferentes valores cuando se podría simplificar usando una lista o un diccionario

Igualdad fusionableUna expresión se compara por igualdad con múltiples valores

len(contenedor) como booleanoSe testea si un contenedor es vacío obteniendo su longitud y convirtiendola implicitamente a un booleano

Open/close explícitoSe hace un open/close de forma explicita para manipular un archivo en lugar de usar 'with'

Constante mágica para un caracterSe utiliza una constante numérica mágica en lugar del caracter correspondiente

División flotante convertida a enteroSe convierte inmediatamente a int el resultado de una división flotante

Llamada a dunder methodLlamada explicita a un método 'double-underscore' (con dos guiones bajos)

Comparación de tipos explícitaComparar tipos en lugar de usar isinstance()

Entero como booleanoSe utilizan unos y ceros en lugar de True y False

Booleano como enteroSe utilizan valores booleanos como si fueran unos y ceros

Range en lugar de comparaciónSe testea si un valor está o no en un range usando 'in range()' o 'not in range()' en lugar de hacer una comparación con los límites

Uso de breakSe usa break para cortar la ejecución de un ciclo

Código repetido ▶

Agrupa los defectos relacionados con la repetición de código. Así, al evitar la repetición se previenen inconsistencias al corregir errores en la lógica, además de facilitar la modificación del programa ante un cambio de requerimientos.

Expresión repetidaUna expresión aparece más de 4 veces en una función o más de 7 en un módulo

Secuencia duplicadaComandos o bloques de comandos consecutivos muy similares

Bloques duplicadosDos bloques de código muy similares

Ifs con mismo cuerpoSe escriben condiciones con código repetido en lugar de utilizar una condición con una disyunción para los casos donde se deba ejecutar el mismo código

Parte de una rama extraibleExisten líneas de código dentro del cuerpo de la alternativa if que son prefijo o sufijo de ambas ramas

Expresión compleja para valor conocidoSe vuelve a evaluar una expresión que tiene un valor ya conocido

Bloques duplicados en if-elseDos bloques de código muy similares dentro de una condición (if), que se pueden evitar reestructurando el código

Diseño pobre ▶

Aborda el código innecesariamente complejo debido a elecciones de diseño deficientes, ya que un código bien diseñado facilita su lectura y comprensión. Cualquier mejora en esta categoría requiere modificar el código de forma no trivial, sin alterar su comportamiento.

Variable global innecesariaVariable que se define a nivel global y se usa solamente en una función

Línea muy largaLa línea tiene 80 o más caracteres

Función difícil de leerLa función tiene demasiados comandos compuestos anidados, cambios de flujo de control u operadores lógicos

Múltiples returnsLa función tiene más de un return en su cuerpo

Orden de variables inconsistenteFunciones que reciben o retornan exactamente las mismas variables pero en distinto orden

Script largoMás de 20 sentencias en el cuerpo principal (afuera de funciones)

Función largaFunción con más de 20 líneas (incluyendo líneas en blanco)

Lógica compleja en variableOcurre cuando se guarda el resultado de evaluar múltiples expresiones booleanas (usando and, or, >, <, etc.) en una variable local (variable explicativa) para luego utilizarla en una estructura de control de flujo (if, while, return, etc.)

03 /

Ejecutar análisis

04 /

Hallazgos