eclipse-ankaios / eclipse-ankaios/ank-sdk-python

Improve methods order

Aperta
#44 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement good first issue
Lingua principale
Python
Stelle
8
Fork
4
Merge medio
2g 3h
PR unite (30g)
1

Descrizione

## 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.