«Private» (реализация) класса в Python

Question

Я кодирования небольшой модуль Python, состоящий из двух частей:

• некоторые функции, определяющие общий интерфейс,
• класс реализации, используемый выше функций, но что не имеет смысла вне модуля.

Сначала я решил «скрыть» этот класс реализации, определив его внутри используемой функции, но это затрудняет читаемость и не может использоваться, если несколько функций повторно используют один и тот же класс.

Итак, в дополнение к комментариям и docstrings, есть ли механизм для обозначения класса как «частного» или «внутреннего»? Я знаю механизм подчеркивания, но, как я понимаю, он применяется только к именам переменных, функций и методов.

Answer 1

Используйте один подчеркивание префикс:

class _Internal: 
    ... 

Это официальная конвенция Python для 'внутренних' символов; «from module import *» не импортирует объекты с префиксами с подчеркиванием.

Edit: Ссылка на single underscore convention

Answer 2

Конвенция добавляет «_» к внутренним классам, функциям и переменным.

Answer 3

Определение __all__, список имен, которые вы хотите экспортировать (see documentation).

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

Answer 4

Шаблон, который я иногда использую это:

Определение класса:

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

Создать экземпляр класса, переписав имя класса:

x = x() 

Определите символы, которые раскрывают функциональные возможности:

doThis = x.doThis 
doThat = x.doThat 

Удалить экземпляру себя:

del x 

Теперь у вас есть модуль, который только выставляет свои общественные функции.

Answer 5

Используйте два символа подчеркивания для префикса имен «частных» идентификаторов. Для классов в модуле используйте один знак подчеркивания, и они не будут импортироваться с помощью «из импорта модуля».

class _MyInternalClass: 
    def __my_private_method: 
     pass 

(Там нет такого понятия, как истинный «частный» в Python. Например, Python просто автоматически искажает имена членов класса с двойным подчеркиванием быть __clssname_mymember. Так что на самом деле, если вы знаете искаженное имя, которое вы может использовать «частную» сущность в любом случае. See here. И, конечно, вы можете вручную импортировать «внутренние» классы, если хотите).

Answer 6

Чтобы решить проблему соглашений о дизайне, и, как сказал Кристофер, в Python действительно нет такой вещи, как «частный». Это может звучать круто для кого-то, исходящего из фона C/C++ (например, меня некоторое время назад), но в конце концов вы, вероятно, поймете, что следующие соглашения достаточно.

Увидеть что-то с подчеркиванием спереди должно быть достаточно хорошим намеком, чтобы не использовать его напрямую. Если вы заинтересованы в загромождении вывода help(MyClass) (на что все смотрят при поиске того, как использовать класс), подчеркнутые атрибуты/классы там не включаются, так что в итоге вы просто получите свой «общедоступный» интерфейс ,

Плюс, наличие у всех публики собственных впечатляющих привилегий, например, вы можете полностью тестировать что-либо извне (что вы не можете делать с частными конструкциями C/C++).

Answer 7

Короче:

1. Вы не можете применять частную. В Python нет частных классов/методов/функций. По крайней мере, не строгая конфиденциальность, как на других языках, таких как Java.

2. Вы можете указать или предложить конфиденциальность. Это следует за конвенцией. Соглашение python для маркировки класса/функции/метода как частного заключается в предисловии к нему с помощью символа _ (подчеркивание). Например, def _myfunc() или class _MyClass:. Вы также можете создать псевдо-конфиденциальность, предварительно используя метод с двумя символами подчеркивания (например: __foo). Вы не можете напрямую обращаться к этому методу, но вы все равно можете вызвать его через специальный префикс, используя имя класса (например: _classname__foo). Поэтому лучшее, что вы можете сделать, это указать/предложить конфиденциальность, а не обеспечивать ее соблюдение.

Python подобен perl в этом отношении. Перефразируя известную строку о конфиденциальности из книги Perl, философия состоит в том, что вы должны оставаться в гостиной, потому что вас не пригласили не потому, что она защищена дробовиком.

Для получения дополнительной информации:

• Private variablesPython Documentation
• Private functionsПогружение в Python, Марк Пилгрим
• Why are Python’s ‘private’ methods not actually private?StackOverflow вопрос 70528