"Приватний" (впроваджувальний) клас у Python

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

• деякі функції, що визначають загальнодоступний інтерфейс,
• клас реалізації, який використовується вищевказаними функціями, але який не має сенсу поза модулем.

Спочатку я вирішив "приховати" цей клас реалізації, визначивши його всередині функції, що використовує його, але це перешкоджає читанню і не може бути використане, якщо кілька функцій повторно використовують один і той же клас.

Отже, окрім коментарів та доктринжів, чи існує механізм для позначення класу як "приватного" чи "внутрішнього"? Мені відомо про механізм підкреслення, але, як я розумію, це стосується лише змінних, функцій та назв методів.

Використовуйте один префікс підкреслення:

class _Internal:
    ...

Це офіційна конвенція Python щодо "внутрішніх" символів; "з імпорту модуля *" не імпортує підкреслені об'єкти з підкресленням.

Редагувати: Посилання на єдину умову підкреслення

Коротко:

1. Ви не можете застосовувати конфіденційність . У Python немає приватних класів / методів / функцій. Принаймні, не сувора конфіденційність, як в інших мовах, таких як Java.

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

У цьому відношенні Python як Perl. Якщо перефразовувати відомий рядок про конфіденційність книги Perl, філософія полягає в тому, що вам слід залишатися поза вітальнею, оскільки вас не запросили, не тому, що її захищають рушницею.

Для отримання додаткової інформації:

• Приватні змінні Python Documentation
• Чому "приватні" методи Python насправді не є приватними? Питання StackOverflow 70528

Визначте __all__, список імен, які потрібно експортувати ( див. Документацію ).

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

Модель, яку я іноді використовую, така:

Визначте клас:

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

Створіть екземпляр класу, замінивши ім'я класу:

x = x()

Визначте символи, які розкривають функціонал:

doThis = x.doThis
doThat = x.doThat

Видаліть сам екземпляр:

del x

Тепер у вас є модуль, який розкриває лише ваші загальнодоступні функції.

Конвенція є "_" до внутрішніх класів, функцій та змінних.

Щоб вирішити питання дизайнерських конвенцій, і, як сказав Крістофер, насправді у Python не існує такого поняття, як "приватне". Це може здатися викривленим для когось із походження C / C ++ (як, наприклад, я назад), але, зрештою, ви, мабуть, зрозумієте, що наступних умов буде достатньо.

Бачити щось, що має підкреслення попереду, повинно бути досить хорошим підказом, щоб не використовувати його безпосередньо. Якщо ви переймаєтеся тим, що перебуває у зв'язку із завантаженням help(MyClass)результатів (на що звертаються всі, шукаючи, як використовувати клас), атрибути / класи, що підкреслюються, туди не входять, тож у вас описується лише "загальнодоступний" інтерфейс.

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

Використовуйте дві підкреслення для префіксації імен "приватних" ідентифікаторів. Для класів в модулі використовуйте єдине провідне підкреслення, і вони не будуть імпортовані за допомогою "з імпорту модуля *".

class _MyInternalClass:
    def __my_private_method:
        pass

(У Python не існує такого поняття, як справжній "приватний". Наприклад, Python автоматично автоматично маніпулює імена членів класу з подвійними підкресленнями __clssname_mymember. Так що справді, якщо ви знаєте зловмисне ім'я, то в будь-якому випадку можете використовувати "приватне" об'єднання . Дивіться тут. І, звичайно , ви можете вручну імпортувати «внутрішні» класи , якщо ви хочете).