Cách tốt để sắp xếp các phương thức trong một lớp Python là gì?

Tôi muốn sắp xếp thứ tự các phương thức trong một lớp Python nhưng tôi không biết đâu là thứ tự chính xác.

Khi tôi trích xuất các phương thức trong Eclipse bằng PyDev, Eclipse đặt phương thức được trích xuất lên trên phương thức đã sửa đổi. Nhưng điều này đặt các chi tiết cấp thấp hơn trước các chi tiết cấp cao hơn. Theo chú Bob, tôi nên làm ngược lại để mã của tôi đọc giống như tiêu đề của một tờ báo. Khi tôi lập trình Java, tôi chỉ làm theo lời khuyên của anh ấy.

Thực hành tốt nhất cho Python là gì?

Như những người khác đã chỉ ra, không có cách nào đúng để sắp xếp các phương pháp của bạn. Có thể một gợi ý PEP sẽ hữu ích, nhưng dù sao. Hãy để tôi cố gắng tiếp cận câu hỏi của bạn một cách khách quan nhất có thể.

• Giao diện đầu tiên: Các phương thức công khai và hàm ma thuật Python xác định giao diện của lớp. Hầu hết thời gian, bạn và các nhà phát triển khác muốn sử dụng một lớp hơn là thay đổi nó. Như vậy họ sẽ quan tâm đến giao diện của lớp đó. Đặt nó đầu tiên trong mã nguồn tránh việc cuộn qua các chi tiết triển khai mà bạn không quan tâm.

• Thuộc tính, phương thức ma thuật , phương thức công khai: Thật khó để xác định thứ tự tốt nhất giữa ba thứ đó, tất cả đều là một phần của giao diện của lớp. Như @EthanFurman nói, điều quan trọng nhất là gắn bó với một hệ thống cho toàn bộ dự án. Nói chung, mọi người mong đợi __init__()hàm đầu tiên tốt nhất trong lớp, vì vậy tôi theo dõi các phương pháp ảo thuật khác ngay bên dưới.

• Thứ tự đọc: Về cơ bản, có hai cách để kể một câu chuyện: Từ dưới lên hoặc từ trên xuống. Bằng cách đặt các chức năng cấp cao lên hàng đầu, một nhà phát triển có thể hiểu sơ bộ về lớp bằng cách đọc vài dòng đầu tiên. Nếu không, người ta sẽ phải đọc toàn bộ lớp học để có được bất kỳ sự hiểu biết nào về lớp học và hầu hết các nhà phát triển không có thời gian cho việc đó. Theo quy tắc chung, hãy đặt các phương thức lên trên tất cả các phương pháp được gọi từ cơ thể của chúng.

• Phương thức lớp và phương thức tĩnh: Thông thường, điều này được ngụ ý bởi thứ tự đọc được giải thích ở trên. Các phương thức thông thường có thể gọi tất cả các phương thức lần và do đó đến trước. Phương thức lớp chỉ có thể gọi phương thức lớp và phương thức tĩnh và đến tiếp theo. Các phương thức static không thể gọi các phương thức khác của lớp và đến sau cùng.

Hi vọng điêu nay co ich. Hầu hết các quy tắc này không dành riêng cho Python. Tôi không biết về một ngôn ngữ thực thi thứ tự phương thức nhưng nếu vậy, nó sẽ khá thú vị và vui lòng bình luận.

Không có một thứ tự chính xác. Chọn một hệ thống và gắn bó với nó. Một trong những tôi sử dụng là:

class SomeClass(object):
    def __magic_methods__(self):
        "magic methods first, usually in alphabetical order"
    def _private_method(self):
        "worker methods next, also in alpha order"
    def a_method(self):
        "then normal methods, also in alpha order"

Tôi làm điều gì đó tương tự như @Ethan mà tôi đã thấy trong nguồn của Django, trong đó sự khác biệt chính là "#############" chặn nhận xét để phân định các khu vực. Ví dụ,

class SomeClass(object):
    #################
    # Magic Methods #
    #################
    def __magic_methods__(self):
        "magic methods first"

    ##################
    # Public Methods #
    ##################
    def a_method(self):
        "then normal methods, in order of importance"

    ###################
    # Private Methods #
    ###################
    def _private_method(self):
        "then worker methods, grouped by importance or related function"

Rõ ràng là điều này ít hữu ích hơn cho các lớp nhỏ hơn.