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

Improve methods order

Đang mở
#44 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement good first issue
Ngôn ngữ chính
Python
Star
8
Fork
4
Merge trung bình
2 ngày 3 giờ
Pull request đã merge (30 ngày)
1

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách lập danh mục các lớp SDK và thứ tự hiện tại của các phương thức trong đó, sau đó kiểm tra các phương thức kiểm thử đơn vị để xác định xem chúng có phản ánh phần triển khai hay không. Trao đổi về trường hợp sử dụng và workflow dự kiến với các committers trước khi thay đổi bất cứ điều gì. Công việc được coi là hoàn tất khi các phương thức SDK tuân theo quy ước sắp xếp gồm sáu phần; các kiểm thử đơn vị có thể được sắp xếp lại tùy chọn để khớp với phần triển khai.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
backend-api-design
Loại issue
Tái cấu trúc
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.