eclipse-ankaios / eclipse-ankaios/ank-sdk-python
Improve methods order
- Lenguaje dominante
- Python
- Estrellas
- 8
- Forks
- 4
- Merge medio
- 2 d 3 h
- PR fusionados (30 d)
- 1
Descripción
## Description
The methods of a class should follow an ordering convention. Currently, all the methods are placed by either their usecase or just randomly in the class. The order should be like this:
1. Class-level attributes
2. init()
3. Magic methods like str, len, ...
4. Public instance methods
5. private or protected methods
6. static and class methods
7. cleanup (del)
Comment that mentioned this: https://github.com/eclipse-ankaios/ank-sdk-python/pull/43#discussion_r1867710186
## Goals
The code is refactored and the methods are in a proper order.
## Final result
### Summary
**To be filled when the final solution is sketched.**
### Tasks
- [ ] Reorder the methods in the sdk
- [ ] Optional: Reorder the unit test methods to match the implementation
Guía de contribución
Línea de trabajo
Empieza por hacer un inventario de las clases del SDK y del orden actual de sus métodos; después, inspecciona los métodos de las pruebas unitarias para determinar si reflejan la implementación. Analiza el caso de uso y el flujo de trabajo previstos con los committers antes de cambiar nada. El trabajo estará terminado cuando los métodos del SDK sigan la convención de ordenación en seis partes; las pruebas unitarias se pueden reordenar opcionalmente para que coincidan.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- backend-api-design
- Tipo de issue
- Refactorización
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100