Rewrite the code using objects and methods

Abierto
  • ¿Algo no está bien?
#38 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
ci-cd

Línea de trabajo

No se indica ninguna ruta de archivo ni de prueba; empieza por localizar el bucle que recorre los archivos JSON y el punto de entrada count_bucketed_by_test. Traza cómo se inicializa y modifica cada estructura de bucketing y, después, refactoriza ese flujo alrededor de objetos y métodos, preservando el comportamiento de bucketing existente y mejorando la facilidad de prueba.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The Ciclops code is conceptually simple, but syntactically muddled.
There is a for loop over all the JSON files produced by running a test suite.
Each of these files is bucketed by different criteria. E.g. by kubernetes version, or by test name.

Because it was not written in an object-based way, the code requires to pass and modify data structures by reference.
Those structures need to be initialized outside the code that uses them, like so.

    by_test = {}
    ...
    for file in dir_listing:
        ...
        with open(path, encoding="utf-8") as json_file:
            ...
            # bucketing by test name
            count_bucketed_by_test(test_results, by_test)

By rewriting the code in an object-based way, the data structures can be created and added to by methods, with more compact code. This will also improve the testability of the code.

Lenguaje dominante
Python
Estrellas
16
Forks
0
Merge medio
6 h 59 min
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de cloudnative-pg/ciclops

Todos los issues de cloudnative-pg/ciclops

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.