Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Improve methods order

Đang mở
  • Có gì không ổn?
#44 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

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

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.

Mô tả

enhancement good first issue

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 initial order was first mentioned in this comment, and after a discussion with @christoph-hamm, we decided this should be the final order:

  1. Class-level attributes
  2. Constructor (__init__)
  3. Alternative constructors (usually some class methods)
  4. Magic methods like __str__, __len__, __del__ etc.
  5. Property methods
  6. The rest of the methods (public, private, static, class which are not ctor) (mixed together, following the "caller before the callee" rule)

The order should also be added to the DEVELOPMENT.md file, so that it's clear for future development of the SDK.

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
Ngôn ngữ chính
Python
Star
8
Fork
4
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của eclipse-ankaios/ank-sdk-python

Tất cả issue của eclipse-ankaios/ank-sdk-python

Issue tương tự

Thêm issue về Python

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.