{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Что трогать снаружи: _ и __\n",
"\n",
"Публичный интерфейс класса и внутренние атрибуты с подчёркиванием. Изменение состояния через методы с проверками и искажение имён у __x.\n",
"\n",
"Курс ООП в Python · урок `oop-naming` · [урок на сайте](https://ds-edu-trainer.vercel.app/courses/oop/naming).\n",
"\n",
"Выполняйте ячейки по порядку (Shift+Enter), начиная с первой — она готовит урок. После каждого упражнения идёт\n",
"ячейка проверки: она печатает ✓ / ✗ и итог."
],
"id": "intro"
},
{
"cell_type": "code",
"metadata": {
"cellView": "form",
"jupyter": {
"source_hidden": true
}
},
"source": [
"# @title Подготовка урока — выполните эту ячейку первой\n",
"# Проверяет версии пакетов, записывает файлы данных в папку data/ и определяет _check — проверку упражнений.\n",
"import base64, os, zlib\n",
"\n",
"import sys\n",
"\n",
"if sys.version_info < (3, 10):\n",
" print(f\"Урок написан для Python 3.10 и новее, у вас {sys.version.split()[0]} — часть кода может не работать\")\n",
"\n",
"# ─── Проверка упражнений: тот же раннер, что у задач на сайте ───\n",
"# ─── Запуск тестов ───────────────────────────────────────────────────────────\n",
"\n",
"_TIMEOUT = 2.0 # секунд на тест; отдельный тест может задать свой: test_x.timeout = 10\n",
"\n",
"\n",
"def _call_with_timeout(target, seconds: float) -> bool:\n",
" \"\"\"Запускает target() в отдельном потоке. Возвращает False, если за seconds он не завершился.\"\"\"\n",
" import sys\n",
" import threading\n",
"\n",
" if sys.platform == \"emscripten\": # Python в браузере: потоков нет, таймаут обеспечивает страница\n",
" target()\n",
" return True\n",
" # Большой стек нужен, чтобы глубокая рекурсия давала RecursionError, а не аварийное завершение Python.\n",
" for megabytes in (256, 64, 0):\n",
" try:\n",
" threading.stack_size(megabytes * 1024 * 1024)\n",
" worker = threading.Thread(target=target, daemon=True)\n",
" worker.start()\n",
" except (ValueError, RuntimeError, MemoryError):\n",
" continue\n",
" worker.join(seconds)\n",
" return not worker.is_alive()\n",
" target() # потоки недоступны — запускаем без таймаута\n",
" return True\n",
"\n",
"\n",
"def _test_info(fn) -> dict:\n",
" \"\"\"Описание теста, его лимит времени и сообщение на случай зависания.\"\"\"\n",
" limit = getattr(fn, \"timeout\", _TIMEOUT)\n",
" hint = getattr(fn, \"timeout_hint\", \"\")\n",
" message = (\n",
" f\"тест не завершился за {limit:g} с — возможно, бесконечный цикл или рекурсия: \"\n",
" \"проверьте, что границы/аргументы изменяются на каждом шаге\" + (f\". {hint}\" if hint else \"\")\n",
" )\n",
" return {\"title\": (fn.__doc__ or fn.__name__).strip(), \"timeout\": limit, \"timeout_message\": message}\n",
"\n",
"\n",
"def _error_result(title: str, error: BaseException, user_file: str | None) -> dict:\n",
" \"\"\"Результат упавшего теста: статус, сообщение, тип исключения и строка в коде решения.\"\"\"\n",
" line = None\n",
" if user_file: # самый глубокий кадр в коде решения; ошибка внутри самих тестов — без номера строки\n",
" tb = error.__traceback__\n",
" while tb is not None:\n",
" if tb.tb_frame.f_code.co_filename == user_file:\n",
" line = tb.tb_lineno\n",
" tb = tb.tb_next\n",
" status, message = \"error\", f\"{type(error).__name__}: {error}\"\n",
" if isinstance(error, NotImplementedError):\n",
" status, message, line = \"not_written\", \"функция ещё не написана\", None\n",
" elif isinstance(error, AssertionError):\n",
" status, message = \"failed\", str(error) or \"проверка не прошла\"\n",
" elif isinstance(error, RecursionError):\n",
" message = \"RecursionError: слишком глубокая рекурсия — проверьте базовый случай и то, что задача уменьшается\"\n",
" elif isinstance(error, MemoryError) or (isinstance(error, OverflowError) and \"index-sized\" in str(error)):\n",
" message = f\"{type(error).__name__}: не хватило памяти — возможно, создаётся слишком большая структура данных\"\n",
" return {\"title\": title, \"status\": status, \"message\": message, \"error_type\": type(error).__name__, \"line\": line}\n",
"\n",
"\n",
"def _run_tests(verbose: bool = True, on_start=None, on_result=None, user_file: str | None = None) -> list[dict]:\n",
" \"\"\"Запускает тесты задачи (_TESTS — функции из tests.py) по порядку, каждый — с таймаутом.\n",
"\n",
" Возвращает список результатов: {\"title\", \"status\", \"message\", \"error_type\", \"line\"}, где status —\n",
" passed · failed · error · not_written · timeout · not_run. Если тест завис, при verbose=True печатает\n",
" итог и завершает процесс: зависший поток остановить нельзя. on_start(i) и on_result(i, результат)\n",
" вызываются по мере выполнения; user_file — имя файла с кодом решения для номеров строк в ошибках.\n",
" \"\"\"\n",
" import os\n",
" import sys\n",
"\n",
" if verbose:\n",
" try: # ✓ и кириллица в консоли Windows со старой кодировкой\n",
" sys.stdout.reconfigure(encoding=\"utf-8\")\n",
" except Exception: # noqa: BLE001 — reconfigure может не быть (перенаправленный вывод, браузер)\n",
" pass\n",
"\n",
" tests = list(_TESTS)\n",
" results: list[dict] = []\n",
" not_written = hung = False\n",
" for index, fn in enumerate(tests):\n",
" info = _test_info(fn)\n",
" outcome: dict = {}\n",
"\n",
" def target(fn=fn, outcome=outcome):\n",
" try:\n",
" fn()\n",
" except BaseException as e:\n",
" outcome[\"error\"] = e\n",
"\n",
" if on_start:\n",
" on_start(index)\n",
" if not _call_with_timeout(target, info[\"timeout\"]):\n",
" results.append({\"title\": info[\"title\"], \"status\": \"timeout\", \"message\": info[\"timeout_message\"], \"error_type\": None, \"line\": None})\n",
" for other in tests[index + 1:]:\n",
" results.append({\"title\": _test_info(other)[\"title\"], \"status\": \"not_run\", \"message\": \"не запускался: предыдущий тест завис\", \"error_type\": None, \"line\": None})\n",
" hung = True\n",
" break\n",
" error = outcome.get(\"error\")\n",
" if error is None:\n",
" result = {\"title\": info[\"title\"], \"status\": \"passed\", \"message\": \"\", \"error_type\": None, \"line\": None}\n",
" else:\n",
" result = _error_result(info[\"title\"], error, user_file)\n",
" not_written = not_written or result[\"status\"] == \"not_written\"\n",
" results.append(result)\n",
" if on_result:\n",
" on_result(index, result)\n",
"\n",
" if not_written: # пока функция не написана, «даром» пройденные тесты не засчитываются\n",
" for r in results:\n",
" if r[\"status\"] == \"passed\":\n",
" r.update(status=\"not_written\", message=\"не засчитан, пока функция не написана\")\n",
" for r in results:\n",
" if len(r[\"message\"]) > 300:\n",
" r[\"message\"] = r[\"message\"][:300] + \"…\"\n",
"\n",
" if verbose:\n",
" if not_written:\n",
" print(\"Функция ещё не написана — замените raise NotImplementedError своим кодом.\\n\")\n",
" for r in results:\n",
" mark = {\"passed\": \"✓\", \"not_run\": \"–\"}.get(r[\"status\"], \"✗\")\n",
" print(f\"{mark} {r['title']}\")\n",
" if r[\"message\"]:\n",
" print(f\" {r['message']}\")\n",
" passed = sum(r[\"status\"] == \"passed\" for r in results)\n",
" print(\"─\" * 40)\n",
" print(f\"Прошло {passed} из {len(results)}\" + (\" — всё верно!\" if passed == len(results) else \"\"))\n",
" if hung:\n",
" print(\"Выполнение остановлено: один из тестов завис.\")\n",
" sys.stdout.flush()\n",
" os._exit(1)\n",
" return results\n",
"\n",
"\n",
"def _check(*tests, names=()):\n",
" \"\"\"Запускает проверки упражнения и печатает ✓ / ✗ и итог — как на сайте.\"\"\"\n",
" for name in names:\n",
" if \".\" in name: # «Класс.метод» из заготовки: класс должен быть объявлен\n",
" if not isinstance(globals().get(name.split(\".\")[0]), type):\n",
" print(f\"✗ класс {name.split('.')[0]} не объявлен — выполните ячейку упражнения\")\n",
" return\n",
" continue\n",
" if name not in globals():\n",
" print(f\"✗ переменная {name} не создана — выполните ячейку упражнения\")\n",
" return\n",
" if globals()[name] is Ellipsis:\n",
" print(f\"✗ {name} пока равна ... — замените многоточие своим кодом\")\n",
" return\n",
" globals()[\"_TESTS\"] = list(tests)\n",
" _run_tests()"
],
"execution_count": null,
"outputs": [],
"id": "setup"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Атрибут, который можно свободно менять снаружи, легко испортить: подарочной карте записать отрицательный\n",
"баланс, заказу — несуществующий статус. Объект не может защитить себя, если любой код пишет в его атрибуты\n",
"что угодно. Решение называется **инкапсуляция** (encapsulation): объект прячет своё внутреннее состояние и\n",
"даёт менять его только через свои методы — а методы проверяют, что изменение допустимо.\n",
"\n",
"## Публичный интерфейс и внутренние атрибуты\n",
"\n",
"Методы и атрибуты, которыми пользуются снаружи, образуют **публичный интерфейс** класса (public API).\n",
"Всё остальное — внутреннее устройство. В Python нет закрытых атрибутов, как `private` в Java или C++, — есть\n",
"соглашение: имя, которое начинается с подчёркивания, — **внутренний атрибут** (internal attribute). Его можно прочитать и\n",
"изменить, но код снаружи так не делает: это детали, которые автор класса вправе поменять."
],
"id": "text-9"
},
{
"cell_type": "code",
"metadata": {},
"source": [
"# Баланс прячется за методами\n",
"class GiftCard:\n",
" def __init__(self, amount):\n",
" self._balance = amount # внутренний атрибут\n",
"\n",
" def balance(self):\n",
" return self._balance\n",
"\n",
" def pay(self, amount):\n",
" if amount > self._balance:\n",
" return False # денег не хватает — баланс не меняется\n",
" self._balance -= amount\n",
" return True\n",
"\n",
"\n",
"card = GiftCard(500)\n",
"print(card.pay(200), card.balance())\n",
"print(card.pay(400), card.balance())"
],
"execution_count": null,
"outputs": [],
"id": "gift-card"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Снаружи с картой работают только через `balance()` и `pay()`. Метод `pay` проверяет, хватает ли денег, —\n",
"и баланс не уйдёт в минус, пока никто не лезет в `_balance` напрямую."
],
"id": "text-23"
},
{
"cell_type": "code",
"metadata": {},
"source": [
"# Подчёркивание — соглашение, а не запрет\n",
"card._balance = -500 # так можно, но так не делают\n",
"print(card.balance())"
],
"execution_count": null,
"outputs": [],
"id": "underscore"
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Упражнение 1. Пополнение карты\n",
"\n",
"Допишите класс `GiftCard`: у него уже есть `balance()` и `pay(amount)`. Добавьте метод `top_up(amount)`:\n",
"положительную сумму он прибавляет к балансу и возвращает `True`, а ноль и отрицательную сумму не принимает —\n",
"баланс не меняется, метод возвращает `False`.\n",
"\n",
"Подсказка 1
\n",
"\n",
"Если `amount > 0` — `self._balance += amount` и `return True`; иначе — `return False`.\n",
"\n",
"Решение
\n",
"\n",
"```python\n",
"class GiftCard:\n",
" def __init__(self, amount):\n",
" self._balance = amount\n",
"\n",
" def balance(self):\n",
" return self._balance\n",
"\n",
" def pay(self, amount):\n",
" if amount > self._balance:\n",
" return False\n",
" self._balance -= amount\n",
" return True\n",
"\n",
" def top_up(self, amount):\n",
" if amount > 0:\n",
" self._balance += amount\n",
" return True\n",
" return False\n",
"```\n",
"\n",
"Подсказка 1
\n",
"\n",
"`paid = [card.pay(x) for x in orders]`; баланс — `card.balance()`.\n",
"\n",
"Решение
\n",
"\n",
"```python\n",
"card = GiftCard(1000)\n",
"orders = [450, 300, 400, 150]\n",
"paid = [card.pay(x) for x in orders]\n",
"left = card.balance()\n",
"```\n",
"\n",
"Подсказка 1
\n",
"\n",
"В `__init__`: `self.__pin = pin`; внутри класса имя пишется так же — `self.__pin`.\n",
"\n",
"Решение
\n",
"\n",
"```python\n",
"class Terminal:\n",
" def __init__(self, pin):\n",
" self.__pin = pin\n",
"\n",
" def check(self, pin):\n",
" return pin == self.__pin\n",
"```\n",
"\n",
"Ответ
\n",
"\n",
"сработает: Python не запрещает менять атрибуты с подчёркиванием\n",
"\n",
"Подчёркивание — соглашение между программистами, а не замок. Python выполнит присваивание, а все проверки в методах `pay` и `top_up` окажутся бесполезны. Поэтому внутренние атрибуты снаружи не трогают.\n",
"\n",
"