Classe "Private" (implementazione) in Python

Sto codificando un piccolo modulo Python composto da due parti:

• alcune funzioni che definiscono un'interfaccia pubblica,
• una classe di implementazione utilizzata dalle funzioni precedenti, ma che non è significativa al di fuori del modulo.

All'inizio, ho deciso di "nascondere" questa classe di implementazione definendola all'interno della funzione che la utilizza, ma questo ostacola la leggibilità e non può essere utilizzata se più funzioni riutilizzano la stessa classe.

Quindi, oltre ai commenti e alle docstring, esiste un meccanismo per contrassegnare una classe come "privata" o "interna"? Sono a conoscenza del meccanismo di sottolineatura, ma a quanto ho capito si applica solo alle variabili, alla funzione e al nome dei metodi.

Utilizza un unico prefisso di sottolineatura:

class _Internal:
    ...

Questa è la convenzione ufficiale di Python per i simboli "interni"; "from module import *" non importa oggetti con prefisso di sottolineatura.

Modifica: riferimento alla convenzione di sottolineatura singola

In breve:

1. Non puoi far rispettare la privacy . Non ci sono classi / metodi / funzioni private in Python. Almeno, non una privacy rigorosa come in altri linguaggi, come Java.

2. Puoi solo indicare / suggerire privacy . Questo segue una convenzione. La convenzione di Python per contrassegnare una classe / funzione / metodo come privata è di farla precedere da un _ (trattino basso). Ad esempio, def _myfunc()o class _MyClass:. Puoi anche creare una pseudo-privacy anteponendo al metodo due trattini bassi (ad esempio:) __foo. Non è possibile accedere direttamente al metodo, ma è comunque possibile chiamarlo tramite un prefisso speciale utilizzando il nome della classe (ad esempio:) _classname__foo. Quindi il meglio che puoi fare è indicare / suggerire la privacy, non applicarla.

Python è come perl sotto questo aspetto. Parafrasando una famosa frase sulla privacy tratta dal libro Perl, la filosofia è che dovresti stare fuori dal soggiorno perché non sei stato invitato, non perché è difeso con un fucile.

Per maggiori informazioni:

• Documentazione Python per variabili private
• Perché i metodi "privati" di Python non sono effettivamente privati? Domanda StackOverflow 70528

Definire __all__un elenco di nomi che si desidera esportare ( vedere la documentazione ).

__all__ = ['public_class'] # don't add here the 'implementation_class'

Uno schema che a volte uso è questo:

Definisci una classe:

class x(object):
    def doThis(self):
        ...
    def doThat(self):
        ...

Crea un'istanza della classe, sovrascrivendo il nome della classe:

x = x()

Definisci i simboli che espongono la funzionalità:

doThis = x.doThis
doThat = x.doThat

Elimina l'istanza stessa:

del x

Ora hai un modulo che espone solo le tue funzioni pubbliche.

La convenzione è anteposta "_" a classi, funzioni e variabili interne.

Per affrontare la questione delle convenzioni di progettazione, e come ha detto Christopher, non esiste davvero qualcosa come "privato" in Python. Questo può sembrare strano per qualcuno che proviene da un background C / C ++ (come me qualche tempo fa), ma alla fine, probabilmente ti renderai conto che seguire le convenzioni è abbastanza.

Vedere qualcosa con un carattere di sottolineatura davanti dovrebbe essere un buon suggerimento per non usarlo direttamente. Se sei preoccupato per l' help(MyClass)output disordinato (che è ciò che tutti guardano quando cercano come usare una classe), gli attributi / classi sottolineati non sono inclusi lì, quindi finirai per avere solo la tua interfaccia "pubblica" descritta.

Inoltre, avere tutto ciò che è pubblico ha i suoi fantastici vantaggi, come ad esempio, puoi testare praticamente qualsiasi cosa dall'esterno (cosa che non puoi fare con i costrutti privati ​​C / C ++).

Utilizza due caratteri di sottolineatura come prefisso ai nomi degli identificatori "privati". Per le classi in un modulo, utilizzare un singolo trattino basso iniziale e non verranno importate utilizzando "from module import *".

class _MyInternalClass:
    def __my_private_method:
        pass

(Non esiste un vero "privato" in Python. Per esempio, Python manipola automaticamente i nomi dei membri della classe con doppi trattini bassi per essere __clssname_mymember. Quindi, in realtà, se conosci il nome alterato puoi comunque usare l'entità "privato" . Vedi qui. E, naturalmente, è possibile scegliere di importare manualmente classi "interni" se si voleva).