Variabili di istanza e variabili di classe in Python

Ho classi Python, di cui ho bisogno solo di un'istanza in fase di esecuzione, quindi sarebbe sufficiente avere gli attributi solo una volta per classe e non per istanza. Se ci fosse più di un'istanza (cosa che non accadrà), tutte le istanze dovrebbero avere la stessa configurazione. Mi chiedo quale delle seguenti opzioni sarebbe Python migliore o più "idiomatica".

Variabili di classe:

class MyController(Controller):

  path = "something/"
  children = [AController, BController]

  def action(self, request):
    pass

Variabili di istanza:

class MyController(Controller):

  def __init__(self):
    self.path = "something/"
    self.children = [AController, BController]

  def action(self, request):
    pass

Se hai comunque una sola istanza, è meglio creare tutte le variabili per istanza, semplicemente perché vi si accederà (un po ') più velocemente (un livello in meno di "ricerca" a causa dell' "ereditarietà" da classe a istanza), e non ci sono aspetti negativi da pesare contro questo piccolo vantaggio.

Facendo eco ai consigli di Mike e Alex e aggiungendo il mio colore ...

L'uso degli attributi di istanza è il tipico ... il più idiomatico Python. Gli attributi di classe non vengono utilizzati molto, poiché i loro casi d'uso sono specifici. Lo stesso vale per i metodi statici e di classe rispetto ai metodi "normali". Sono costrutti speciali che affrontano casi d'uso specifici, altrimenti è codice creato da un programmatore aberrante che vuole mostrare di conoscere qualche angolo oscuro della programmazione Python.

Alex menziona nella sua risposta che l'accesso sarà (un po ') più veloce a causa di un livello di ricerca in meno ... lasciatemi chiarire ulteriormente per coloro che non sanno ancora come funziona. È molto simile all'accesso alle variabili, il cui ordine di ricerca è:

1. gente del posto
2. nonlocals
3. globali
4. built-in

Per l'accesso agli attributi, l'ordine è:

1. esempio
2. classe
3. classi di base come determinato dall'MRO (ordine di risoluzione del metodo)

Entrambe le tecniche funzionano in modo "rovesciato", il che significa che gli oggetti più locali vengono controllati prima, quindi gli strati esterni vengono controllati in successione.

Nel tuo esempio sopra, diciamo che stai cercando l' pathattributo. Quando incontra un riferimento come " self.path", Python cerca prima gli attributi dell'istanza per una corrispondenza. Quando fallisce, controlla la classe da cui è stata creata l'istanza dell'oggetto. Infine, cercherà le classi di base. Come ha affermato Alex, se il tuo attributo si trova nell'istanza, non ha bisogno di cercare altrove, da qui il tuo piccolo risparmio di tempo.

Tuttavia, se insisti sugli attributi di classe, hai bisogno di quella ricerca extra. Oppure , l'altra alternativa è fare riferimento all'oggetto tramite la classe anziché l'istanza, ad esempio MyController.pathinvece di self.path. Questa è una ricerca diretta che aggira la ricerca differita, ma come alex menziona di seguito ,èuna variabile globale, quindi perdi quel bit che pensavi di salvare (a meno che tu non crei un riferimento locale al nome della classe [globale] ).

La conclusione è che dovresti usare gli attributi di istanza la maggior parte del tempo. Tuttavia, ci saranno occasioni in cui un attributo di classe è lo strumento giusto per il lavoro. Il codice che utilizza entrambi allo stesso tempo richiederà la massima diligenza, perché l'utilizzo selfti darà solo l'oggetto dell'attributo di istanza e l' accesso alle ombre all'attributo di classe con lo stesso nome. In questo caso, è necessario utilizzare l'accesso all'attributo dal nome della classe per fare riferimento ad esso.

In caso di dubbio, probabilmente desideri un attributo di istanza.

Gli attributi di classe sono riservati al meglio per casi speciali in cui hanno senso. L'unico caso d'uso molto comune sono i metodi. Non è raro utilizzare attributi di classe per costanti di sola lettura che le istanze devono conoscere (sebbene l'unico vantaggio di questo sia se si desidera l'accesso anche dall'esterno della classe), ma dovresti certamente essere cauto nel memorizzare qualsiasi stato in esse , che raramente è quello che vuoi. Anche se avrai solo un'istanza, dovresti scrivere la classe come faresti con qualsiasi altra, il che di solito significa usare attributi di istanza.

Stessa domanda su Performance of accessing class variables in Python - il codice qui adattato da @Edward Loper

Le variabili locali sono le più veloci da accedere, più o meno legate alle variabili del modulo, seguite dalle variabili di classe, seguite dalle variabili di istanza.

Sono disponibili 4 ambiti da cui è possibile accedere alle variabili:

1. Variabili di istanza (self.varname)
2. Variabili di classe (Classname.varname)
3. Variabili del modulo (VARNAME)
4. Variabili locali (varname)

Il test:

import timeit

setup='''
XGLOBAL= 5
class A:
    xclass = 5
    def __init__(self):
        self.xinstance = 5
    def f1(self):
        xlocal = 5
        x = self.xinstance
    def f2(self):
        xlocal = 5
        x = A.xclass
    def f3(self):
        xlocal = 5
        x = XGLOBAL
    def f4(self):
        xlocal = 5
        x = xlocal
a = A()
'''
print('access via instance variable: %.3f' % timeit.timeit('a.f1()', setup=setup, number=300000000) )
print('access via class variable: %.3f' % timeit.timeit('a.f2()', setup=setup, number=300000000) )
print('access via module variable: %.3f' % timeit.timeit('a.f3()', setup=setup, number=300000000) )
print('access via local variable: %.3f' % timeit.timeit('a.f4()', setup=setup, number=300000000) )

Il risultato:

access via instance variable: 93.456
access via class variable: 82.169
access via module variable: 72.634
access via local variable: 72.199