Qual è un buon modo per ordinare i metodi in una classe Python?

Voglio ordinare i metodi in una classe Python ma non so qual è l'ordine corretto.

Quando estraggo metodi in Eclipse con PyDev, Eclipse inserisce il metodo estratto sopra il metodo modificato. Ma questo mette i dettagli di livello inferiore prima dei dettagli di livello superiore. Secondo lo zio Bob dovrei fare l'opposto in modo che il mio codice si legga come i titoli di un giornale. Quando programma Java seguo semplicemente i suoi consigli.

Qual è la migliore pratica per Python?

Come altri hanno sottolineato, non esiste un modo giusto per ordinare i tuoi metodi. Forse un suggerimento PEP sarebbe utile, ma comunque. Vorrei provare ad affrontare la tua domanda nel modo più obiettivo possibile.

• Prima le interfacce: i metodi pubblici e le funzioni magiche di Python definiscono l'interfaccia della classe. La maggior parte delle volte, tu e altri sviluppatori desiderate utilizzare una classe anziché modificarla. Quindi saranno interessati all'interfaccia di quella classe. Metterlo al primo posto nel codice sorgente evita di scorrere i dettagli di implementazione che non ti interessano.

• Proprietà, metodi magici , metodi pubblici: è difficile definire l'ordine migliore tra questi tre, che fanno tutti parte dell'interfaccia della classe. Come dice @EthanFurman, è molto importante attenersi a un sistema per l'intero progetto. In generale, le persone si aspettano __init__()la migliore prima funzione della classe, quindi proseguo con gli altri metodi magici proprio sotto.

• Ordine di lettura: fondamentalmente, ci sono due modi per raccontare una storia: dal basso verso l'alto o dall'alto verso il basso. Mettendo al primo posto le funzioni di alto livello, uno sviluppatore può ottenere una comprensione approssimativa della classe leggendo le prime due righe. Altrimenti, si dovrebbe leggere l'intera classe per avere una comprensione della classe e la maggior parte degli sviluppatori non ha il tempo per questo. Come regola pratica, metti i metodi sopra tutti i metodi chiamati dal loro corpo.

• Metodi di classe e metodi statici: di solito, questo è implicito nell'ordine di lettura spiegato sopra. I metodi normali possono chiamare tutti i metodi volte e quindi vengono prima. I metodi di classe possono chiamare solo metodi di classe e metodi statici e vengono dopo. I metodi statici non possono chiamare altri metodi della classe e sono ultimi.

Spero che sia di aiuto. La maggior parte di queste regole non sono specifiche di Python, comunque. Non sono a conoscenza di un linguaggio che imponga l'ordine dei metodi, ma in tal caso sarebbe piuttosto interessante e per favore commenta.

Non esiste un ordine corretto. Scegli un sistema e seguilo. Quello che uso è:

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"

Faccio qualcosa di simile a @Ethan che ho visto nel sorgente di Django, dove la differenza principale è il grande "############" blocco dei commenti per delimitare le aree. Per esempio,

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"

Ovviamente questo è meno utile per le classi più piccole.