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

Improve methods order

Offen
#44 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement good first issue
Vorherrschende Sprache
Python
Sterne
8
Forks
4
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
1

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.