diff --git a/README.md b/README.md index 76d456ac..72dd8ac2 100644 --- a/README.md +++ b/README.md @@ -11,98 +11,20 @@ - [Часть 1. Генератор идентификаторов Twitter Snowflake](src/part1/TASK.md) — нужно написать генератор 64-битных числовых идентификаторов, в которые упакованы метка времени, номер узла и счётчик последовательности. Такие идентификаторы уникальны и примерно упорядочены по времени, а из самого идентификатора можно узнать, когда и на каком узле он был создан. - [Часть 2. CRUD и корзина для интернет-магазина](src/part2/TASK.md) — нужно реализовать хранилище товаров в памяти (список кортежей), операции создания, чтения, изменения и удаления записей, аккуратную работу с ценами через `Decimal` и корзину покупателя, в которую товары переносятся со склада и обратно без потери количества. +- [Часть 3. Нормализация имён и консоль администратора](src/part3/TASK.md) — нужно привести названия товаров к единому написанию и следить за их уникальностью, научить хранилище печатать себя выровненной текстовой таблицей и написать интерактивную консоль администратора, через которую можно создавать, просматривать, изменять и удалять товары. +- [Часть 4. Хранилище-словарь и UUID-идентификаторы](src/part4/TASK.md) — нужно перевести хранилище со списка кортежей на словарь, выдавать товарам идентификаторы в виде UUID, завести индекс имён для быстрой проверки уникальности, научить `update_product` менять только часть полей и оформить продуктовую корзину в виде словаря. +- [Часть 5. Snowflake-идентификаторы для интернет-магазина](src/part5/TASK.md) — нужно вернуться к Snowflake из части 1 и оформить его как генератор со своим счётчиком, перевести товары с UUID на целочисленные идентификаторы и написать параметрический декоратор, который считает успешные и неуспешные вызовы операций хранилища, а консоль администратора научить печатать эту статистику командой `stats`. -## Критерии оценивания - -Максимальный балл за каждое задание — **10**. Правильность решения проверяется закрытыми тестами. - -### Условия принятия работы - -Работа принимается к оцениванию, только если выполнены **все** условия: - -- код проходит проверки [ruff](https://docs.astral.sh/ruff/) и [MyPy](https://mypy-lang.org/) (запустить их можно [локально](manuals/local_checks.md)); -- работа сдана до дедлайна. - -Если хотя бы одно условие не выполнено, работа не принимается и оценивается в 0 баллов. - -### Как считается балл за правильность - -Тесты разбиты на функциональные блоки: каждый блок соответствует функции или классу из задания и имеет свой вес (более сложные блоки весят больше). Внутри блока тесты делятся на две группы: - -| Группа тестов | Доля веса блока | Что проверяет | -|---|---|---| -| Базовые (типичные входные данные) | 70% | Основная логика реализована верно | -| Граничные (пустой ввод, нулевые и предельные значения, повторы и т. п.) | 30% | Обработка особых случаев | - -Формулы: - -``` -балл_блока = 0.7 · доля_пройденных_базовых + 0.3 · доля_пройденных_граничных -балл_за_правильность = 10 · Σ(вес_блока · балл_блока) / Σ(вес_блока) -``` - -Дополнительные правила: - -- **Нереализованный функционал.** Блок, в котором функционал не реализован (заглушка, `pass`, `NotImplementedError`), получает 0 баллов. Остальные блоки оцениваются как обычно, дополнительного штрафа за нереализованное нет. -- **Ошибки выполнения.** Тест, в котором возникло необработанное исключение, считается проваленным. -- **Зависание.** У каждого теста есть ограничение по времени выполнения. Если решение не укладывается в него (например, из-за бесконечного цикла), тест считается проваленным. - -### Штрафы за оформление +## Дедлайны -Кроме правильности, оценивается качество кода. За нарушения ниже из балла за правильность вычитаются штрафы. Каждое нарушение штрафуется **один раз**, сколько бы раз оно ни встретилось в работе. - -У каждого нарушения есть уникальный код: `S` — серьёзные, `M` — средние, `T` — типовые. При проверке преподаватель указывает в комментарии к работе только коды (например, `S1, M2, T1`), а расшифровку и штраф можно найти в таблицах ниже. - -#### Серьёзные нарушения (−1 балл за каждое) - -| Код | Нарушение | Что имеется в виду | -|---|---|---| -| `S1` | Копипаста | Вместо вынесения повторяющейся логики в функцию, метод или цикл один и тот же (или почти тот же) код скопирован несколько раз. Мешает расширяемости: любое изменение приходится вносить во все копии | -| `S2` | Слишком длинные функции | Функция делает много разных вещей одновременно (вычисления, проверки, преобразования, форматирование в одном месте) и не читается целиком. Ориентир: более 30–40 строк или несколько несвязанных обязанностей. Такой код тяжело читать и поддерживать | -| `S3` | Магические значения | Числа и строки с неочевидным смыслом прописаны прямо в коде, а не вынесены в именованные константы. Как и копипаста, мешает расширяемости: значение приходится искать и менять по всему коду | -| `S4` | Слишком широкий перехват исключений | Голый `except:` или `except Exception:` без необходимости; молча проглоченные ошибки (`except ...: pass`). Так можно пропустить что-то важное | -| `S5` | Изменение входных данных | Функция неожиданно изменяет переданные ей аргументы, хотя из названия и описания это не следует. Неожиданное поведение, источник серьёзных ошибок | - -#### Средние нарушения (−0.5 балла за каждое) - -| Код | Нарушение | Что имеется в виду | +| Задание | Дедлайн (включительно) | Статус | |---|---|---| -| `M1` | Большая вложенность | Более трёх уровней вложенности (`if`, `for`, `while`, `try`, `with`) внутри одной функции. Лечится ранним возвратом (`return`, `continue`) и выносом логики в отдельные функции | -| `M2` | Неинформативные имена | Имена вроде `a`, `tmp`, `data2`, `x1`, а также имена, не отражающие суть, или не соответствующие PEP 8 (например, `camelCase` для функций и переменных) | -| `M3` | Избыточные глобальные переменные | Изменяемое глобальное состояние там, где достаточно параметров, возвращаемых значений или атрибутов класса | -| `M4` | Мёртвый код | Код, который нигде не используется: неиспользуемые функции, классы, переменные, константы, импорты, недостижимые ветки. Сюда же относятся крупные куски закомментированного кода «на будущее» и оставленный отладочный `print`. Затрудняет чтение, но на работу программы не влияет | - -#### Типовые нарушения хорошего тона (−0.25 балла за каждое) - -| Код | Нарушение | -|---|---| -| `T1` | `else` или `elif` после `return`, `raise`, `continue` или `break` | -| `T2` | Явное приведение к `bool` в условиях (`if bool(x):`) и сравнение с `True` / `False` (`if x == True:`) | -| `T3` | Сравнение с синглтонами и членами enum'ов через `==` / `!=` вместо `is` / `is not` | -| `T4` | Проверка пустоты коллекции через `len(x) == 0` вместо `if not x` | -| `T5` | Обход через `for i in range(len(items))`, когда индекс не нужен (вместо `for item in items` или `enumerate`) | -| `T6` | `if cond: return True else: return False` вместо `return cond` | -| `T7` | Изменяемое значение по умолчанию у аргумента (`def f(x=[])`) | -| `T8` | Ручная конкатенация строк вместо f-строк | -| `T9` | Избыточные комментарии, пересказывающие очевидный код | +| [Часть 1. Генератор идентификаторов Twitter Snowflake](src/part1/TASK.md) | 25.09.2026 | дедлайн истек | +| [Часть 2. CRUD и корзина для интернет-магазина](src/part2/TASK.md) | 02.10.2026 | дедлайн истек | +| [Часть 3. Нормализация имён и консоль администратора](src/part3/TASK.md) | 12.10.2026 | дедлайн истек | +| [Часть 4. Хранилище-словарь и UUID-идентификаторы](src/part4/TASK.md) | 01.11.2026 | дедлайн истек | +| [Часть 5. Snowflake-идентификаторы для интернет-магазина](src/part5/TASK.md) | 15.11.2026 | активно | -### Штраф за списывание - -Если работа подозревается в списывании, студент получает **−5 баллов**. Эти баллы не вычитаются из оценки за правильность, а **заменяют** итоговую оценку: итоговой оценкой становится −5, независимо от результата тестов. - -Студент может оспорить этот балл на занятии, доказав, что не списывал, а написал код самостоятельно (например, объяснив решение и ответив на вопросы по нему). Если подозрение снимается, работа оценивается по обычным критериям. - -### Итоговая оценка - -``` -если есть подозрение в списывании: - итоговая_оценка = −5 -иначе: - итоговая_оценка = max(0, балл_за_правильность − штрафы_за_оформление) -``` - -Итоговая оценка за домашнее задание округляется до ближайшего целого по правилам математики: дробная часть от 0.5 и выше округляется вверх, меньше 0.5 — вниз (например, 7.5 → 8, 7.4 → 7). - -### Как оспорить оценку +## Критерии оценивания -Если вы не согласны с оценкой, напишите преподавателю. Укажите, с каким блоком или с какой частью критериев вы не согласны, и приведите аргументы. Оценка пересматривается по тем же критериям, которые описаны выше. +Критерии оценивания можно узнать [тут](docs/grading_criteria.md). diff --git a/__init__.py b/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/pyproject.toml b/pyproject.toml index 06fbe913..83913475 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,3 +33,10 @@ avoid-escape = true [tool.ruff.lint.isort] lines-after-imports = 2 split-on-trailing-comma = true + +[tool.mypy] +strict = true +mypy_path = "src" +namespace_packages = true +explicit_package_bases = true + diff --git a/src/part1/TASK.md b/src/part1/TASK.md index ef8e0faf..8838ed72 100644 --- a/src/part1/TASK.md +++ b/src/part1/TASK.md @@ -7,7 +7,7 @@ Начнём с фундамента: у каждой записи должен быть уникальный идентификатор. Казалось бы, можно просто нумеровать записи 1, 2, 3, … Пока хранилище живёт на -одной машине, так и происходит. Но реальные системы почти всегда распределены: +одной машине, так и происходит. Но реальные системы почти всегда распределены: записи создаются на десятках серверов одновременно. Тогда возникают проблемы: - единый счётчик становится «бутылочным горлышком»: каждому серверу приходится diff --git a/src/part1/__init__.py b/src/part1/__init__.py index 242b07ce..e69de29b 100644 --- a/src/part1/__init__.py +++ b/src/part1/__init__.py @@ -1 +0,0 @@ -"""Homework 3: a Twitter Snowflake identifier generator and its bit layout.""" diff --git a/src/part1/constants.py b/src/part1/constants.py index 9abfbba2..09033e11 100644 --- a/src/part1/constants.py +++ b/src/part1/constants.py @@ -1,38 +1,13 @@ -"""Bit layout and default epoch for the Twitter Snowflake ID generator. - -A Snowflake identifier is a 63-bit positive integer packed as follows, from -the most significant bit downwards: - - 1 bit unused sign bit, always zero - 41 bits milliseconds elapsed since a custom epoch - 10 bits node identifier - 12 bits per-millisecond sequence counter - -The shift and mask constants should be derived from the bit widths so that -changing a width keeps everything else consistent. -""" - from typing import Final -# TODO: замените заглушки (0) на корректные значения, см. TASK.md. -# Все константы, зависящие от ёмкостей *_BITS, должны вычисляться из них. - -# Twitter's original Snowflake epoch: 2010-11-04 01:42:54.657 UTC. -EPOCH_MS_DEFAULT: Final[int] = 0 - -# Node identifier used when the caller does not supply one. -NODE_ID_DEFAULT: Final[int] = 0 - -# Width of each field, in bits. -TIMESTAMP_BITS: Final[int] = 0 -NODE_ID_BITS: Final[int] = 0 -SEQUENCE_ID_BITS: Final[int] = 0 - -# Largest value each field can hold. -TIMESTAMP_MS_MAX: Final[int] = 0 -NODE_ID_MAX: Final[int] = 0 -SEQUENCE_ID_MAX: Final[int] = 0 - -# Здесь можно добавить собственные вспомогательные константы -# (например, сдвиги полей при сборке идентификатора). +EPOCH_MS_DEFAULT: Final[int] = 1288834974657 +NODE_ID_DEFAULT: Final[int] = 1 +TIMESTAMP_BITS: Final[int] = 41 +NODE_ID_BITS: Final[int] = 10 +SEQUENCE_ID_BITS: Final[int] = 12 +TIMESTAMP_MS_MAX: Final[int] = 2**TIMESTAMP_BITS - 1 +NODE_ID_MAX: Final[int] = 2**NODE_ID_BITS - 1 +SEQUENCE_ID_MAX: Final[int] = 2**SEQUENCE_ID_BITS - 1 +NODE_ID_SHIFT: Final[int] = SEQUENCE_ID_BITS +TIMESTAMP_SHIFT: Final[int] = SEQUENCE_ID_BITS + NODE_ID_BITS diff --git a/src/part1/snowflake.py b/src/part1/snowflake.py index d3abf050..deb039bf 100644 --- a/src/part1/snowflake.py +++ b/src/part1/snowflake.py @@ -1,85 +1,31 @@ -"""Twitter Snowflake identifier generator. +import time -Snowflake produces roughly time-ordered 64-bit integer identifiers without -coordination between nodes. Each identifier packs the milliseconds elapsed -since a custom epoch, a node identifier and a per-millisecond sequence counter -into a single 63-bit positive integer (see ``constants`` for the layout). - -The public entry point is :func:`generate_snowflake_id`. It is stateless: the -caller passes the sequence counter on every call and is responsible for -advancing it within a millisecond and resetting it when the clock ticks over. - -Each packed field can be read back on its own with :func:`decode_timestamp_ms`, -:func:`decode_node_id` and :func:`decode_sequence_id`. -""" - -import time # noqa: F401 - -from .constants import ( # noqa: F401 +from .constants import ( EPOCH_MS_DEFAULT, NODE_ID_DEFAULT, NODE_ID_MAX, + NODE_ID_SHIFT, SEQUENCE_ID_MAX, TIMESTAMP_MS_MAX, + TIMESTAMP_SHIFT, ) def read_current_millis(epoch_ms: int) -> int: - """Read the number of milliseconds elapsed since the custom epoch. - - Args: - epoch_ms: The custom epoch expressed as Unix milliseconds. - - Returns: - The count of whole milliseconds between ``epoch_ms`` and now. May be - negative if ``epoch_ms`` lies in the future. - """ - # TODO: реализуйте функцию - return 0 + return time.time_ns() // 1_000_000 - epoch_ms def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> int: - """Read the timestamp field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced against the same epoch. - epoch_ms: The epoch the identifier was generated against. Defaults to - the original Twitter epoch (2010-11-04 01:42:54.657 UTC). - - Returns: - The absolute Unix time in milliseconds at which the identifier was - generated. - """ - # TODO: реализуйте функцию - return 0 + stored_ms = snowflake_id >> TIMESTAMP_SHIFT + return stored_ms + epoch_ms def decode_node_id(snowflake_id: int) -> int: - """Read the node identifier field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by :func:`generate_snowflake_id`. - - Returns: - The node identifier packed into ``snowflake_id``, in the range - ``[0, NODE_ID_MAX]``. - """ - # TODO: реализуйте функцию - return 0 + return (snowflake_id >> NODE_ID_SHIFT) & NODE_ID_MAX def decode_sequence_id(snowflake_id: int) -> int: - """Read the sequence counter field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by :func:`generate_snowflake_id`. - - Returns: - The per-millisecond sequence counter packed into ``snowflake_id``, in - the range ``[0, SEQUENCE_ID_MAX]``. - """ - # TODO: реализуйте функцию - return 0 + return snowflake_id & SEQUENCE_ID_MAX def generate_snowflake_id( @@ -87,28 +33,17 @@ def generate_snowflake_id( node_id: int = NODE_ID_DEFAULT, epoch_ms: int = EPOCH_MS_DEFAULT, ) -> int | None: - """Build and return a Snowflake identifier for the current millisecond. + if not (0 <= node_id <= NODE_ID_MAX): + print(f"node_id must be in [0, {NODE_ID_MAX}], got {node_id}") + return None - The function is stateless: the caller passes the per-millisecond sequence - counter explicitly. It is the caller's responsibility to increment - ``sequence_id`` for identifiers minted within the same millisecond and to - reset it once the clock advances. + if not (0 <= sequence_id <= SEQUENCE_ID_MAX): + print(f"sequence_id must be in [0, {SEQUENCE_ID_MAX}], got {sequence_id}") + return None - Args: - sequence_id: The per-millisecond sequence counter, in the range - ``[0, SEQUENCE_ID_MAX]``. - node_id: The identifier of this node, in the range ``[0, NODE_ID_MAX]``. - Optional; defaults to ``NODE_ID_DEFAULT``. - epoch_ms: The start of the epoch as Unix milliseconds. Optional; - defaults to the original Twitter epoch (2010-11-04 01:42:54.657 - UTC). + elapsed_ms = read_current_millis(epoch_ms) + if elapsed_ms > TIMESTAMP_MS_MAX: + print(f"timestamp overflows: {elapsed_ms} > {TIMESTAMP_MS_MAX}") + return None - Returns: - The Snowflake identifier as a positive 63-bit integer, or ``None`` if - ``node_id`` is outside ``[0, NODE_ID_MAX]``, ``sequence_id`` is outside - ``[0, SEQUENCE_ID_MAX]``, or the elapsed time no longer fits in the - timestamp field (roughly 69 years after ``epoch_ms``). In each of those - cases an explanatory message is printed to stdout first. - """ - # TODO: реализуйте функцию - return 0 + return (elapsed_ms << TIMESTAMP_SHIFT) | (node_id << NODE_ID_SHIFT) | sequence_id diff --git a/src/part2/cart.py b/src/part2/cart.py index 063f9aea..6e042567 100644 --- a/src/part2/cart.py +++ b/src/part2/cart.py @@ -9,12 +9,14 @@ an explanatory message to stdout and returns ``None``. """ -from typing import Final +from decimal import Decimal +from typing import Final, cast -from .crud import read_product, update_product # noqa: F401 -from .storage import ( # noqa: F401 +from .crud import read_product, update_product +from .storage import ( NAME_INDEX, PRICE_INDEX, + PRODUCT_ID_INDEX, QUANTITY_INDEX, Product, ) @@ -22,9 +24,15 @@ type CartLine = tuple[int, int] -# TODO: задайте позиции полей внутри кортежа CartLine -LINE_PRODUCT_ID_INDEX: Final = 0 -LINE_QUANTITY_INDEX: Final = 0 +LINE_PRODUCT_ID_INDEX: Final[int] = 0 +LINE_QUANTITY_INDEX: Final[int] = 1 + + +def find_cart_line(cart: list[CartLine], product_id: int) -> CartLine | None: + for line in cart: + if line[LINE_PRODUCT_ID_INDEX] == product_id: + return line + return None def add_to_cart( @@ -33,28 +41,44 @@ def add_to_cart( product_id: int, quantity: int, ) -> CartLine | None: - """Move ``quantity`` units of ``product_id`` from the store into ``cart``. - - The product is looked up in ``storage``. If it is missing, a message is - printed (by :func:`~src.part2.crud.read_product`) and nothing - changes. If the store holds fewer units than requested, an explanatory - message is printed and nothing changes. Otherwise the store record is - decremented by ``quantity`` and the cart line for ``product_id`` gains - ``quantity`` units -- a new line is created when the cart had none. - - Args: - storage: The product store to draw stock from; modified in place on - success. - cart: The cart to add the units to; modified in place on success. - product_id: The identifier of the product to add. - quantity: Number of units to move into the cart. - - Returns: - The cart line for ``product_id`` after the addition, or ``None`` - when the product is unknown or the store cannot cover the request. - """ - # TODO: реализуйте функцию - return (0, 0) + product = read_product(storage, product_id) + if product is None: + return None + + stored_id = cast(int, product[PRODUCT_ID_INDEX]) + if stored_id != product_id: + print(f"storage returned a wrong record for product {product_id}") + return None + + name = cast(str, product[NAME_INDEX]) + price = cast(Decimal, product[PRICE_INDEX]) + available = cast(int, product[QUANTITY_INDEX]) + + if available < quantity: + print( + f"not enough stock for product {product_id}: " + f"{available} available, {quantity} requested" + ) + return None + + update_product( + storage, + product_id, + (name, price, available - quantity), + ) + + for index, line in enumerate(cart): + if line[LINE_PRODUCT_ID_INDEX] == product_id: + updated = ( + product_id, + line[LINE_QUANTITY_INDEX] + quantity, + ) + cart[index] = updated + return updated + + new_line = (product_id, quantity) + cart.append(new_line) + return new_line def remove_from_cart( @@ -63,27 +87,45 @@ def remove_from_cart( product_id: int, quantity: int, ) -> CartLine | None: - """Move ``quantity`` units of ``product_id`` from ``cart`` back to the store. - - The cart line for ``product_id`` is looked up. If there is none, a - message is printed and nothing changes. If the line holds fewer units - than requested, an explanatory message is printed and nothing changes. - Otherwise the cart line loses ``quantity`` units -- the line is dropped - when it reaches zero -- and the store record gains ``quantity`` units - back. - - Args: - storage: The product store to return stock to; modified in place on - success. - cart: The cart to take the units from; modified in place on - success. - product_id: The identifier of the product to remove. - quantity: Number of units to move back into the store. - - Returns: - The cart line for ``product_id`` after the removal (a quantity of - zero means the line was dropped), or ``None`` when the cart has no - line for the product or holds too few units. - """ - # TODO: реализуйте функцию - return (0, 0) + line = find_cart_line(cart, product_id) + if line is None: + print(f"product {product_id} is not in the cart") + return None + + cart_qty = line[LINE_QUANTITY_INDEX] + if cart_qty < quantity: + print( + f"cart holds only {cart_qty} unit(s) of product {product_id}, " + f"cannot remove {quantity}" + ) + return None + + product = read_product(storage, product_id) + if product is None: + return None + + stored_id = cast(int, product[PRODUCT_ID_INDEX]) + if stored_id != product_id: + print(f"storage returned a wrong record for product {product_id}") + return None + + name = cast(str, product[NAME_INDEX]) + price = cast(Decimal, product[PRICE_INDEX]) + stock_quantity = cast(int, product[QUANTITY_INDEX]) + + update_product( + storage, + product_id, + (name, price, stock_quantity + quantity), + ) + + for index, cart_line in enumerate(cart): + if cart_line[LINE_PRODUCT_ID_INDEX] == product_id: + remaining = cart_qty - quantity + if remaining == 0: + del cart[index] + return (product_id, 0) + updated = (product_id, remaining) + cart[index] = updated + return updated + return None diff --git a/src/part2/crud.py b/src/part2/crud.py index d026cbcb..cd509e05 100644 --- a/src/part2/crud.py +++ b/src/part2/crud.py @@ -14,66 +14,47 @@ from decimal import Decimal -from .storage import ( # noqa: F401 +from .storage import ( NAME_INDEX, PRODUCT_ID_INDEX, PRODUCT_ID_MIN, Product, ) -from .utils import normalize_price # noqa: F401 +from .utils import normalize_price def generate_product_id(storage: list[Product]) -> int: - """Choose the identifier for the next product added to ``storage``. + if not storage: + return PRODUCT_ID_MIN - Args: - storage: The product store to inspect. - - Returns: - One past the greatest identifier currently held in ``storage``, or - :data:`~src.part2.storage.PRODUCT_ID_MIN` when ``storage`` is - empty. - """ - # TODO: реализуйте функцию - return 0 + max_id = 0 + for product in storage: + current_id = int(product[PRODUCT_ID_INDEX]) + max_id = max(current_id, max_id) + return max_id + 1 def create_product( storage: list[Product], fields: tuple[str, Decimal, int] ) -> int | None: - """Append a new product to ``storage`` and return its new identifier. - - Args: - storage: The product store to append to; modified in place on - success. - fields: A ``(name, price, quantity)`` tuple describing the product. - ``price`` is a :class:`~decimal.Decimal` amount and is rounded - to the stored money precision before it is saved. + name, price, quantity = fields + for product in storage: + if product[NAME_INDEX] == name: + print(f"Product name '{name}' is already taken") + return None - Returns: - The identifier generated for the new product, or ``None`` when a - product with the same name already exists. In the ``None`` case - ``storage`` is left unchanged and a message naming the clashing - name is printed. - """ - # TODO: реализуйте функцию - return 0 + new_id = generate_product_id(storage) + normalized_price = normalize_price(price) + storage.append((new_id, name, normalized_price, quantity)) + return new_id def read_product(storage: list[Product], product_id: int) -> Product | None: - """Return the product stored under ``product_id``. - - Args: - storage: The product store to search. - product_id: The identifier to look up. - - Returns: - The matching ``(product_id, name, price, quantity)`` record, or - ``None`` when no product carries that identifier (a message is - printed in that case). - """ - # TODO: реализуйте функцию - return (0, "", Decimal(0), 0) + for product in storage: + if product[PRODUCT_ID_INDEX] == product_id: + return product + print(f"No product with id {product_id}") + return None def update_product( @@ -81,40 +62,21 @@ def update_product( product_id: int, fields: tuple[str, Decimal, int], ) -> Product | None: - """Overwrite the fields of the product stored under ``product_id``. - - The identifier itself is preserved; only ``name``, ``price`` and - ``quantity`` are replaced. - - Args: - storage: The product store to modify; the matching record is - replaced in place on success. - product_id: The identifier of the product to change. - fields: A ``(name, price, quantity)`` tuple with the new values. - ``price`` is a :class:`~decimal.Decimal` amount and is rounded - to the stored money precision before it is saved. - - Returns: - The updated ``(product_id, name, price, quantity)`` record, or - ``None`` when no product carries that identifier (``storage`` is - left unchanged and a message is printed). - """ - # TODO: реализуйте функцию - return (0, "", Decimal(0), 0) + name, price, quantity = fields + normalized_price = normalize_price(price) + for i in range(len(storage)): + if storage[i][PRODUCT_ID_INDEX] == product_id: + updated_product = (product_id, name, normalized_price, quantity) + storage[i] = updated_product + return updated_product + print(f"No product with id {product_id}") + return None def delete_product(storage: list[Product], product_id: int) -> int | None: - """Remove the product stored under ``product_id`` from ``storage``. - - Args: - storage: The product store to remove from; modified in place on - success. - product_id: The identifier of the product to remove. - - Returns: - ``product_id`` when a product was removed, or ``None`` when no - product carried that identifier (``storage`` is left unchanged and - a message is printed). - """ - # TODO: реализуйте функцию - return 0 + for i in range(len(storage)): + if storage[i][PRODUCT_ID_INDEX] == product_id: + del storage[i] + return product_id + print(f"No product with id {product_id}") + return None diff --git a/src/part2/storage.py b/src/part2/storage.py index b63d5fc7..73cc4464 100644 --- a/src/part2/storage.py +++ b/src/part2/storage.py @@ -25,10 +25,10 @@ type Product = tuple[int, str, Decimal, int] # TODO: задайте позиции полей внутри кортежа Product -PRODUCT_ID_INDEX: Final = 0 -NAME_INDEX: Final = 0 -PRICE_INDEX: Final = 0 -QUANTITY_INDEX: Final = 0 +PRODUCT_ID_INDEX: Final[int] = 0 +NAME_INDEX: Final[int] = 1 +PRICE_INDEX: Final[int] = 2 +QUANTITY_INDEX: Final[int] = 3 # TODO: задайте идентификатор первого товара в пустом хранилище -PRODUCT_ID_MIN: Final[int] = 0 +PRODUCT_ID_MIN: Final[int] = 1 diff --git a/src/part2/utils.py b/src/part2/utils.py index ec0348d3..f18a7eb6 100644 --- a/src/part2/utils.py +++ b/src/part2/utils.py @@ -6,24 +6,13 @@ currency values free of binary floating-point error. """ -from decimal import ROUND_HALF_UP, Decimal # noqa: F401 +from decimal import ROUND_HALF_UP, Decimal from typing import Final -# TODO: задайте число знаков после запятой и шаг квантования -PRICE_PRECISION: Final[int] = 0 -PRICE_STEP: Final = Decimal(0) +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final[Decimal] = Decimal(1).scaleb(-PRICE_PRECISION) def normalize_price(price: Decimal) -> Decimal: - """Round a price to the precision every stored record uses. - - Args: - price: The raw price amount. - - Returns: - ``price`` quantised to :data:`PRICE_PRECISION` fractional digits, - with halves rounded up. - """ - # TODO: реализуйте функцию - return Decimal(0) + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) diff --git a/src/part3/TASK.md b/src/part3/TASK.md new file mode 100644 index 00000000..f229ae2f --- /dev/null +++ b/src/part3/TASK.md @@ -0,0 +1,486 @@ +# Задача: нормализация имён, печать хранилища таблицей и админ-консоль + +## Легенда + +CRUD-функции из [части 2](../part2/TASK.md) уже умеют создавать, читать, +изменять и удалять товары, но пользоваться ими можно только из кода: чтобы +добавить в каталог одну позицию или посмотреть, что лежит на складе, приходится +писать скрипт. Для администратора магазина это неудобно, а при первых же +реальных данных вылезают новые проблемы: + +- один и тот же товар заводят несколько раз под разными написаниями — + `"Cordless Drill"`, `"cordless drill"`, `" cordless drill "` — и в + каталоге появляются дубликаты, которые невозможно найти по имени; +- содержимое хранилища выводится как «сырой» список кортежей, в котором трудно + что-либо разобрать, особенно когда товаров становится больше нескольких; +- любое действие над каталогом требует запуска отдельного кода, хотя + администратору нужен простой интерактивный инструмент. + +Чтобы решить эти задачи, мы научим хранилище приводить имена товаров к единому +виду и следить за их уникальностью, отрисовывать себя выровненной текстовой +таблицей и построим над ним консоль администратора — маленькую программу, в +которой команды вводятся строками, а результат сразу печатается на экране. + +## Контекст + +Часть 3 продолжает [часть 2](../part2/TASK.md) — тот же интернет-магазин, то же +хранилище товаров (список кортежей `Product` в оперативной памяти) и те же +CRUD-операции над ним. Корзина (`cart.py`) в этой части не используется. То, что +в этой части не меняется, берите из своего решения части 2. Новых возможностей +три: + +- имя товара приводится к канонической форме перед сохранением и сравнением; +- хранилище можно отрисовать выровненной текстовой таблицей; +- появляется интерактивная консоль администратора над этим хранилищем. + +Модули: + +- `storage.py` — используйте своё решение части 2 (форма записи `Product`, + константы `*_INDEX`, `PRODUCT_ID_MIN`); +- `utils.py` — к существующему округлению цен (`PRICE_PRECISION`, `PRICE_STEP`, + `normalize_price` — используйте своё решение части 2) добавляются + нормализация имени и отрисовка таблицы; +- `crud.py` — `generate_product_id`, `read_product`, `delete_product` — + используйте свои решения части 2; `create_product` и `update_product` + дорабатываются (см. ниже); +- `run_admin.py` — **новый модуль**, консоль администратора. + +Всё, что не изменилось по сравнению с частью 2, здесь не описывается — +реализуйте это так, как вы делали в своём решении части 2 (см. +[описание части 2](../part2/TASK.md)). + +> **Важно.** Тексты, которые функции печатают в stdout или возвращают как +> строку (сообщения об ошибках, таблица хранилища, ответы консоли), в тестах +> проверяются **дословно**: лишний пробел, другой регистр, пропущенная точка или +> перевод строки считаются ошибкой. Берите тексты из описания и примеров как +> есть. + +--- + +## Модуль `utils.py` + +### Константа `TABLE_HEADERS` + +Кортеж заголовков столбцов таблицы, слева направо: +`("ID", "name", "price", "quantity")`. Аннотирован `typing.Final`. Ширина +столбцов здесь не фиксируется — она измеряется по данным в момент вызова +`get_storage_str_representation`. + +### `normalize_product_name(name: str) -> str` + +Приводит сырое имя товара к единственному написанию, которое хранит склад. + +- **Вход:** `name` — произвольная строка. +- **Выход:** та же строка без начальных и конечных пробельных символов; + каждая внутренняя последовательность пробельных символов (пробелы, + табуляции и т. п.) заменяется на один пробел; всё остальное переведено в + нижний регистр. Если в строке нет ничего, кроме пробельных символов, — + возвращается пустая строка. + +Примеры: `" Cordless Drill " → "cordless drill"`, +`"abc def\tghi\tjkl" → "abc def ghi jkl"`, `" \t\n " → ""`, +`"claw hammer" → "claw hammer"` (уже канонично — не меняется). + +### `get_storage_str_representation(storage: list[Product]) -> str` + +Отрисовывает всё хранилище одной мультистрокой — выровненной таблицей, +пригодной для печати в терминал. + +«Выровненная» значит, что при печати моноширинным шрифтом все строки таблицы +имеют одинаковую длину, а разделители `|` стоят строго друг под другом: +значения в каждом столбце начинаются с одной и той же позиции, а ширина столбца +подбирается под самое длинное из его значений. Сравните: так выглядит вывод +хранилища, если просто напечатать значения через пробел: + +``` +ID name price quantity +10 compressor 1299.99 3 +2 nail 2.50 500 +``` + +А так он выглядит после выравнивания: + +``` +| ID | name | price | quantity | +|----|------------|---------|----------| +| 10 | compressor | 1299.99 | 3 | +| 2 | nail | 2.50 | 500 | +``` + +Точные правила выравнивания приведены в разделе «Формат» ниже. + +- **Вход:** `storage` — хранилище товаров. +- **Выход:** мультистрока (строки соединены `"\n"`, завершающего + перевода строки нет): + + 1. строка заголовков — значения из `TABLE_HEADERS`; + 2. разделительная строка из дефисов; + 3. по одной строке на каждый товар из `storage`, **в том порядке, в котором + хранилище их держит**. + + Когда `storage` пусто — возвращаются только строки 1 и 2. + +**Формат.** + +- Значения ячеек товара берутся как `str(...)` от полей записи в порядке + `TABLE_HEADERS`: `str(id)`, имя как есть, `str(price)` (у `Decimal`, уже + нормализованного, это, например, `"9.90"`, `"12.00"`, `"1299.99"`), + `str(quantity)`. +- Ширина каждого столбца равна длине самого длинного значения в этом столбце, + причём метка заголовка из `TABLE_HEADERS` тоже участвует в подсчёте. Поэтому + столбец никогда не уже своего заголовка, в том числе на пустом хранилище. +- Ячейка выравнивается по левому краю и дополняется пробелами до ширины + столбца; вокруг каждой ячейки — по одному пробелу отступа. Строка данных и + строка заголовков начинаются и заканчиваются символом `|`, соседние ячейки + тоже разделяются `|`. +- В разделительной строке каждый прогон дефисов на два символа длиннее ширины + своего столбца (закрывает отступы по краям ячейки); прогоны разделены `|`, + строка начинается и заканчивается `|`. + +Пустое хранилище отрисовывается ровно так: + +``` +| ID | name | price | quantity | +|----|------|-------|----------| +``` + +Хранилище `[(1, "saw", Decimal("9.90"), 5), (2, "axe", Decimal("12.00"), 8)]`: + +``` +| ID | name | price | quantity | +|----|------|-------|----------| +| 1 | saw | 9.90 | 5 | +| 2 | axe | 12.00 | 8 | +``` + +Хранилище `[(10, "compressor", Decimal("1299.99"), 3), (2, "nail", Decimal("2.50"), 500)]` +(столбцы расширяются под самое длинное значение): + +``` +| ID | name | price | quantity | +|----|------------|---------|----------| +| 10 | compressor | 1299.99 | 3 | +| 2 | nail | 2.50 | 500 | +``` + +--- + +## Модуль `crud.py` + +Остальные функции модуля (`generate_product_id`, `read_product`, +`delete_product`) реализуйте как в своём решении части 2. Изменяются только две +функции, описанные ниже; их сигнатуры прежние. + +### `create_product(storage: list[Product], fields: tuple[str, Decimal, int]) -> int | None` + +Порядок действий (при первой же неудаче хранилище не меняется, печатается +сообщение, возвращается `None`): + +1. Имя из `fields` приводится через `normalize_product_name`. Дальше везде — + и при сравнении, и при сохранении — используется нормализованное имя. +2. Если нормализованное имя пустое — печатается сообщение + `product name must not be blank`, возвращается `None`. +3. Если в хранилище уже есть запись с таким же **нормализованным** именем — + печатается сообщение, содержащее это имя + (`product name '<имя>' is already taken`), возвращается `None`. Сравнение + идёт по канонической форме, поэтому `" Cordless Drill "` (иной регистр, + лишние пробелы по краям и между словами) конфликтует с уже сохранённым + `"cordless drill"`. +4. Иначе — как в части 2: кортеж вида `(идентификатор, нормализованное имя, + нормализованная цена, количество)` добавляется в хранилище, возвращается + идентификатор. Значение идентификатора должно быть сгенерировано + с помощью функции `generate_product_id`, цена нормализована с помощью + функции `normalize_price`. + +**Примеры.** Каждый пример — отдельный фрагмент скрипта, который начинается с +пустого хранилища. В комментариях указано, что функция возвращает или печатает. + +Успешное создание: имя нормализуется, цена округляется, идентификаторы +выдаются по порядку: + +```python +storage: list[Product] = [] + +first_id = create_product(storage, (" Cordless Drill ", Decimal("89.999"), 12)) +second_id = create_product(storage, ("Claw Hammer", Decimal("9.9"), 40)) + +print(first_id) # 1 +print(second_id) # 2 +print(storage) +# [(1, 'cordless drill', Decimal('90.00'), 12), +# (2, 'claw hammer', Decimal('9.90'), 40)] +``` + +Имя занято (сравнение идёт по нормализованной форме), хранилище не меняется: + +```python +storage: list[Product] = [] + +create_product(storage, ("cordless drill", Decimal("50"), 3)) +result = create_product(storage, (" CORDLESS DRILL ", Decimal("75"), 1)) +# печатает: product name 'cordless drill' is already taken + +print(result) # None +print(storage) # [(1, 'cordless drill', Decimal('50.00'), 3)] +``` + +Имя из одних пробелов, хранилище не меняется: + +```python +storage: list[Product] = [] + +result = create_product(storage, (" ", Decimal("10"), 5)) +# печатает: product name must not be blank + +print(result) # None +print(storage) # [] +``` + +### `update_product(storage: list[Product], product_id: int, fields: tuple[str, Decimal, int]) -> Product | None` + +Порядок действий: + +1. Имя из `fields` приводится через `normalize_product_name`. +2. Если нормализованное имя пустое — печатается сообщение + `product name must not be blank`, возвращается `None`, хранилище не + меняется. Эта проверка выполняется **до** поиска записи по идентификатору. +3. Если записи с `product_id` нет — печатается сообщение с идентификатором + (`no product with id `), возвращается `None`, хранилище не меняется. +4. Если нормализованное имя уже занято **другим** товаром (запись с таким + же нормализованным именем и другим `product_id`) — печатается сообщение, + содержащее это имя (`product name '<имя>' is already taken`), возвращается + `None`, хранилище не меняется. Переименование товара в его же текущее имя + (и обновление только цены/количества) конфликтом не считается. +5. Иначе запись заменяется на `(product_id, нормализованное имя, + normalize_price(цена), количество)`; идентификатор сохраняется прежним. + Возвращается изменённая запись. + +**Примеры.** Каждый пример — отдельный фрагмент скрипта, который начинается с +хранилища из двух товаров: + +```python +storage: list[Product] = [ + (1, "cordless drill", Decimal("90.00"), 12), + (2, "claw hammer", Decimal("9.90"), 40), +] +``` + +Успешное изменение: имя нормализуется, цена округляется, идентификатор +сохраняется: + +```python +result = update_product(storage, 2, (" Rubber Mallet ", Decimal("7.505"), 25)) + +print(result) # (2, 'rubber mallet', Decimal('7.51'), 25) +print(storage) +# [(1, 'cordless drill', Decimal('90.00'), 12), +# (2, 'rubber mallet', Decimal('7.51'), 25)] +``` + +Обновление товара под его же именем (даже в другом написании) конфликтом не +считается — меняются только цена и количество: + +```python +result = update_product(storage, 1, ("CORDLESS Drill", Decimal("85"), 10)) + +print(result) # (1, 'cordless drill', Decimal('85.00'), 10) +``` + +Имя уже занято другим товаром, хранилище не меняется: + +```python +result = update_product(storage, 1, (" Claw Hammer ", Decimal("85"), 10)) +# печатает: product name 'claw hammer' is already taken + +print(result) # None +print(storage) +# [(1, 'cordless drill', Decimal('90.00'), 12), +# (2, 'claw hammer', Decimal('9.90'), 40)] +``` + +Товара с таким идентификатором нет, а пустое имя отвергается раньше, чем +выполняется поиск по идентификатору: + +```python +result = update_product(storage, 99, ("saw", Decimal("20"), 5)) +# печатает: no product with id 99 +print(result) # None + +result = update_product(storage, 99, (" ", Decimal("20"), 5)) +# печатает: product name must not be blank (а не no product with id 99) +print(result) # None +``` + +--- + +## Модуль `run_admin.py` (новый) + +Интерактивная консоль администратора над одним хранилищем товаров, которое +живёт в памяти всё время работы процесса. Цикл «прочитать строку — выполнить — +напечатать результат» продолжается, пока не введена команда `exit`. + +Пример сессии (после `admin> ` идёт ввод пользователя, остальное печатает +программа): + +``` +admin> create Cordless Drill 89.99 12 +1 +admin> create claw hammer 9.9 40 +2 +admin> show +| ID | name | price | quantity | +|----|----------------|-------|----------| +| 1 | cordless drill | 89.99 | 12 | +| 2 | claw hammer | 9.90 | 40 | +admin> read 5 +no product with id 5 +admin> exit +``` + +### Константы + +- `PROMPT: Final[str] = "admin> "` — приглашение, печатается перед чтением + каждой строки ввода. +- `HELP_TEXT: Final[str]` — многострочный текст-справка: перечень всех команд с + кратким описанием каждой и пояснением, что для `create` и `update` цена и + количество — это два последних слова строки, а всё между ними — имя товара + (поэтому имя может содержать пробелы и не требует кавычек). + + Пример текста справки: + + ``` + Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + + For create and update the price and quantity are the last two words of the + line; everything before them is the product name, so it may contain spaces + (for example "Gibson SG Junior") and needs no quoting. + ``` + +### Разбор команд + +Команда определяется по строке, разбитой по пробельным символам. +Распознаются следующие формы (число слов должно совпадать точно): + +| Форма ввода | Действие | +| --- | --- | +| `help` | напечатать `HELP_TEXT` | +| `exit` | завершить цикл | +| `show` | напечатать всё хранилище выравненной таблицей | +| `create <имя...> <цена> <количество>` | добавить товар; `<имя...>` — одно или больше слов | +| `read ` | напечатать один товар | +| `update <имя...> <цена> <количество>` | перезаписать поля товара; `<имя...>` — одно или больше слов | +| `delete ` | удалить товар | + +`<имя...>` может состоять из произвольного количества слов (но не меньше +одного), разделённых пробелами; слова склеиваются через один пробел в имя +товара. Все остальные параметры команд (``, `<цена>`, `<количество>`) — ровно +по одному слову. Поэтому `create` и `update` без слов имени (`create 89.90 12`) +командой не считаются. + +Разобранные аргументы приводятся к типам: `` и `<количество>` — через +`int(...)` (десятичное целое), `<цена>` — через `Decimal(...)`. Получившийся +кортеж `(имя, цена, количество)` передаётся в соответствующую функцию `crud.py`. + +### `show_help() -> None` + +Печатает `HELP_TEXT` в stdout как есть. + +### `print_result(result: object) -> None` + +- **Вход:** `result` — значение, вернувшееся из CRUD-операции. +- **Поведение:** если `result` не `None` — печатает `result` в stdout; если + `None` — не печатает ничего (операция уже сообщила о своей неудаче сама). + +### `run_command(storage: list[Product], line: str) -> bool` + +Разбирает одну строку консоли и выполняет названную ею команду. + +- **Вход:** `storage` — общее хранилище сессии (команды `create`, `update`, + `delete` меняют его на месте); `line` — одна строка ввода, уже очищенная от + окружающих пробелов. +- **Выход:** `True` — цикл нужно продолжать; `False` — введена команда `exit`. +- **Поведение по формам:** + - `help` — печатается справка; цикл продолжается; + - `exit` — цикл нужно остановить; + - `show` — печатается таблица со всем хранилищем; цикл продолжается; + - `create`, `read`, `update`, `delete` — выполняется соответствующая + CRUD-операция с разобранными аргументами, её результат выводится на экран + (если операция ничего не вернула, не выводится ничего); цикл продолжается; + - строка, которая не подошла ни под одну форму — неизвестная команда + (`frobnicate ...`) либо известная команда с неверным числом аргументов + (`read 1 2 3`) — печатается сообщение `'<строка>' is not a command`; + хранилище не меняется; вернуть `True`. + +### `main() -> None` + +Запускает цикл до команды `exit`. В шаблоне задания эта функция **уже +реализована** — писать её не нужно; ниже описано её поведение, чтобы вы понимали, +как консоль использует `run_command`. + +- Заводит одно пустое хранилище `storage` и держит его в памяти всю сессию. +- На каждой итерации: читает строку через `input(PROMPT)`, очищает её от + окружающих пробелов, передаёт в `run_command`. Значение `run_command` + становится флагом продолжения цикла. +- `ValueError` и `decimal.InvalidOperation` из `run_command` перехватываются + здесь: печатается сообщение вида + `'<строка>' names a command but its arguments are invalid`, хранилище не + меняется, цикл продолжается. +- Цикл останавливает только `exit`. + +### Как запустить консоль + +Откройте терминал **в корне репозитория** (там, где лежит `pyproject.toml`) и +выполните: + +``` +uv run python -m src.part3.run_admin +``` + +Если `uv` у вас не установлен, см. [инструкцию](../../manuals/local_checks.md); +вместо него можно использовать обычный Python 3.12 или новее: + +``` +python -m src.part3.run_admin +``` + +После запуска появится приглашение `admin> `. Введите `help`, чтобы увидеть +список команд (после того как вы реализуете `show_help()`), и `exit`, чтобы +выйти. Хранилище живёт только пока работает программа: при следующем запуске оно +снова пустое. + +Обратите внимание: + +- запускать нужно именно как модуль (`-m src.part3.run_admin`, имя модуля с + точками, без `.py`). Запуск файла напрямую (`python src/part3/run_admin.py`) + завершится ошибкой `ImportError: attempted relative import with no known + parent package`, потому что модули пакета импортируют друг друга; +- запуск из другой папки (например, из `src/part3`) тоже не сработает — модуль + `src` в этом случае не будет найден; +- если вы запускаете скрипт из PyCharm или VS Code, настройте запуск «как + модуль» (параметр `-m` / `module`) с тем же именем `src.part3.run_admin` и + рабочей папкой в корне репозитория. + +--- + +## Инварианты + +- Всякое сохранённое имя каноническое: `create_product` и `update_product` + пропускают имя через `normalize_product_name` и при сравнении, и при записи, + поэтому в хранилище не встречаются имена с окружающими пробелами, с + несколькими пробельными символами подряд внутри или с буквами верхнего + регистра. +- Имена уникальны с точностью до нормализации: два имени, совпадающие после + `normalize_product_name`, не могут оба быть в хранилище. +- `get_storage_str_representation` не теряет и не переставляет товары: тело + таблицы — это записи `storage` в исходном порядке, по строке на запись; ни + одно значение не обрезается (каждый столбец не уже самого длинного своего + значения). +- Для непустого `storage` в выводе `get_storage_str_representation` все строки + имеют одинаковую длину, а «столбики» `|` стоят друг под другом. diff --git a/src/part3/__init__.py b/src/part3/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/src/part3/crud.py b/src/part3/crud.py new file mode 100644 index 00000000..11de16ed --- /dev/null +++ b/src/part3/crud.py @@ -0,0 +1,80 @@ +from decimal import Decimal + +from .storage import ( + NAME_INDEX, + PRODUCT_ID_INDEX, + PRODUCT_ID_MIN, + Product, +) +from .utils import normalize_price, normalize_product_name + + +def generate_product_id(storage: list[Product]) -> int: + if not storage: + return PRODUCT_ID_MIN + return max(p[PRODUCT_ID_INDEX] for p in storage) + 1 + + +def create_product( + storage: list[Product], fields: tuple[str, Decimal, int] +) -> int | None: + name, price, quantity = fields + name = normalize_product_name(name) + if not name: + print("product name must not be blank") + return None + if any(p[NAME_INDEX] == name for p in storage): + print(f"product name '{name}' is already taken") + return None + product_id = generate_product_id(storage) + storage.append((product_id, name, normalize_price(price), quantity)) + return product_id + + +def read_product(storage: list[Product], product_id: int) -> Product | None: + for product in storage: + if product[PRODUCT_ID_INDEX] == product_id: + return product + + print(f"no product with id {product_id}") + return None + + +def update_product( + storage: list[Product], + product_id: int, + fields: tuple[str, Decimal, int], +) -> Product | None: + name, price, quantity = fields + name = normalize_product_name(name) + if not name: + print("product name must not be blank") + return None + + index = None + for i, product in enumerate(storage): + if product[PRODUCT_ID_INDEX] == product_id: + index = i + break + + if index is None: + print(f"no product with id {product_id}") + return None + + for product in storage: + if product[NAME_INDEX] == name and product[PRODUCT_ID_INDEX] != product_id: + print(f"product name '{name}' is already taken") + return None + updated = (product_id, name, normalize_price(price), quantity) + storage[index] = updated + return updated + + +def delete_product(storage: list[Product], product_id: int) -> int | None: + for index, product in enumerate(storage): + if product[PRODUCT_ID_INDEX] == product_id: + del storage[index] + return product_id + + print(f"no product with id {product_id}") + return None diff --git a/src/part3/run_admin.py b/src/part3/run_admin.py new file mode 100644 index 00000000..5608f2e3 --- /dev/null +++ b/src/part3/run_admin.py @@ -0,0 +1,112 @@ +from decimal import Decimal, InvalidOperation +from typing import Final + +from .crud import ( + create_product, + delete_product, + read_product, + update_product, +) +from .storage import Product +from .utils import get_storage_str_representation + + +PROMPT: Final[str] = "admin> " +HELP_TEXT: Final[str] = """Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + +For create and update the price and quantity are the last two words of the +line; everything before them is the product name, so it may contain spaces +(for example "Gibson SG Junior") and needs no quoting.""" + + +def show_help() -> None: + print(HELP_TEXT) + + +def print_result(result: object) -> None: + if result is not None: + print(result) + + +def run_command(storage: list[Product], line: str) -> bool: + words = line.split() + if not words: + return True + + command = words[0] + + if command == "help" and len(words) == 1: + show_help() + return True + + if command == "exit" and len(words) == 1: + return False + + if command == "show" and len(words) == 1: + print_result(get_storage_str_representation(storage)) + return True + + if command == "create": + if len(words) < 4: + print(f"{line!r} is not a command") + return True + name = " ".join(words[1:-2]) + price = Decimal(words[-2]) + quantity = int(words[-1]) + print_result(create_product(storage, (name, price, quantity))) + return True + + if command == "read": + if len(words) != 2: + print(f"{line!r} is not a command") + return True + product_id = int(words[1]) + print_result(read_product(storage, product_id)) + return True + + if command == "update": + if len(words) < 5: + print(f"{line!r} is not a command") + return True + product_id = int(words[1]) + name = " ".join(words[2:-2]) + price = Decimal(words[-2]) + quantity = int(words[-1]) + print_result(update_product(storage, product_id, (name, price, quantity))) + return True + + if command == "delete": + if len(words) != 2: + print(f"{line!r} is not a command") + return True + product_id = int(words[1]) + print_result(delete_product(storage, product_id)) + return True + + print(f"{line!r} is not a command") + return True + + +def main() -> None: + storage: list[Product] = [] + running = True + + while running: + line = input(PROMPT).strip() + + try: + running = run_command(storage, line) + + except (ValueError, InvalidOperation): + print(f"{line!r} names a command but its arguments are invalid") + + +if __name__ == "__main__": + main() diff --git a/src/part3/storage.py b/src/part3/storage.py new file mode 100644 index 00000000..81651a75 --- /dev/null +++ b/src/part3/storage.py @@ -0,0 +1,12 @@ +from decimal import Decimal +from typing import Final + + +type Product = tuple[int, str, Decimal, int] + +PRODUCT_ID_INDEX: Final = 0 +NAME_INDEX: Final = 1 +PRICE_INDEX: Final = 2 +QUANTITY_INDEX: Final = 3 + +PRODUCT_ID_MIN: Final[int] = 1 diff --git a/src/part3/utils.py b/src/part3/utils.py new file mode 100644 index 00000000..9b2b1a72 --- /dev/null +++ b/src/part3/utils.py @@ -0,0 +1,39 @@ +from decimal import ROUND_HALF_UP, Decimal +from typing import Final + +from .storage import Product + + +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final[Decimal] = Decimal(1).scaleb(-PRICE_PRECISION) +TABLE_HEADERS: Final[tuple[str, str, str, str]] = ("ID", "name", "price", "quantity") + + +def normalize_price(price: Decimal) -> Decimal: + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) + + +def normalize_product_name(name: str) -> str: + return " ".join(name.split()).lower() + + +def get_storage_str_representation(storage: list[Product]) -> str: + rows: list[tuple[str, str, str, str]] = [ + (str(product[0]), product[1], str(product[2]), str(product[3])) + for product in storage + ] + widths: list[int] = [ + max(len(header), *(len(row[i]) for row in rows)) if rows else len(header) + for i, header in enumerate(TABLE_HEADERS) + ] + header_line = ( + "|" + + "|".join(f" {cell:<{width}} " for cell, width in zip(TABLE_HEADERS, widths)) + + "|" + ) + dop_line = "|" + "|".join("-" * (width + 2) for width in widths) + "|" + data_lines = [ + "|" + "|".join(f" {cell:<{width}} " for cell, width in zip(row, widths)) + "|" + for row in rows + ] + return "\n".join([header_line, dop_line, *data_lines]) diff --git a/src/part4/TASK.md b/src/part4/TASK.md new file mode 100644 index 00000000..6857ed0c --- /dev/null +++ b/src/part4/TASK.md @@ -0,0 +1,411 @@ +# Задача: хранилище-словарь, UUID-идентификаторы, индекс имён и корзина-словарь + +## Легенда + +Наше хранилище товаров уже умеет немало: CRUD-операции, нормализацию имён и +цен, красивую таблицу и консоль администратора. Но устроено оно по-прежнему +«на коленке» — как список кортежей, — и пока каталог маленький, этого хватает. +Но когда в каталоге появляются тысячи товаров, начинают проявляться проблемы: + +- чтобы найти товар по идентификатору или проверить, не занято ли имя, надо + пройти весь список целиком, и чем больше каталог, тем медленнее работает + каждая операция; +- идентификатор вычисляется по содержимому хранилища («максимальный плюс + один»): его нельзя выдать независимо от остальных товаров, а два хранилища + (например, на разных серверах) легко выдадут одинаковые номера; +- поля кортежа различаются только позицией, поэтому в коде появляются + «магические» индексы, а чтобы поменять одно поле, приходится пересобирать + запись целиком. + +Обычные решения этих проблем знакомы любой базе данных. Записи хранят как +«ключ → значение» в хеш-таблице, где поиск по ключу не зависит от размера +хранилища. Рядом держат индекс — в СУБД это, например, уникальный индекс по +имени. А идентификаторы генерируют так, чтобы каждый узел мог выдавать их сам, +не согласовывая номера с остальными: в части 1 вы уже писали для этого +Snowflake, а UUID — самый распространённый стандартный вариант. + +Именно это мы и напишем: переведём хранилище на словари, заведём +UUID-идентификаторы и отдельный индекс имён, научим `update_product` +менять только нужные поля и оформим корзину покупателя тоже в виде словаря. +Получившееся хранилище станет основой, на которую опирается дальнейшая работа над магазином. + +## Контекст + +Часть 4 продолжает [часть 3](../part3/TASK.md): тот же интернет-магазин, те же +CRUD-операции, та же нормализация имён и цен, та же отрисовка таблицей и та же +консоль администратора. То, что в этой части не меняется, берите из своего +решения части 3. Меняется устройство данных: + +- хранилище — уже не список кортежей, а **словарь** «идентификатор → запись», + а сама запись — словарь с именованными полями; +- идентификатор товара — **строка с UUID**, а не порядковое целое число; +- рядом с хранилищем передаётся **индекс имён** — множество нормализованных + имён, которые сейчас есть в хранилище. Проверка уникальности имени идёт по + нему, без перебора всех записей; +- `update_product` может менять **любую часть** полей, а не все три сразу; +- корзина — тоже словарь «идентификатор товара → количество»; модуль `cart.py` + из [части 2](../part2/TASK.md), который в части 3 не использовался, снова + входит в задание. + +Модули: + +- `storage.py` — новая форма записи и новые константы; +- `utils.py` — логика **без изменений относительно части 3** + (`PRICE_PRECISION`, `PRICE_STEP`, `TABLE_HEADERS`, `normalize_price`, + `normalize_product_name`, `get_storage_str_representation`) — используйте своё + решение части 3; меняется только тип хранилища (см. ниже); +- `crud.py` — все функции дорабатываются под новое хранилище и индекс имён; +- `cart.py` — корзина из части 2, переделанная под словари; +- `run_admin.py` — консоль из части 3, переделанная под новые сигнатуры. + +Если поведение не менялось, оно здесь не расписывается: реализуйте его так, как +в своём решении части 3 (для корзины — части 2), см. +[описание части 3](../part3/TASK.md) и [описание части 2](../part2/TASK.md). + +Как и раньше, при неудаче функции `crud.py` и `cart.py` печатают сообщение в +stdout, возвращают `None` и ничего не меняют. + +--- + +## Формат данных + +### Хранилище + +`storage: dict[str, Product]` — словарь, где ключ — идентификатор товара (строка +с UUID, например `"3f2c…-…"`), а значение — запись `Product`. Идентификатор +хранится **только в ключе**, внутри записи его нет. + +Запись `Product` — словарь ровно с тремя ключами: + +| Ключ | Тип | Что хранит | +| ------------ | --------- | -------------------------------------------------------------------- | +| `"name"` | `str` | имя товара в нормализованной форме, уникальное в пределах хранилища | +| `"price"` | `Decimal` | цена за единицу, округлённая через `normalize_price` | +| `"quantity"` | `int` | сколько единиц товара на складе | + +### Индекс имён + +`product_names: set[str]` — множество нормализованных имён всех товаров, +которые сейчас лежат в хранилище. Индекс всегда должен совпадать с набором +имён в `storage`. Каждая функция, которая меняет хранилище, получает индекс +вторым аргументом и после каждого успешного вызова поддерживает его в +актуальном виде. Хранилище и индекс передаются двумя отдельными аргументами, +в один объект их не объединяют. + +### Корзина + +`cart: dict[str, int]` — словарь «идентификатор товара → количество единиц в +корзине». Товары с нулевым количеством в корзине не хранятся: если количество +падает до нуля, ключ удаляется. + +--- + +## Модуль `storage.py` + +- `Product` — псевдоним типа `dict[str, Any]`. +- `NAME_KEY`, `PRICE_KEY`, `QUANTITY_KEY` — имена полей записи: `"name"`, + `"price"`, `"quantity"`. Каждая константа аннотирована `typing.Final`. Код + обращается к полям записи только через эти константы, а не через строковые + литералы. + +По сравнению с частью 3 константы `PRODUCT_ID_INDEX`, `NAME_INDEX`, +`PRICE_INDEX`, `QUANTITY_INDEX` и `PRODUCT_ID_MIN` больше не нужны — не +определяйте их. + +--- + +## Модуль `utils.py` + +Поведение всех функций прежнее. Меняется только тип хранилища в +`get_storage_str_representation(storage: dict[str, Product]) -> str`: + +- в столбец `ID` попадает ключ словаря (строка UUID, выводится как есть); + столбцы `name`, `price`, `quantity` берутся из соответствующих полей записи + (`price` и `quantity` — через `str(...)`); +- строки товаров идут **в порядке вставки** в словарь; +- формат таблицы, расчёт ширины столбцов и вид пустой таблицы — как в части 3. + +--- + +## Модуль `crud.py` + +### `generate_product_id() -> str` + +- **Вход:** ничего. Хранилище больше не передаётся. +- **Выход:** новый случайный UUID в виде строки. Результат можно разобрать + через `uuid.UUID(...)`, а два вызова дают разные значения. Идентификатор + не зависит ни от порядка вставки, ни от уже занятых идентификаторов. + +> **Подсказка.** Не придумывайте генерацию сами: в стандартной библиотеке +> есть модуль `uuid`, а в нём функция `uuid4()`, которая возвращает случайный +> UUID. Не забудьте превратить результат в строку. + +**Примеры.** Сами значения случайны, поэтому в комментариях указаны не они, а +свойства результата: + +```python +product_id = generate_product_id() + +print(product_id) # например: 3f2c9a4e-8b1d-4c7a-9e55-0d6a1b7c2f10 +print(type(product_id)) # +print(len(product_id)) # 36 +print(uuid.UUID(product_id).version) # 4 (строка разбирается как UUID) +``` + +Два вызова подряд дают разные идентификаторы: + +```python +first_id = generate_product_id() +second_id = generate_product_id() + +print(first_id == second_id) # False +``` + +### `create_product(storage: dict[str, Product], product_names: set[str], fields: dict[str, Any]) -> str | None` + +- **Вход:** хранилище, индекс имён и `fields` — словарь, где **обязательно** + есть все три ключа: `NAME_KEY`, `PRICE_KEY` (`Decimal`) и `QUANTITY_KEY` + (`int`). +- **Выход:** идентификатор нового товара или `None`. + +Шаги выполняются в таком порядке. Шаги 2 и 3 — проверки: если любая из них не +проходит, хранилище и индекс не меняются. + +1. Имя пропускается через `normalize_product_name`. +2. Если нормализованное имя пустое, печатается `product name must not be blank` + и возвращается `None`. +3. Если нормализованное имя уже есть в `product_names`, печатается + `product name '<имя>' is already taken` и возвращается `None`. Имена + сравниваются по нормализованной форме, поэтому `" Cordless Drill "` + конфликтует с `"cordless drill"`. +4. Иначе через `generate_product_id()` создаётся новый идентификатор, и под ним + в `storage` кладётся запись `{name: нормализованное имя, price: + normalize_price(цена), quantity: количество}`. Нормализованное имя + добавляется в `product_names`, функция возвращает идентификатор. + +**Примеры.** Каждый пример — отдельный фрагмент скрипта, который начинается с +пустого хранилища и пустого индекса. Идентификатор случаен, поэтому у вас +в выводе будет другой UUID — это нормально. + +Успешное создание: имя нормализуется, цена округляется, имя попадает в индекс: + +```python +storage: dict[str, Product] = {} +product_names: set[str] = set() + +product_id = create_product( + storage, + product_names, + {NAME_KEY: " Cordless Drill ", PRICE_KEY: Decimal("89.999"), QUANTITY_KEY: 12}, +) + +print(product_id) # 3f2c9a4e-8b1d-4c7a-9e55-0d6a1b7c2f10 +print(storage) +# { +# '3f2c9a4e-8b1d-4c7a-9e55-0d6a1b7c2f10': { +# 'name': 'cordless drill', +# 'price': Decimal('90.00'), +# 'quantity': 12 +# } +# } +print(product_names) # {'cordless drill'} +``` + +Имя уже есть в индексе (сравнение идёт по нормализованной форме), хранилище и +индекс не меняются: + +```python +storage: dict[str, Product] = {} +product_names: set[str] = set() + +create_product( + storage, + product_names, + {NAME_KEY: "cordless drill", PRICE_KEY: Decimal("50"), QUANTITY_KEY: 3}, +) +result = create_product( + storage, + product_names, + {NAME_KEY: " CORDLESS DRILL ", PRICE_KEY: Decimal("75"), QUANTITY_KEY: 1}, +) +# печатает: product name 'cordless drill' is already taken + +print(result) # None +print(len(storage)) # 1 +print(product_names) # {'cordless drill'} +``` + +### `read_product(storage: dict[str, Product], product_id: str) -> Product | None` + +- **Вход:** хранилище и идентификатор (строка). +- **Выход:** запись, которая лежит под этим ключом. Если такого ключа нет, + печатается `no product with id ` и возвращается `None`. + +### `update_product(storage: dict[str, Product], product_names: set[str], product_id: str, fields: dict[str, Any]) -> Product | None` + +**Частичное обновление:** в `fields` может быть любое подмножество ключей +`NAME_KEY`, `PRICE_KEY` и `QUANTITY_KEY`. Поля без ключа в `fields` сохраняют +текущее значение, поэтому, например, можно поменять одно количество, не +передавая имя и цену. Идентификатор (ключ в `storage`) не меняется. + +Шаги выполняются в таком порядке. Шаги 1 и 2 содержат проверки: если любая из +них не проходит, хранилище и индекс не меняются. **Порядок изменился по +сравнению с частью 3:** сначала проверяется, есть ли товар с таким +идентификатором. + +1. Если ключа `product_id` в `storage` нет, печатается + `no product with id ` и возвращается `None`. +2. Если в `fields` есть имя, оно нормализуется через `normalize_product_name`. + - Если нормализованное имя пустое, печатается + `product name must not be blank` и возвращается `None`. + - Если нормализованное имя отличается от текущего имени товара и уже есть + в `product_names`, печатается `product name '<имя>' is already taken` и + возвращается `None`. Переименование товара в его же текущее имя + конфликтом не считается. +3. Если в `fields` есть цена, она округляется через `normalize_price`. +4. Поля из `fields` записываются в запись товара. Если имя изменилось, старое + имя удаляется из `product_names`, а новое добавляется. Обновление без + переименования индекс не меняет. +5. Возвращается обновлённая запись, то есть тот же объект, который лежит в + `storage[product_id]`. + +Побочный эффект: переданный словарь `fields` меняется на месте. Имя и цена в +нём заменяются нормализованными значениями. + +**Пример.** Сначала меняется одно количество, затем товар переименовывается +вместе с новой ценой. Идентификатор случаен, поэтому у вас в выводе будет +другой UUID — это нормально: + +```python +storage: dict[str, Product] = {} +product_names: set[str] = set() + +product_id = create_product( + storage, + product_names, + {NAME_KEY: "Cordless Drill", PRICE_KEY: Decimal("89.99"), QUANTITY_KEY: 12}, +) +print(product_id) # 3f2c9a4e-8b1d-4c7a-9e55-0d6a1b7c2f10 + +# Частичное обновление: меняется только количество, индекс имён остаётся прежним +print(update_product(storage, product_names, product_id, {QUANTITY_KEY: 7})) +# { +# 'name': 'cordless drill', +# 'price': Decimal('89.99'), +# 'quantity': 7 +# } +print(product_names) # {'cordless drill'} + +# Переименование: имя и цена нормализуются, в индексе старое имя заменяется новым +print( + update_product( + storage, + product_names, + product_id, + {NAME_KEY: " Hammer Drill ", PRICE_KEY: Decimal("109.999")}, + ) +) +# { +# 'name': 'hammer drill', +# 'price': Decimal('110.00'), +# 'quantity': 7 +# } +print(product_names) # {'hammer drill'} +``` + +### `delete_product(storage: dict[str, Product], product_names: set[str], product_id: str) -> str | None` + +- **Вход:** хранилище, индекс имён, идентификатор. +- **Выход:** `product_id`, если товар был удалён. В этом случае его имя + убирается из `product_names`. Если ключа нет, печатается + `no product with id ` и возвращается `None`; хранилище и индекс не + меняются. + +--- + +## Модуль `cart.py` + +По сравнению с частью 2 здесь нет типа `CartLine` и констант `LINE_*_INDEX`: +корзина — обычный словарь `dict[str, int]` (см. «Формат данных»). Вспомогательные +функции можно добавлять на своё усмотрение. Обе функции возвращают теперь не +строку корзины, а **количество** единиц товара в корзине после операции. Обе +принимают индекс имён вместе с хранилищем. Сам индекс при этом не меняется: +при изменении одного количества имя товара не меняется. + +### `add_to_cart(storage: dict[str, Product], product_names: set[str], cart: dict[str, int], product_id: str, quantity: int) -> int | None` + +Переносит `quantity` единиц товара со склада в корзину. Проверки идут в таком +порядке (если какая-то не проходит, склад и корзина не меняются): + +1. Если товара с таким идентификатором нет в хранилище, печатается + `no product with id ` и возвращается `None`. +2. Если на складе **строго меньше** `quantity` единиц, печатается + `not enough stock for product : <на складе> available, requested` + и возвращается `None`. Можно запросить ровно столько, сколько есть на + складе: тогда остаток станет `0`, но запись останется в хранилище. + +Если обе проверки пройдены, количество товара на складе уменьшается на +`quantity`, остальные поля записи не меняются. В корзине количество этого +товара увеличивается на `quantity`; если товара в корзине не было, для него +появляется ключ. Возвращается новое количество товара в корзине. + +### `remove_from_cart(storage: dict[str, Product], product_names: set[str], cart: dict[str, int], product_id: str, quantity: int) -> int | None` + +Переносит `quantity` единиц товара из корзины обратно на склад. Проверки идут +в таком порядке (если какая-то не проходит, склад и корзина не меняются): + +1. Если `product_id` нет в корзине, печатается + `product is not in the cart` и возвращается `None`. +2. Если в корзине **строго меньше** `quantity` единиц, печатается + `cart holds only <в корзине> unit(s) of product , cannot remove ` + и возвращается `None`. +3. Если товара с таким идентификатором нет в хранилище, печатается + `no product with id ` и возвращается `None`. + +Если все три проверки пройдены, количество товара на складе увеличивается на +`quantity`, остальные поля записи не меняются, а в корзине количество +уменьшается на `quantity`. Если в корзине осталось `0`, ключ удаляется. +Возвращается оставшееся в корзине количество; `0` значит, что товар из корзины +убран. + +--- + +## Модуль `run_admin.py` + +Набор команд, формат ввода, константы `PROMPT` и `HELP_TEXT`, функции +`show_help` и `print_result`, сообщения `'<строка>' is not a command` и +`'<строка>' names a command but its arguments are invalid`, а также обработка +`ValueError` и `decimal.InvalidOperation` такие же, как в части 3. Отличия: + +- `run_command(storage: dict[str, Product], product_names: set[str], line: str) -> bool` + дополнительно принимает индекс имён и передаёт его в `create_product`, + `update_product` и `delete_product`. +- `` в командах `read`, `update` и `delete` **не приводится к `int`**, а + передаётся строкой как есть. Поэтому неверный идентификатор уже не вызывает + исключение: `crud.py` просто печатает `no product with id `. +- Для `create` и `update` аргументы собираются в словарь + `{NAME_KEY: имя, PRICE_KEY: Decimal(цена), QUANTITY_KEY: int(количество)}`. + Консольный `update` всегда передаёт все три поля. +- `main()` создаёт пустое хранилище `{}` и пустой индекс `set()`, держит их в + памяти всю сессию и передаёт в каждый вызов `run_command`. Остальное + поведение цикла такое же, как в части 3. + +--- + +## Инварианты + +- `product_names` всегда равно множеству `{запись["name"] for запись in + storage.values()}`: каждый успешный `create_product`, `update_product` с + переименованием и `delete_product` поддерживает это равенство, а неуспешный + вызов не меняет ни хранилище, ни индекс. +- Все сохранённые имена нормализованы и уникальны с точностью до нормализации. +- Все сохранённые цены прошли через `normalize_price`. +- Для успешно созданного товара `read_product(storage, id)` возвращает + `{"name": normalize_product_name(name), "price": normalize_price(price), + "quantity": quantity}`. +- После `delete_product(storage, product_names, id)` вызов + `read_product(storage, id)` возвращает `None`. +- Количество сохраняется: после успешного `add_to_cart` или `remove_from_cart` + сумма «на складе + в корзине» для этого товара не меняется. Если после + `add_to_cart` вызвать `remove_from_cart` с тем же `quantity`, склад и + корзина вернутся в исходное состояние. diff --git a/src/part4/__init__.py b/src/part4/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/src/part4/cart.py b/src/part4/cart.py new file mode 100644 index 00000000..7e9665eb --- /dev/null +++ b/src/part4/cart.py @@ -0,0 +1,63 @@ +from .storage import ( + QUANTITY_KEY, + Product, +) + + +def add_to_cart( + storage: dict[str, Product], + product_names: set[str], + cart: dict[str, int], + product_id: str, + quantity: int, +) -> int | None: + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + available = product[QUANTITY_KEY] + if available < quantity: + print( + f"not enough stock for product {product_id}: " + f"{available} available, {quantity} requested" + ) + return None + + product[QUANTITY_KEY] = available - quantity + cart[product_id] = cart.get(product_id, 0) + quantity + return cart[product_id] + + +def remove_from_cart( + storage: dict[str, Product], + product_names: set[str], + cart: dict[str, int], + product_id: str, + quantity: int, +) -> int | None: + if product_id not in cart: + print(f"product {product_id} is not in the cart") + return None + + in_cart = cart[product_id] + if in_cart < quantity: + print( + f"cart holds only {in_cart} unit(s) of product {product_id}, " + f"cannot remove {quantity}" + ) + return None + + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + product[QUANTITY_KEY] = product[QUANTITY_KEY] + quantity + + remaining = in_cart - quantity + if remaining == 0: + del cart[product_id] + else: + cart[product_id] = remaining + return remaining diff --git a/src/part4/crud.py b/src/part4/crud.py new file mode 100644 index 00000000..30494a2a --- /dev/null +++ b/src/part4/crud.py @@ -0,0 +1,98 @@ +from typing import Any +from uuid import uuid4 + +from .storage import ( + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) +from .utils import normalize_price, normalize_product_name + + +def generate_product_id() -> str: + return str(uuid4()) + + +def create_product( + storage: dict[str, Product], + product_names: set[str], + fields: dict[str, Any], +) -> str | None: + name = normalize_product_name(fields[NAME_KEY]) + if not name: + print("product name must not be blank") + return None + if name in product_names: + print(f"product name '{name}' is already taken") + return None + product_id = generate_product_id() + storage[product_id] = { + NAME_KEY: name, + PRICE_KEY: normalize_price(fields[PRICE_KEY]), + QUANTITY_KEY: fields[QUANTITY_KEY], + } + product_names.add(name) + return product_id + + +def read_product(storage: dict[str, Product], product_id: str) -> Product | None: + product = storage.get(product_id) + if product is not None: + return product + + print(f"no product with id {product_id}") + return None + + +def update_product( + storage: dict[str, Product], + product_names: set[str], + product_id: str, + fields: dict[str, Any], +) -> Product | None: + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + old_name = product[NAME_KEY] + new_name: str | None = None + + if NAME_KEY in fields: + name = normalize_product_name(fields[NAME_KEY]) + if not name: + print("product name must not be blank") + return None + if name != old_name and name in product_names: + print(f"product name '{name}' is already taken") + return None + new_name = name + fields[NAME_KEY] = name + + if PRICE_KEY in fields: + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + + for key in (NAME_KEY, PRICE_KEY, QUANTITY_KEY): + if key in fields: + product[key] = fields[key] + + if new_name is not None and new_name != old_name: + product_names.discard(old_name) + product_names.add(new_name) + + return product + + +def delete_product( + storage: dict[str, Product], + product_names: set[str], + product_id: str, +) -> str | None: + if product_id in storage: + product_names.discard(storage[product_id][NAME_KEY]) + del storage[product_id] + return product_id + + print(f"no product with id {product_id}") + return None diff --git a/src/part4/run_admin.py b/src/part4/run_admin.py new file mode 100644 index 00000000..cd70759a --- /dev/null +++ b/src/part4/run_admin.py @@ -0,0 +1,128 @@ +from decimal import Decimal, InvalidOperation +from typing import Final + +from .crud import ( + create_product, + delete_product, + read_product, + update_product, +) +from .storage import NAME_KEY, PRICE_KEY, QUANTITY_KEY, Product +from .utils import get_storage_str_representation + + +PROMPT: Final[str] = "admin> " +HELP_TEXT: Final[str] = """Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + +For create and update the price and quantity are the last two words of the +line; everything before them is the product name, so it may contain spaces +(for example "Gibson SG Junior") and needs no quoting.""" + + +def show_help() -> None: + print(HELP_TEXT) + + +def print_result(result: object) -> None: + if result is not None: + print(result) + + +def run_command( + storage: dict[str, Product], product_names: set[str], line: str +) -> bool: + words = line.split() + if not words: + return True + + command = words[0] + + if command == "help" and len(words) == 1: + show_help() + return True + + if command == "exit" and len(words) == 1: + return False + + if command == "show" and len(words) == 1: + print_result(get_storage_str_representation(storage)) + return True + + if command == "create": + if len(words) < 4: + print(f"{line!r} is not a command") + return True + name = " ".join(words[1:-2]) + price = Decimal(words[-2]) + quantity = int(words[-1]) + print_result( + create_product( + storage, + product_names, + {NAME_KEY: name, PRICE_KEY: price, QUANTITY_KEY: quantity}, + ) + ) + return True + + if command == "read": + if len(words) != 2: + print(f"{line!r} is not a command") + return True + product_id = words[1] + print_result(read_product(storage, product_id)) + return True + + if command == "update": + if len(words) < 5: + print(f"{line!r} is not a command") + return True + product_id = words[1] + name = " ".join(words[2:-2]) + price = Decimal(words[-2]) + quantity = int(words[-1]) + print_result( + update_product( + storage, + product_names, + product_id, + {NAME_KEY: name, PRICE_KEY: price, QUANTITY_KEY: quantity}, + ) + ) + return True + + if command == "delete": + if len(words) != 2: + print(f"{line!r} is not a command") + return True + product_id = words[1] + print_result(delete_product(storage, product_names, product_id)) + return True + + print(f"{line!r} is not a command") + return True + + +def main() -> None: + storage: dict[str, Product] = {} + product_names: set[str] = set() + running = True + + while running: + line = input(PROMPT).strip() + + try: + running = run_command(storage, product_names, line) + + except (ValueError, InvalidOperation): + print(f"{line!r} names a command but its arguments are invalid") + + +if __name__ == "__main__": + main() diff --git a/src/part4/storage.py b/src/part4/storage.py new file mode 100644 index 00000000..048ce1b6 --- /dev/null +++ b/src/part4/storage.py @@ -0,0 +1,8 @@ +from typing import Any, Final + + +type Product = dict[str, Any] + +NAME_KEY: Final[str] = "name" +PRICE_KEY: Final[str] = "price" +QUANTITY_KEY: Final[str] = "quantity" diff --git a/src/part4/utils.py b/src/part4/utils.py new file mode 100644 index 00000000..f2a104ff --- /dev/null +++ b/src/part4/utils.py @@ -0,0 +1,49 @@ +from decimal import ROUND_HALF_UP, Decimal +from typing import Final + +from .storage import ( + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) + + +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final[Decimal] = Decimal(1).scaleb(-PRICE_PRECISION) +TABLE_HEADERS: Final[tuple[str, str, str, str]] = ("ID", "name", "price", "quantity") + + +def normalize_price(price: Decimal) -> Decimal: + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) + + +def normalize_product_name(name: str) -> str: + return " ".join(name.split()).lower() + + +def get_storage_str_representation(storage: dict[str, Product]) -> str: + rows: list[tuple[str, str, str, str]] = [ + ( + product_id, + product[NAME_KEY], + str(product[PRICE_KEY]), + str(product[QUANTITY_KEY]), + ) + for product_id, product in storage.items() + ] + widths: list[int] = [ + max(len(header), *(len(row[i]) for row in rows)) if rows else len(header) + for i, header in enumerate(TABLE_HEADERS) + ] + header_line = ( + "|" + + "|".join(f" {cell:<{width}} " for cell, width in zip(TABLE_HEADERS, widths)) + + "|" + ) + dop_line = "|" + "|".join("-" * (width + 2) for width in widths) + "|" + data_lines = [ + "|" + "|".join(f" {cell:<{width}} " for cell, width in zip(row, widths)) + "|" + for row in rows + ] + return "\n".join([header_line, dop_line, *data_lines]) diff --git a/src/part5/TASK.md b/src/part5/TASK.md new file mode 100644 index 00000000..c3fa0ec2 --- /dev/null +++ b/src/part5/TASK.md @@ -0,0 +1,557 @@ +# Задача: Snowflake-идентификаторы для интернет-магазина + +## Легенда + +Наш интернет-магазин уже умеет многое: товары лежат в хранилище-словаре, есть +индекс имён, операции над хранилищем (создание, чтение, изменение и удаление +товаров), операции с корзиной (добавить товар и убрать товар) и консоль +администратора. Идентификаторы товаров при этом выдаются как UUID. Пока магазин +небольшой, этого хватает. Но по мере роста появляются новые неудобства: + +- UUID — случайная строка из 36 символов: по ней нельзя понять, какой товар + появился раньше, а ключи, которые хотя бы примерно растут со временем, + хранить и сравнивать дешевле; +- Snowflake из части 1 решает эту проблему, но `generate_snowflake_id` не + запоминала, сколько идентификаторов уже выдано в текущую миллисекунду: номер + внутри миллисекунды (`sequence_id`) приходилось передавать ей аргументом. Если + товары создаются в нескольких местах программы, каждому месту пришлось бы + вести свой счётчик, и два места легко выдали бы одинаковые идентификаторы; +- мы совсем не видим, как используется наше хранилище: какие операции + выполняются чаще всего и сколько вызовов заканчиваются неудачей. + +Первые две проблемы знакомы любой системе, где идентификаторы выдаются «на лету»: +поэтому Twitter и сделал Snowflake, а в реальных проектах генератор обычно +оформляют как отдельный объект, который сам помнит своё состояние. Третья +проблема тоже типична: такие счётчики вызовов в промышленных системах называют +метриками, и собирают их не внутри самих операций, а «снаружи», не меняя код +операций. + +В этой части мы займёмся решением этих проблем: напишем генератор Snowflake, +который сам ведёт счётчик, переведём товары на целочисленные идентификаторы и +научимся считать успешные и неуспешные вызовы операций хранилища, не меняя их +код. Результат будет использоваться в дальнейшей работе над магазином как основа +для всего, что мы построим поверх него. + +## Контекст + +Часть 5 продолжает [часть 4](../part4/TASK.md): тот же интернет-магазин, то же +хранилище-словарь, тот же индекс имён, те же CRUD-операции, те же операции +с корзиной и консоль администратора. Меняется **источник идентификаторов**. Вместо случайного UUID +(строки) товар получает целое число в формате +[Twitter Snowflake](https://en.wikipedia.org/wiki/Snowflake_ID): оно растёт со +временем создания, поэтому товары примерно упорядочены по порядку добавления. + +Модули `constants.py` и `snowflake.py` переходят из [части 1](../part1/TASK.md). +Формат идентификатора, константы, `read_current_millis` и три декодера остаются +прежними. Что меняется: + +- в `snowflake.py` функция `generate_snowflake_id(sequence_id, node_id, + epoch_ms)`, где счётчик внутри миллисекунды вёл вызывающий код, заменяется + функцией `get_snowflake_id_generator(node_id, epoch_ms)`. Она возвращает + другую функцию без аргументов, при каждом вызове которой получается новый + идентификатор. Счётчик внутри миллисекунды эта функция ведёт сама; +- `create_product` больше не вызывает функцию генерации идентификатора + напрямую: раньше она была жёстко прописана в его теле, теперь её передают + аргументом `generate_id`. Так алгоритм выдачи идентификаторов можно заменить, + не трогая код самой операции; +- идентификатор товара — `int`, а не `str`. Это касается хранилища, корзины, + консоли и всех сигнатур; +- в `crud.py` появляется функция `generate_snowflake_id()`: она выдаёт + Snowflake-идентификаторы через общий генератор модуля и подходит в качестве + аргумента `generate_id` для `create_product`. Функция `generate_product_id`, + выдававшая UUID в части 4, удаляется. + +Кроме смены идентификаторов, в части 5 появляется **учёт статистики вызовов**: + +- новый модуль `decorators.py` с параметрическим декоратором `collect_stats`, + который считает, сколько раз декорируемая функция отработала успешно, а + сколько раз неуспешно. Счётчики он складывает в общий словарь — реестр; +- четыре операции `crud.py` (`create_product`, `read_product`, `update_product`, + `delete_product`) обёрнуты этим декоратором, а их счётчики лежат в реестре + `STATS_REGISTRY`; +- в `utils.py` появляется функция `get_stats_str_representation`: она берёт + реестр `STATS_REGISTRY` и возвращает строку с текстовой таблицей в том же + формате, что и таблица товаров из части 3. В таблице одна строка на операцию: + сколько вызовов было успешных, сколько неуспешных и какую долю составляют + успешные; +- в консоли администратора появляется команда `stats`, которая выводит на экран + таблицу статистики, полученную из `get_stats_str_representation`. + +Если поведение не менялось, оно здесь не расписывается: реализуйте его так, как +в своём решении части 4, см. [описание части 4](../part4/TASK.md). Это относится к формату записи товара, индексу имён, +нормализации имён и цен и порядку шагов в `update_product`, `delete_product`, +`read_product` и в корзине. Единственное изменение в этих местах — тип +идентификатора. + +--- + +## Формат идентификатора и модуль `constants.py` + +Без изменений относительно части 1: идентификатор — положительное целое число, +меньшее `2**63`. В него упакованы три поля: время (41 бит), номер узла (10 бит) +и счётчик внутри миллисекунды (12 бит). Константы те же: `EPOCH_MS_DEFAULT`, +`NODE_ID_DEFAULT`, `TIMESTAMP_BITS`, `NODE_ID_BITS`, `SEQUENCE_ID_BITS`, +`TIMESTAMP_MS_MAX`, `NODE_ID_MAX`, `SEQUENCE_ID_MAX`, с теми же значениями и +правилом «максимумы выводятся из ширин». + +--- + +## Модуль `snowflake.py` + +Функции `read_current_millis(epoch_ms)`, `decode_timestamp_ms(snowflake_id, +epoch_ms)`, `decode_node_id(snowflake_id)` и `decode_sequence_id(snowflake_id)` +остаются такими же, как в части 1. + +Текущее время нужно получать с помощью модуля `time` из стандартной +библиотеки. + +Функция `generate_snowflake_id` из части 1 больше не нужна: вместо неё +`get_snowflake_id_generator`, описанная ниже. + +### `get_snowflake_id_generator(node_id: int = NODE_ID_DEFAULT, epoch_ms: int = EPOCH_MS_DEFAULT) -> Callable[[], int | None] | None` + +Один раз проверяет настройки и возвращает функцию без аргументов, которую +дальше называем **генератором**. Каждый вызов генератора выдаёт следующий +идентификатор. + +По сравнению с частью 1 проверка `node_id` теперь выполняется при создании +генератора, а не при выдаче идентификатора. Появилась новая проверка эпохи. +Проверка `sequence_id` превратилась в проверку «счётчик исчерпан», потому что +счётчик теперь ведёт сам генератор. + +- **Вход:** `node_id` — номер машины, от `0` до `NODE_ID_MAX` включительно; + `epoch_ms` — эпоха в миллисекундах Unix. Оба аргумента необязательные, значения + по умолчанию — `NODE_ID_DEFAULT` и `EPOCH_MS_DEFAULT`. +- **Выход:** генератор или `None`. + +Проверки при создании идут в таком порядке. Создание генератора **не выдаёт ни +одного идентификатора** и ничего не печатает, если настройки верные. + +1. `node_id` вне `[0, NODE_ID_MAX]`. Верхняя граница включается, значит + `NODE_ID_MAX` ещё допустим, а `-1` и `NODE_ID_MAX + 1` нет. Печатается + `node_id must be in [0, ], got `, возвращается `None`. +2. Эпоха лежит в будущем, то есть `read_current_millis(epoch_ms) < 0`. + Печатается `epoch_ms must not be in the future, got `, + возвращается `None`. Эпоха ровно «сейчас» допустима. + +#### Что выдаёт генератор + +Каждый вызов генератора возвращает новый идентификатор в формате Snowflake ID +(см. часть 1). Время в нём отсчитывается от `epoch_ms`, номер узла равен `node_id` +генератора. + +- Под счётчиком здесь понимается `sequence_id` — порядковый номер + идентификатора внутри одной миллисекунды (последняя часть Snowflake ID). +- Первый идентификатор в миллисекунде получает `sequence_id = 0`, каждый + следующий в той же миллисекунде на единицу больше. В новой миллисекунде + `sequence_id` снова начинается с `0`. +- В одной миллисекунде можно получить `SEQUENCE_ID_MAX + 1` разных + идентификаторов, по одному на каждое значение `sequence_id`. +- Каждый генератор ведёт свой счёт, генераторы не влияют друг на друга. + +Особые случаи при вызове, в порядке проверок. Во всех случаях печатается +сообщение и возвращается `None`: + +1. **Счётчик исчерпан.** В одной миллисекунде запросили больше, чем + `SEQUENCE_ID_MAX + 1` идентификаторов. Каждый лишний вызов печатает + `sequence_id must be in [0, ], got `, где + `` — номер, до которого дошёл бы счётчик. В следующей + миллисекунде генератор снова выдаёт идентификаторы, начиная со счётчика `0`. +2. **Время не помещается в поле.** От эпохи прошло больше `TIMESTAMP_MS_MAX` + миллисекунд. Печатается `timestamp <прошло> ms overflows ms`, + где `<прошло>` — число миллисекунд от эпохи до текущего момента. Если + прошло ровно `TIMESTAMP_MS_MAX`, идентификатор ещё выдаётся. + +#### Примеры + +Генератор создаётся один раз, дальше его только вызывают. + +> **Важно:** идентификаторы зависят от текущего времени, поэтому числа в +> примерах взяты для иллюстрации. У вас значения будут другими. Неизменны +> только закономерности: номер узла, рост значений и поведение счётчика. + +Два вызова подряд, попавшие в одну и ту же миллисекунду. Номер узла у них +одинаковый, а счётчик внутри миллисекунды растёт с нуля: + +```python +generate_id = get_snowflake_id_generator(node_id=5) + +first = generate_id() +second = generate_id() + +print(first) # 2119399534088966144 +print(second) # 2119399534088966145 + +print(decode_timestamp_ms(first, EPOCH_MS_DEFAULT)) # 1794139200123 +print(decode_timestamp_ms(second, EPOCH_MS_DEFAULT)) # 1794139200123 +print(decode_node_id(first)) # 5 +print(decode_node_id(second)) # 5 +print(decode_sequence_id(first)) # 0 +print(decode_sequence_id(second)) # 1 +``` + +Если следующий вызов пришёлся уже на следующую миллисекунду, время в +идентификаторе увеличивается, а счётчик снова начинается с нуля: + +```python +third = generate_id() + +print(third) # 2119399534093160448 +print(decode_timestamp_ms(third, EPOCH_MS_DEFAULT)) # 1794139200124 +print(decode_sequence_id(third)) # 0 +``` + +Генераторы не влияют друг на друга: у каждого свой счётчик и свой номер +узла. + +```python +generate_a = get_snowflake_id_generator(node_id=1) +generate_b = get_snowflake_id_generator(node_id=2) + +print(generate_a()) # 2119399534101532672 (узел 1, счётчик 0) +print(generate_b()) # 2119399534101536768 (узел 2, счётчик 0) +``` + +Неверные настройки отвергаются при создании, до выдачи какого-либо +идентификатора: + +```python +generator = get_snowflake_id_generator(node_id=NODE_ID_MAX + 1) +# сама функция напечатает: node_id must be in [0, 1023], got 1024 + +print(generator) # None +``` + +--- + +## Модуль `decorators.py` + +В модуле определён один декоратор, который считает успешные и неуспешные вызовы +функции. Он ничего не знает о магазине: подойдёт любая функция, которая +возвращает значение либо `None`. + +### Типы и константы + +- `SUCCESS_KEY = "success"` и `FAILS_KEY = "fails"` — имена двух счётчиков + внутри записи статистики. +- `Stats` — псевдоним типа `dict[str, int]`: счётчики одной функции. В записи + ровно два ключа, `SUCCESS_KEY` (число успешных вызовов) и `FAILS_KEY` (число + неуспешных). +- `Registry` — псевдоним типа `dict[str, Stats]`: счётчики всех функций, ключ — + имя, под которым функцию зарегистрировали (например, имя консольной команды). + +### `collect_stats(key: str, registry: Registry) -> Callable` + +Фабрика декоратора: сама `collect_stats` декоратором не является, она +возвращает декоратор, настроенный на конкретный ключ и реестр. Этот декоратор +заменяет функцию обёрткой, которая для вызывающего кода выглядит так же, как +исходная функция (принимает те же аргументы и возвращает тот же результат), но +дополнительно считает вызовы. + +```python +registry = {} + +@collect_stats("divide", registry) +def divide(a, b): + if b == 0: + print("division by zero") + return None + return a / b + +print(registry) # {'divide': {'success': 0, 'fails': 0}} + +print(divide(10, 4)) # 2.5 +print(divide(0, 5)) # 0.0 (ложный результат, но не None: считается успехом) +print(divide(1, 0)) # division by zero (печатает сама divide) + # None + +print(registry) # {'divide': {'success': 2, 'fails': 1}} +``` + +- **Вход:** `key` — ключ в реестре, под которым будут лежать счётчики этой + функции; `registry` — словарь, в который будут попадать счётчики. Он меняется на месте при + декорировании и при каждом вызове. +- **Выход:** декоратор для функции, возвращающей значение либо `None`. + +**При декорировании** в `registry[key]` кладётся новая запись +`{"success": 0, "fails": 0}`. + +**При каждом вызове** обёртка вызывает исходную функцию с теми же позиционными +и именованными аргументами и возвращает её результат без изменений: + +- если функция вернула `None`, счётчик `FAILS_KEY` растёт на единицу; +- любой другой результат растит `SUCCESS_KEY`, **в том числе «ложный»**, такой + как `0`. + +После декорирования метаинформация функции не должна измениться: например, +имя (`__name__`) и описание (`__doc__`) остаются такими же, как у исходной +функции. + +**Ключ уже занят.** Если `key` уже есть в `registry`, при декорировании +печатается `stats key is already registered` (ключ в виде `repr`, +например `stats key 'create' is already registered`), а в качестве результата +возвращается **сама исходная функция без обёртки**. Существующая запись реестра +остаётся как была. Вызовы такой функции ни в какие счётчики не попадают. + +Разные ключи ведут независимые счётчики, даже если лежат в одном реестре. + +--- + +## Модуль `crud.py` + +### Статистика операций + +- `STATS_REGISTRY: Registry` — модульный реестр счётчиков. Живёт столько же, + сколько процесс, и общий для всех хранилищ. +- `CREATE_KEY = "create"`, `READ_KEY = "read"`, `UPDATE_KEY = "update"`, + `DELETE_KEY = "delete"` — ключи записей в реестре. Они совпадают с именами + консольных команд. +- Функции `create_product`, `read_product`, `update_product` и `delete_product` + декорируются `collect_stats`: каждая со своим ключом (`CREATE_KEY`, + `READ_KEY`, `UPDATE_KEY`, `DELETE_KEY`) и общим реестром `STATS_REGISTRY`. + Поэтому сразу после импорта модуля `STATS_REGISTRY` содержит **ровно четыре + записи, по одной на операцию**, и во всех записях счётчики нулевые: + + ```python + print(STATS_REGISTRY) + # {'create': {'success': 0, 'fails': 0}, + # 'read': {'success': 0, 'fails': 0}, + # 'update': {'success': 0, 'fails': 0}, + # 'delete': {'success': 0, 'fails': 0}} + ``` + + Вызов операции считается неуспешным, когда она вернула `None`, то есть + напечатала сообщение и ничего не изменила. +- `generate_snowflake_id` декоратором **не оборачивается**: её вызовы не меняют + ни одной записи реестра. +- Функции корзины (`add_to_cart` и `remove_from_cart`) не декорируются: + отдельной статистики у корзины нет. + +### `generate_snowflake_id() -> int | None` + +Адаптер между `create_product` и результатом `get_snowflake_id_generator` из +`snowflake.py`. `create_product` ожидает функцию без аргументов, которая +возвращает идентификатор или `None`. Но `get_snowflake_id_generator` при +некорректных настройках возвращает не функцию, а `None`, и такой результат +нельзя передать в `create_product` напрямую: вызов `None` приведёт к ошибке. +Поэтому между ними нужен адаптер: `generate_snowflake_id` всегда остаётся +вызываемой функцией, и `create_product` может вызывать её одинаково, независимо +от того, получился ли у `get_snowflake_id_generator` рабочий генератор или +`None`. Для этого она обращается к **общему (глобальному) генератору модуля** +и возвращает то, что он выдал, а если значение глобального генератора — `None`, возвращает `None`. + +В модуле `crud.py` один раз, при импорте, создаётся общий генератор: результат +`get_snowflake_id_generator()` с номером узла и эпохой по умолчанию. Имя +переменной, в которой он хранится, на ваше усмотрение. Функция +`generate_snowflake_id` использует этот созданный генератор напрямую: вызывает +его сама и не создаёт других. + +- **Вход:** ничего. +- **Выход:** + - если значение общего генератора не `None`, то результат его вызова, без + изменений. Это либо идентификатор (целое число больше нуля и меньше + `2**63`), либо `None`, если генератор не смог выдать идентификатор (счётчик + исчерпан или время не помещается в поле). В последнем случае сообщение + печатает сам генератор; + - если значение общего генератора — `None`, то `None`. Сама `generate_snowflake_id` + при этом ничего не печатает: сообщение уже было напечатано при создании + генератора. + +Все вызовы идут через **один общий генератор** на модуль. Поэтому +идентификаторы из разных вызовов различаются между собой и растут. Создавать +свой генератор на каждый вызов нельзя: два вызова в одну миллисекунду дали бы +одинаковые значения. + +#### Примеры + +Как и раньше, числа зависят от времени и у вас будут другими. + +**Значение общего генератора не `None`** (так бывает при настройках по умолчанию). Номер +узла равен `NODE_ID_DEFAULT`, то есть `1`, а счётчик растёт с каждым вызовом в +пределах одной миллисекунды: + +```python +first = generate_snowflake_id() +second = generate_snowflake_id() + +print(first) # 2119399534101532672 +print(second) # 2119399534101532673 +print(decode_node_id(first)) # 1 +print(decode_sequence_id(first)) # 0 +print(decode_sequence_id(second)) # 1 +``` + +**Значение общего генератора — `None`.** Допустим, при импорте модуля настройки по +умолчанию оказались некорректными (например, `NODE_ID_DEFAULT` вышел за +пределы `[0, NODE_ID_MAX]`). Тогда при импорте один раз напечатается +`node_id must be in [0, 1023], got 1024`, а общий генератор станет `None`. +Каждый следующий вызов `generate_snowflake_id` возвращает `None` и ничего +не печатает: + +```python +print(generate_snowflake_id()) # None +print(generate_snowflake_id()) # None +``` + +В этом случае `create_product(..., generate_id=generate_snowflake_id)` тоже +вернёт `None` и не изменит ни хранилище, ни индекс имён. + +### `create_product(storage: dict[int, Product], product_names: set[str], fields: dict[str, Any], generate_id: Callable[[], int | None]) -> int | None` + +- **Вход:** хранилище, индекс имён, `fields` (все три ключа `NAME_KEY`, + `PRICE_KEY`, `QUANTITY_KEY` обязательны, как в части 4) и **функция без + аргументов `generate_id`**, которая возвращает идентификатор нового товара или + `None`, если не смогла его выдать. +- **Выход:** идентификатор, который вернул `generate_id`, либо `None`. + +Функция выполняет шаги в таком порядке. Если на каком-то шаге вернулся `None`, +хранилище и индекс не меняются: + +1. Имя нормализуется. Если оно пустое, печатается `product name must not be blank` + и возвращается `None`. +2. Если нормализованное имя уже есть в `product_names`, печатается + `product name '<имя>' is already taken` и возвращается `None`. +3. Вызывается `generate_id()`. Если вернулось `None`, `create_product` + возвращает `None` и **сама ничего не печатает**: сообщение уже напечатал + `generate_id`. +4. Иначе запись `{name: нормализованное имя, price: normalize_price(цена), + quantity: количество}` кладётся в `storage` под полученным идентификатором, + имя добавляется в `product_names`, возвращается идентификатор. + +`generate_id` вызывается один раз на каждый создаваемый товар и только после +шагов 1 и 2: если создание отклонено из-за имени, идентификатор не выдаётся. + +### `read_product`, `update_product`, `delete_product` + +Поведение, сообщения и порядок шагов — как в части 4. Меняются только сигнатуры: +идентификатор `product_id` теперь `int`, хранилище — `dict[int, Product]`. +`delete_product` возвращает `int | None`. Сообщение об отсутствующем товаре +по-прежнему содержит идентификатор: `no product with id `. + +--- + +## Модуль `cart.py` + +Поведение, порядок шагов и сообщения — как в части 4. Меняются только типы: +идентификатор товара — `int`, корзина — `cart: dict[int, int]`, хранилище — +`dict[int, Product]`. Обе функции по-прежнему возвращают количество единиц +товара в корзине после операции либо `None`, а сообщения об ошибках содержат +идентификатор товара. + +--- + +## Модуль `utils.py` + +`normalize_price`, `normalize_product_name`, `PRICE_PRECISION`, `PRICE_STEP` и +`TABLE_HEADERS` — как в части 4. Типы изменились: `get_storage_str_representation` +принимает `dict[int, Product]`. В столбец `ID` идентификатор попадает как +десятичное число. Ширина столбца считается по самому длинному значению, +включая идентификаторы Snowflake из 19 цифр, например `1288834974657000001`. + +Добавляется функционал для построения таблицы со статистикой. Эта таблица +оформляется так же, как таблица товаров: формат, выравнивание, ширина столбцов +и вид пустой таблицы описаны в [части 3](../part3/TASK.md). Заголовки столбцов — кортеж +`STATS_TABLE_HEADERS = ("command name", "success", "fails", "success rate")`. + +### `get_stats_str_representation(registry: Registry) -> str` + +- **Вход:** `registry` — реестр счётчиков (см. `decorators.py`). +- **Выход:** многострочная строка без завершающего перевода строки: строка + заголовков, разделительная строка и по одной строке на каждую запись реестра + **в порядке вставки**. Для пустого реестра остаются только первые две строки, + ширина столбцов равна ширине заголовков. + +Ячейки строки: имя команды (ключ реестра), число успешных вызовов, число +неуспешных вызовов и доля успешных вызовов. + +**Доля успешных вызовов** — это число успешных вызовов, делённое на число всех вызовов, в процентах, +ровно с двумя знаками после запятой и знаком `%`, с округлением до ближайшего +(`66.67%`, `100.00%`, `3.23%`). Команда, которую ни разу не вызывали, получает +`0.00%`, а не ошибку. + +``` +| command name | success | fails | success rate | +|--------------|---------|-------|--------------| +| create | 2 | 1 | 66.67% | +| read | 0 | 0 | 0.00% | +| delete | 5 | 0 | 100.00% | +``` + +Длинное имя команды расширяет свой столбец: + +``` +| command name | success | fails | success rate | +|-------------------------|---------|-------|--------------| +| update-everything-twice | 1 | 30 | 3.23% | +``` + +--- + +## Модуль `run_admin.py` + +Набор команд, формат ввода, константы `PROMPT` и `HELP_TEXT`, функции +`show_help` и `print_result`, сообщение `'<строка>' is not a command` — как в +части 4. Отличия: + +- `create <имя...> <цена> <количество>` передаёт в `create_product` + `generate_snowflake_id` из `crud.py`. Напечатанный идентификатор — целое + число, а его поле времени (`decode_timestamp_ms`) совпадает с моментом + создания товара с точностью до нескольких секунд. +- `` в командах `read`, `update` и `delete` теперь **приводится к `int`**, + в отличие от части 4, где оно оставалось строкой. +- Тип хранилища — `dict[int, Product]`. `main()` создаёт пустое хранилище и + пустой индекс, как в части 4. +- Новая команда `stats` (ровно одно слово в строке) печатает + `get_stats_str_representation(STATS_REGISTRY)`: статистику четырёх CRUD-команд + за всё время работы процесса. Хранилище и индекс команда не меняет. Строка + `stats` с лишними словами (например, `stats create`) командой не считается: + для неё печатается `'<строка>' is not a command`. +- В `HELP_TEXT` добавляется строка про `stats`: она идёт последней в перечне + команд, сразу после `delete`. Остальной текст справки прежний. Пример + справки целиком: + + ``` + Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + stats print call statistics of the CRUD commands + + For create and update the price and quantity are the last two words of the + line; everything before them is the product name, so it may contain spaces + (for example "Gibson SG Junior") and needs no quoting. + ``` +- Счётчики ведёт слой `crud.py`, а не консоль. Поэтому `create`, `read`, + `update` и `delete` попадают в статистику по результату вызова + соответствующей операции. Строка, чьи аргументы не разобрались (`ValueError` + или `InvalidOperation` вылетели ещё до обращения к `crud.py`), в статистику не + попадает. + +--- + +## Инварианты + +- Три поля идентификатора восстанавливаются обратно: если генератор с номером + `n` и эпохой `e` выдал идентификатор в момент `t`, то `decode_node_id` даёт + `n`, `decode_timestamp_ms(id, e)` даёт `t`, а `decode_sequence_id` даёт номер + вызова внутри этой миллисекунды, начиная с нуля. +- Идентификатор положителен и меньше `2**63`. +- Идентификаторы одного генератора на реальных часах все разные и идут по + возрастанию. +- `product_names` всегда равно `{запись["name"] for запись in storage.values()}` + (см. часть 4). Неуспешный вызов, в том числе отказ `generate_id`, не меняет ни + хранилище, ни индекс. +- После успешного `create_product` товар лежит в `storage` под идентификатором, + который вернула функция. +- Сумма «на складе + в корзине» для каждого товара сохраняется при `add_to_cart` + и `remove_from_cart` (см. часть 4). +- Каждый вызов декорированной операции добавляет ровно единицу ровно к одному + счётчику: `fails`, если вернулся `None`, иначе `success`. Результат операции + и состояние хранилища от подсчёта не зависят. +- Повторная регистрация занятого ключа не меняет ни существующую запись, ни + поведение вторично декорированной функции. +- Выдача идентификатора через `generate_snowflake_id` реестр не меняет. diff --git a/src/part5/__init__.py b/src/part5/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/src/part5/cart.py b/src/part5/cart.py new file mode 100644 index 00000000..659df733 --- /dev/null +++ b/src/part5/cart.py @@ -0,0 +1,61 @@ +from .storage import ( + QUANTITY_KEY, + Product, +) + + +def add_to_cart( + storage: dict[int, Product], + cart: dict[int, int], + product_id: int, + quantity: int, +) -> int | None: + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + available = product[QUANTITY_KEY] + if available < quantity: + print( + f"not enough stock for product {product_id}: " + f"{available} available, {quantity} requested" + ) + return None + + product[QUANTITY_KEY] = available - quantity + cart[product_id] = cart.get(product_id, 0) + quantity + return cart[product_id] + + +def remove_from_cart( + storage: dict[int, Product], + cart: dict[int, int], + product_id: int, + quantity: int, +) -> int | None: + if product_id not in cart: + print(f"product {product_id} is not in the cart") + return None + + in_cart = cart[product_id] + if in_cart < quantity: + print( + f"cart holds only {in_cart} unit(s) of product {product_id}, " + f"cannot remove {quantity}" + ) + return None + + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + product[QUANTITY_KEY] = product[QUANTITY_KEY] + quantity + + remaining = in_cart - quantity + if remaining == 0: + del cart[product_id] + else: + cart[product_id] = remaining + return remaining diff --git a/src/part5/constants.py b/src/part5/constants.py new file mode 100644 index 00000000..09033e11 --- /dev/null +++ b/src/part5/constants.py @@ -0,0 +1,13 @@ +from typing import Final + + +EPOCH_MS_DEFAULT: Final[int] = 1288834974657 +NODE_ID_DEFAULT: Final[int] = 1 +TIMESTAMP_BITS: Final[int] = 41 +NODE_ID_BITS: Final[int] = 10 +SEQUENCE_ID_BITS: Final[int] = 12 +TIMESTAMP_MS_MAX: Final[int] = 2**TIMESTAMP_BITS - 1 +NODE_ID_MAX: Final[int] = 2**NODE_ID_BITS - 1 +SEQUENCE_ID_MAX: Final[int] = 2**SEQUENCE_ID_BITS - 1 +NODE_ID_SHIFT: Final[int] = SEQUENCE_ID_BITS +TIMESTAMP_SHIFT: Final[int] = SEQUENCE_ID_BITS + NODE_ID_BITS diff --git a/src/part5/crud.py b/src/part5/crud.py new file mode 100644 index 00000000..1ded2074 --- /dev/null +++ b/src/part5/crud.py @@ -0,0 +1,119 @@ +from collections.abc import Callable +from typing import Any, Final + +from .decorators import Registry, collect_stats +from .snowflake import get_snowflake_id_generator +from .storage import ( + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) +from .utils import normalize_price, normalize_product_name + + +STATS_REGISTRY: Final[Registry] = {} + +CREATE_KEY: Final[str] = "create" +READ_KEY: Final[str] = "read" +UPDATE_KEY: Final[str] = "update" +DELETE_KEY: Final[str] = "delete" + +_snowflake_id_generator = get_snowflake_id_generator() + + +def generate_snowflake_id() -> int | None: + if _snowflake_id_generator is None: + return None + return _snowflake_id_generator() + + +@collect_stats(CREATE_KEY, STATS_REGISTRY) +def create_product( + storage: dict[int, Product], + product_names: set[str], + fields: dict[str, Any], + generate_id: Callable[[], int | None], +) -> int | None: + name = normalize_product_name(fields[NAME_KEY]) + if not name: + print("product name must not be blank") + return None + if name in product_names: + print(f"product name '{name}' is already taken") + return None + product_id = generate_id() + if product_id is None: + return None + storage[product_id] = { + NAME_KEY: name, + PRICE_KEY: normalize_price(fields[PRICE_KEY]), + QUANTITY_KEY: fields[QUANTITY_KEY], + } + product_names.add(name) + return product_id + + +@collect_stats(READ_KEY, STATS_REGISTRY) +def read_product(storage: dict[int, Product], product_id: int) -> Product | None: + product = storage.get(product_id) + if product is not None: + return product + + print(f"no product with id {product_id}") + return None + + +@collect_stats(UPDATE_KEY, STATS_REGISTRY) +def update_product( + storage: dict[int, Product], + product_names: set[str], + product_id: int, + fields: dict[str, Any], +) -> Product | None: + if product_id not in storage: + print(f"no product with id {product_id}") + return None + + product = storage[product_id] + old_name = product[NAME_KEY] + new_name: str | None = None + + if NAME_KEY in fields: + name = normalize_product_name(fields[NAME_KEY]) + if not name: + print("product name must not be blank") + return None + if name != old_name and name in product_names: + print(f"product name '{name}' is already taken") + return None + new_name = name + fields[NAME_KEY] = name + + if PRICE_KEY in fields: + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + + for key in (NAME_KEY, PRICE_KEY, QUANTITY_KEY): + if key in fields: + product[key] = fields[key] + + if new_name is not None and new_name != old_name: + product_names.discard(old_name) + product_names.add(new_name) + + return product + + +@collect_stats(DELETE_KEY, STATS_REGISTRY) +def delete_product( + storage: dict[int, Product], + product_names: set[str], + product_id: int, +) -> int | None: + if product_id in storage: + product_names.discard(storage[product_id][NAME_KEY]) + del storage[product_id] + return product_id + + print(f"no product with id {product_id}") + return None diff --git a/src/part5/decorators.py b/src/part5/decorators.py new file mode 100644 index 00000000..a80c2379 --- /dev/null +++ b/src/part5/decorators.py @@ -0,0 +1,38 @@ +from collections.abc import Callable +from functools import wraps +from typing import Final + + +SUCCESS_KEY: Final[str] = "success" +FAILS_KEY: Final[str] = "fails" + + +type Stats = dict[str, int] +type Registry = dict[str, Stats] + + +def collect_stats[**P, R]( + key: str, registry: Registry +) -> Callable[[Callable[P, R | None]], Callable[P, R | None]]: + + def decorator( + function: Callable[P, R | None], + ) -> Callable[P, R | None]: + if key in registry: + print(f"stats key {key!r} is already registered") + return function + + registry[key] = {SUCCESS_KEY: 0, FAILS_KEY: 0} + + @wraps(function) + def wrapper(*args: P.args, **kwargs: P.kwargs) -> R | None: + result = function(*args, **kwargs) + if result is None: + registry[key][FAILS_KEY] += 1 + else: + registry[key][SUCCESS_KEY] += 1 + return result + + return wrapper + + return decorator diff --git a/src/part5/run_admin.py b/src/part5/run_admin.py new file mode 100644 index 00000000..76bce8ec --- /dev/null +++ b/src/part5/run_admin.py @@ -0,0 +1,115 @@ +from decimal import Decimal, InvalidOperation +from typing import Any, Final + +from .crud import ( + STATS_REGISTRY, + create_product, + delete_product, + generate_snowflake_id, + read_product, + update_product, +) +from .storage import NAME_KEY, PRICE_KEY, QUANTITY_KEY, Product +from .utils import get_stats_str_representation, get_storage_str_representation + + +PROMPT: Final[str] = "admin> " +HELP_TEXT: Final[str] = """Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + stats print call statistics of the CRUD commands + +For create and update the price and quantity are the last two words of the +line; everything before them is the product name, so it may contain spaces +(for example "Gibson SG Junior") and needs no quoting.""" + + +def show_help() -> None: + print(HELP_TEXT) + + +def print_result(result: object) -> None: + if result is not None: + print(result) + + +def _parse_product_fields(words: list[str]) -> dict[str, Any]: + return { + NAME_KEY: " ".join(words[:-2]), + PRICE_KEY: Decimal(words[-2]), + QUANTITY_KEY: int(words[-1]), + } + + +def run_command( + storage: dict[int, Product], product_names: set[str], line: str +) -> bool: + words = line.split() + if not words: + return True + + match words: + case ["help"]: + show_help() + return True + + case ["exit"]: + return False + + case ["show"]: + print_result(get_storage_str_representation(storage)) + return True + + case ["create", *rest] if len(rest) >= 3: + fields = _parse_product_fields(rest) + print_result( + create_product(storage, product_names, fields, generate_snowflake_id) + ) + return True + + case ["read", product_id_word]: + print_result(read_product(storage, int(product_id_word))) + return True + + case ["update", product_id_word, *rest] if len(rest) >= 3: + fields = _parse_product_fields(rest) + print_result( + update_product(storage, product_names, int(product_id_word), fields) + ) + return True + + case ["delete", product_id_word]: + print_result(delete_product(storage, product_names, int(product_id_word))) + return True + + case ["stats"]: + print_result(get_stats_str_representation(STATS_REGISTRY)) + return True + + case _: + print(f"{line!r} is not a command") + return True + + +def main() -> None: + storage: dict[int, Product] = {} + product_names: set[str] = set() + running = True + + while running: + line = input(PROMPT).strip() + + try: + running = run_command(storage, product_names, line) + + except (ValueError, InvalidOperation): + print(f"{line!r} names a command but its arguments are invalid") + + +if __name__ == "__main__": + main() diff --git a/src/part5/snowflake.py b/src/part5/snowflake.py new file mode 100644 index 00000000..8ef522cc --- /dev/null +++ b/src/part5/snowflake.py @@ -0,0 +1,83 @@ +import time +from collections.abc import Callable + +from .constants import ( + EPOCH_MS_DEFAULT, + NODE_ID_DEFAULT, + NODE_ID_MAX, + NODE_ID_SHIFT, + SEQUENCE_ID_MAX, + TIMESTAMP_MS_MAX, + TIMESTAMP_SHIFT, +) + + +def read_current_millis(epoch_ms: int) -> int: + return time.time_ns() // 1_000_000 - epoch_ms + + +def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> int: + stored_ms = snowflake_id >> TIMESTAMP_SHIFT + return stored_ms + epoch_ms + + +def decode_node_id(snowflake_id: int) -> int: + return (snowflake_id >> NODE_ID_SHIFT) & NODE_ID_MAX + + +def decode_sequence_id(snowflake_id: int) -> int: + return snowflake_id & SEQUENCE_ID_MAX + + +def get_snowflake_id_generator( + node_id: int = NODE_ID_DEFAULT, + epoch_ms: int = EPOCH_MS_DEFAULT, +) -> Callable[[], int | None] | None: + if not 0 <= node_id <= NODE_ID_MAX: + print(f"node_id must be in [0, {NODE_ID_MAX}], got {node_id}") + return None + + if read_current_millis(epoch_ms) < 0: + print(f"epoch_ms must not be in the future, got {epoch_ms}") + return None + + last_millis: int | None = None + sequence_id = -1 + + def generate() -> int | None: + nonlocal last_millis, sequence_id + + current_millis = read_current_millis(epoch_ms) + + if last_millis is None or current_millis > last_millis: + last_millis = current_millis + sequence_id = 0 + elif current_millis == last_millis: + if sequence_id >= SEQUENCE_ID_MAX: + print( + f"sequence_id must be in [0, {SEQUENCE_ID_MAX}], " + f"got {sequence_id + 1}" + ) + return None + sequence_id += 1 + else: + current_millis = last_millis + if sequence_id >= SEQUENCE_ID_MAX: + print( + f"sequence_id must be in [0, {SEQUENCE_ID_MAX}], " + f"got {sequence_id + 1}" + ) + return None + sequence_id += 1 + + if current_millis > TIMESTAMP_MS_MAX: + print(f"timestamp {current_millis} ms overflows {TIMESTAMP_MS_MAX} ms") + return None + + return ( + (current_millis << TIMESTAMP_SHIFT) + | (node_id << NODE_ID_SHIFT) + | sequence_id + ) + + return generate diff --git a/src/part5/storage.py b/src/part5/storage.py new file mode 100644 index 00000000..048ce1b6 --- /dev/null +++ b/src/part5/storage.py @@ -0,0 +1,8 @@ +from typing import Any, Final + + +type Product = dict[str, Any] + +NAME_KEY: Final[str] = "name" +PRICE_KEY: Final[str] = "price" +QUANTITY_KEY: Final[str] = "quantity" diff --git a/src/part5/utils.py b/src/part5/utils.py new file mode 100644 index 00000000..6de05eb0 --- /dev/null +++ b/src/part5/utils.py @@ -0,0 +1,91 @@ +from decimal import ROUND_HALF_UP, Decimal +from typing import Final + +from .decorators import Registry +from .storage import ( + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) + + +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final[Decimal] = Decimal(1).scaleb(-PRICE_PRECISION) +TABLE_HEADERS: Final[tuple[str, str, str, str]] = ("ID", "name", "price", "quantity") +STATS_TABLE_HEADERS: Final[tuple[str, str, str, str]] = ( + "command name", + "success", + "fails", + "success rate", +) + + +def normalize_price(price: Decimal) -> Decimal: + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) + + +def normalize_product_name(name: str) -> str: + return " ".join(name.split()).lower() + + +def _compute_column_widths( + headers: tuple[str, ...], rows: list[list[str]] +) -> list[int]: + widths = [len(header) for header in headers] + for row in rows: + for index, cell in enumerate(row): + widths[index] = max(widths[index], len(cell)) + return widths + + +def _format_row(cells: list[str], widths: list[int]) -> str: + return ( + "| " + + " | ".join(cell.ljust(widths[index]) for index, cell in enumerate(cells)) + + " |" + ) + + +def _format_table(headers: tuple[str, ...], rows: list[list[str]]) -> str: + widths = _compute_column_widths(headers, rows) + header_line = _format_row(list(headers), widths) + separator_line = "|" + "|".join("-" * (width + 2) for width in widths) + "|" + row_lines = [_format_row(row, widths) for row in rows] + return "\n".join([header_line, separator_line, *row_lines]) + + +def _format_success_rate(success: int, fails: int) -> str: + total = success + fails + rate = (success / total * 100) if total else 0.0 + return f"{rate:.2f}%" + + +def get_storage_str_representation(storage: dict[int, Product]) -> str: + return _format_table( + TABLE_HEADERS, + [ + [ + str(product_id), + product[NAME_KEY], + str(product[PRICE_KEY]), + str(product[QUANTITY_KEY]), + ] + for product_id, product in storage.items() + ], + ) + + +def get_stats_str_representation(registry: Registry) -> str: + return _format_table( + STATS_TABLE_HEADERS, + [ + [ + command_name, + str(stats["success"]), + str(stats["fails"]), + _format_success_rate(stats["success"], stats["fails"]), + ] + for command_name, stats in registry.items() + ], + )