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

Improve methods order

Open
#44 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Python
Stars
8
Forks
4
Avg merge
2d 3h
Merged PRs (30d)
1

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.