diff --git a/.github/workflows/label-by-group.yml b/.github/workflows/label-by-group.yml index 97d8e60d..c27a3559 100644 --- a/.github/workflows/label-by-group.yml +++ b/.github/workflows/label-by-group.yml @@ -37,16 +37,20 @@ jobs: repo: context.repo.repo, }); + // The title matches the template, so the PR is waiting for a check + const labelsToAdd = ["unchecked"]; + const matchingLabel = labels.find((label) => label.name === groupNumber); - if (!matchingLabel) { - console.log(`No label named "${groupNumber}" found, skipping.`); - return; + if (matchingLabel) { + labelsToAdd.push(matchingLabel.name); + } else { + console.log(`No label named "${groupNumber}" found, adding only the unchecked label.`); } await github.rest.issues.addLabels({ owner: context.repo.owner, repo: context.repo.repo, issue_number: context.payload.pull_request.number, - labels: [matchingLabel.name], + labels: labelsToAdd, }); diff --git a/README.md b/README.md index 76d456ac..efd62134 100644 --- a/README.md +++ b/README.md @@ -11,98 +11,18 @@ - [Часть 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` менять только часть полей и оформить продуктовую корзину в виде словаря. -## Критерии оценивания - -Максимальный балл за каждое задание — **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 баллов**. Эти баллы не вычитаются из оценки за правильность, а **заменяют** итоговую оценку: итоговой оценкой становится −5, независимо от результата тестов. - -Студент может оспорить этот балл на занятии, доказав, что не списывал, а написал код самостоятельно (например, объяснив решение и ответив на вопросы по нему). Если подозрение снимается, работа оценивается по обычным критериям. - -### Итоговая оценка - -``` -если есть подозрение в списывании: - итоговая_оценка = −5 -иначе: - итоговая_оценка = max(0, балл_за_правильность − штрафы_за_оформление) -``` - -Итоговая оценка за домашнее задание округляется до ближайшего целого по правилам математики: дробная часть от 0.5 и выше округляется вверх, меньше 0.5 — вниз (например, 7.5 → 8, 7.4 → 7). - -### Как оспорить оценку +## Критерии оценивания -Если вы не согласны с оценкой, напишите преподавателю. Укажите, с каким блоком или с какой частью критериев вы не согласны, и приведите аргументы. Оценка пересматривается по тем же критериям, которые описаны выше. +Критерии оценивания можно узнать [тут](docs/grading_criteria.md). diff --git a/docs/grading_criteria.md b/docs/grading_criteria.md new file mode 100644 index 00000000..4253fa2d --- /dev/null +++ b/docs/grading_criteria.md @@ -0,0 +1,90 @@ +# Критерии оценивания + +Максимальный балл за каждое задание — **10**. Правильность решения проверяется закрытыми тестами. + +## Условия принятия работы + +Работа принимается к оцениванию, только если выполнены **все** условия: + +- код проходит проверки [ruff](https://docs.astral.sh/ruff/) и [MyPy](https://mypy-lang.org/) (запустить их можно [локально](../manuals/local_checks.md)); +- работа сдана до дедлайна. + +Если хотя бы одно условие не выполнено, работа не принимается и оценивается в 0 баллов. + +## Как считается балл за правильность + +Задание состоит из модулей, и у каждого модуля есть свой вес. Балл за правильность считается в два шага: + +1. Для каждого модуля вычисляется доля пройденных тестов этого модуля от общего числа его тестов. Она умножается на 10 и округляется до двух знаков после запятой. +2. Балл за правильность — взвешенная сумма баллов за модули. + +``` +балл_модуля = round(10 · пройденные_тесты_модуля / все_тесты_модуля, 2) +балл_за_правильность = Σ(вес_модуля · балл_модуля) / Σ(вес_модуля) +``` + +Дополнительные правила: + +- **Нереализованный функционал.** Тесты на функционал, который не реализован (заглушка, `pass`, `NotImplementedError`), считаются проваленными. Дополнительного штрафа за нереализованное нет. +- **Ошибки выполнения.** Тест, в котором возникло необработанное исключение, считается проваленным. +- **Зависание.** У каждого теста есть ограничение по времени выполнения. Если решение не укладывается в него (например, из-за бесконечного цикла), тест считается проваленным. + +## Штрафы за оформление + +Кроме правильности, оценивается качество кода. За нарушения ниже из балла за правильность вычитаются штрафы. Каждое нарушение штрафуется **один раз**, сколько бы раз оно ни встретилось в работе. + +У каждого нарушения есть уникальный код: `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` | Избыточные комментарии, пересказывающие очевидный код | + +## Штраф за списывание + +Если работа подозревается в списывании, студент получает **−5 баллов**. Эти баллы не вычитаются из оценки за правильность, а **заменяют** итоговую оценку: итоговой оценкой становится −5, независимо от результата тестов. + +Студент может оспорить этот балл на занятии, доказав, что не списывал, а написал код самостоятельно (например, объяснив решение и ответив на вопросы по нему). Если подозрение снимается, работа оценивается по обычным критериям. + +## Итоговая оценка + +``` +если есть подозрение в списывании: + итоговая_оценка = −5 +иначе: + итоговая_оценка = max(0, балл_за_правильность − штрафы_за_оформление) +``` + +Итоговая оценка за домашнее задание округляется до ближайшего целого по правилам математики: дробная часть от 0.5 и выше округляется вверх, меньше 0.5 — вниз (например, 7.5 → 8, 7.4 → 7). + +## Как оспорить оценку + +Если вы не согласны с оценкой, напишите преподавателю. Укажите, с каким блоком или с какой частью критериев вы не согласны, и приведите аргументы. Оценка пересматривается по тем же критериям, которые описаны выше. diff --git a/src/part2/utils.py b/src/part2/utils.py index ec0348d3..11bd7a76 100644 --- a/src/part2/utils.py +++ b/src/part2/utils.py @@ -1,4 +1,4 @@ -"""Standalone helpers shared by the hw4 storage and CRUD modules. +"""Standalone helpers shared by the part2 storage and CRUD modules. For now this is limited to money handling: :func:`normalize_price` rounds a raw :class:`~decimal.Decimal` amount to the fixed number of fractional diff --git a/src/part3/TASK.md b/src/part3/TASK.md new file mode 100644 index 00000000..e48ecdac --- /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..68811d7e --- /dev/null +++ b/src/part3/crud.py @@ -0,0 +1,131 @@ +"""Create/read/update/delete operations over the in-memory product store. + +Every operation takes the store -- a list of +:data:`~src.part3.storage.Product` tuples -- as its first argument and +works on it in place. The failure path never raises: the operation prints +an explanatory message to stdout and returns ``None``. + +The identifier of a new product is derived from the store itself +(:func:`generate_product_id`): one past the greatest identifier in use, or +:data:`~src.part3.storage.PRODUCT_ID_MIN` when the store is empty. + +Every product name that reaches the store is passed through +:func:`~src.part3.utils.normalize_product_name` first. A name that +normalises to an empty string is rejected -- the operation prints a +message and changes nothing. Names are also kept unique -- +:func:`create_product` refuses a normalised name that is already taken, +and :func:`update_product` refuses one that is already taken by another +product. +""" + +from decimal import Decimal + +from .storage import ( # noqa: F401 + NAME_INDEX, + PRODUCT_ID_INDEX, + PRODUCT_ID_MIN, + Product, +) +from .utils import normalize_price, normalize_product_name # noqa: F401 + + +def generate_product_id(storage: list[Product]) -> int: + """Choose the identifier for the next product added to ``storage``. + + Args: + storage: The product store to inspect. + + Returns: + One past the greatest identifier currently held in ``storage``, or + :data:`~src.part3.storage.PRODUCT_ID_MIN` when ``storage`` is + empty. + """ + # TODO: реализуйте функцию (используйте своё решение части 2) + return 0 + + +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. + ``name`` is normalised (surrounding whitespace stripped, + lower-cased) before it is stored or compared. ``price`` is a + :class:`~decimal.Decimal` amount and is rounded to the stored + money precision before it is saved. + + Returns: + The identifier generated for the new product, or ``None`` when + ``name`` is blank once normalised or a product with the same + normalised name already exists. In the ``None`` case ``storage`` + is left unchanged and an explanatory message is printed. + """ + # TODO: реализуйте функцию + return 0 + + +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: реализуйте функцию (используйте своё решение части 2) + return (0, "", Decimal(0), 0) + + +def update_product( + storage: list[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 ``name`` is blank once normalised, no product + carries that identifier, or the normalised name is already taken + by another product. In every ``None`` case ``storage`` is left + unchanged and an explanatory message is printed. Renaming a + product to its own current name is allowed. + """ + # TODO: реализуйте функцию + return (0, "", Decimal(0), 0) + + +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: реализуйте функцию (используйте своё решение части 2) + return 0 diff --git a/src/part3/run_admin.py b/src/part3/run_admin.py new file mode 100644 index 00000000..c5feeb0b --- /dev/null +++ b/src/part3/run_admin.py @@ -0,0 +1,119 @@ +"""Interactive admin console for the part3 in-memory product store. + +Running this module starts a read-eval-print loop over a single product +store that lives in memory for the lifetime of the process. Every line +typed at the prompt is stripped of surrounding whitespace and matched +against the set of known commands: + +* ``help`` -- print the list of commands and what each one does; +* ``exit`` -- leave the loop and end the program; +* ``show`` -- print the whole store as a text table; +* ``create `` -- add a product; +* ``read `` -- print one product; +* ``update `` -- overwrite a product; +* ``delete `` -- remove a product. + +For ``create`` and ``update`` the price and quantity are always the last +two words of the line; everything between the verb (and, for ``update``, +the id) and those two words is joined with single spaces into the +product name, so a multi-word name such as ``Gibson SG Junior`` needs no +quoting. + +The four CRUD commands forward to :mod:`src.part3.crud`; whatever +that call returns is printed unless it is ``None``. A line whose first +word is not a known verb, or that carries the wrong number of arguments +for its verb, prints an "is not a command" notice. A line that names a +command correctly but whose id, price or quantity argument will not +parse prints a distinct "arguments are invalid" notice. Either way the +store is left untouched and the loop keeps running; only ``exit`` stops +it. +""" + +from decimal import Decimal, InvalidOperation # noqa: F401 +from typing import Final + +from .crud import ( # noqa: F401 + create_product, + delete_product, + read_product, + update_product, +) +from .storage import Product +from .utils import get_storage_str_representation # noqa: F401 + + +# TODO: задайте приглашение и текст справки +PROMPT: Final[str] = "" +HELP_TEXT: Final[str] = "" + + +def show_help() -> None: + """Print the command reference to stdout. + + The text is the module-level :data:`HELP_TEXT` constant, printed as + is: a heading, one line per command with a short description, and a + note on how multi-word names are parsed. + """ + # TODO: реализуйте функцию + + +def print_result(result: object) -> None: + """Print a CRUD result to stdout unless it is ``None``. + + Args: + result: The value returned by a CRUD operation. ``None`` means the + operation already reported its own failure, so nothing is + printed in that case. + """ + # TODO: реализуйте функцию + + +def run_command(storage: list[Product], line: str) -> bool: + """Parse one console line and carry out the command it names. + + Args: + storage: The product store shared across the session; mutated in + place by the ``create``, ``update`` and ``delete`` commands. + line: One line of console input, already stripped of surrounding + whitespace. + + Returns: + ``True`` to keep the read-eval-print loop running, or ``False`` + once the ``exit`` command has been seen. A line that is not a + known command prints a notice and still returns ``True``. + + Raises: + ValueError: If an id or quantity argument of a CRUD command does + not parse as a base-10 integer. + decimal.InvalidOperation: If the price argument of ``create`` or + ``update`` does not parse as a decimal number. + """ + # TODO: реализуйте функцию + return False + + +def main() -> None: + """Run the admin console until the ``exit`` command is entered. + + A single product store is created empty and kept in memory for the + whole session. Each iteration reads one line from stdin, strips its + surrounding whitespace and hands it to :func:`run_command`. A line + that names a command but whose id, price or quantity argument does + not parse is caught here and reported without stopping the loop; only + ``exit`` ends it. + """ + 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..c5e34be5 --- /dev/null +++ b/src/part3/storage.py @@ -0,0 +1,35 @@ +"""In-memory product store for the shop CRUD exercise. + +The store is deliberately primitive: a plain list of tuples, with no +persistence, no indexing and no schema enforcement. Each element is a +:data:`Product` record -- a ``(product_id, name, price, quantity)`` tuple +where: + +* ``product_id`` -- unique positive integer key, assigned by the create + operation in :mod:`src.part3.crud`; +* ``name`` -- human-readable product name, unique across the store; +* ``price`` -- price of a single unit, held as a :class:`~decimal.Decimal` + amount rounded to a fixed number of decimal places (see + :func:`src.part3.utils.normalize_price`) so that money is never + subject to binary floating-point error; +* ``quantity`` -- number of units currently in stock. + +Field positions are exposed as ``*_INDEX`` constants so callers never +hard-code tuple offsets. +""" + +from decimal import Decimal +from typing import Final + + +type Product = tuple[int, str, Decimal, int] + +# TODO: задайте позиции полей внутри кортежа Product (используйте своё решение +# части 2) +PRODUCT_ID_INDEX: Final = 0 +NAME_INDEX: Final = 0 +PRICE_INDEX: Final = 0 +QUANTITY_INDEX: Final = 0 + +# TODO: задайте идентификатор первого товара в пустом хранилище +PRODUCT_ID_MIN: Final[int] = 0 diff --git a/src/part3/utils.py b/src/part3/utils.py new file mode 100644 index 00000000..318ded0b --- /dev/null +++ b/src/part3/utils.py @@ -0,0 +1,95 @@ +"""Standalone helpers shared by the part3 storage and CRUD modules. + +Normalisation: + +* :func:`normalize_price` rounds a raw :class:`~decimal.Decimal` amount to + the fixed number of fractional digits (:data:`PRICE_PRECISION`) that + every stored price uses, keeping currency values free of binary + floating-point error. +* :func:`normalize_product_name` strips surrounding whitespace from a + product name, collapses every internal run of whitespace to a single + space and lower-cases it, giving every stored name a single canonical + form. + +Presentation: + +* :func:`get_storage_str_representation` renders the whole store as a + text table meant to be printed to a terminal; each column is sized to + the longest value it holds in that particular call. +""" + +from decimal import ROUND_HALF_UP, Decimal # noqa: F401 +from typing import Final + +from .storage import Product + + +# Number of fractional digits every stored price is rounded to. +# Quantisation step derived from PRICE_PRECISION, e.g. Decimal("0.01"). +# TODO: задайте число знаков после запятой и шаг квантования (используйте своё +# решение части 2) +PRICE_PRECISION: Final[int] = 0 +PRICE_STEP: Final = Decimal(0) + +# Column headers of the table produced by get_storage_str_representation, +# left to right. The width of each column is not fixed here -- it is +# measured per call from the data (see the function). +# TODO: задайте заголовки столбцов таблицы +TABLE_HEADERS: Final[tuple[str, ...]] = () + + +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: реализуйте функцию (используйте своё решение части 2) + return Decimal(0) + + +def normalize_product_name(name: str) -> str: + """Reduce a product name to the canonical form the store keeps. + + Args: + name: The raw product name. + + Returns: + ``name`` with every leading and trailing whitespace character + removed, every internal run of whitespace (spaces, tabs and the + like) collapsed to a single space, and the rest lower-cased. For + example ``"abc def\tghi\tjkl"`` becomes ``"abc def ghi jkl"``. + The result is an empty string when ``name`` holds nothing but + whitespace. + """ + # TODO: реализуйте функцию + return "" + + +# TODO: при необходимости добавьте свои вспомогательные функции + + +def get_storage_str_representation(storage: list[Product]) -> str: + """Render the product store as a text table with data-sized columns. + + The table has the columns named by :data:`TABLE_HEADERS` -- id, name, + price and quantity. Each column is made exactly as wide as the longest + value it carries in this call (its header counted), so the columns + line up when the string is printed to a terminal and no value is ever + truncated. + + Args: + storage: The product store to render. + + Returns: + A multi-line string: a header row, a dashed separator row, then + one row per product in ``storage`` in list order. When ``storage`` + is empty only the header and separator rows are returned, sized to + the header labels. + """ + # TODO: реализуйте функцию + return "" 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..c2eabc7f --- /dev/null +++ b/src/part4/cart.py @@ -0,0 +1,50 @@ +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 + if storage[product_id][QUANTITY_KEY] < quantity: + print( + f"not enough stock for product {product_id}: " + f"{storage[product_id][QUANTITY_KEY]} available, " + f"{quantity} requested" + ) + return None + storage[product_id][QUANTITY_KEY] -= 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 + if cart[product_id] < quantity: + print( + f"cart holds only {cart[product_id]} unit(s) " + f"of product {product_id}, cannot remove {quantity}" + ) + return None + if product_id not in storage: + print(f"no product with id {product_id}") + return None + storage[product_id][QUANTITY_KEY] += quantity + cart[product_id] -= quantity + if not cart[product_id]: + del cart[product_id] + return 0 + return cart[product_id] diff --git a/src/part4/crud.py b/src/part4/crud.py new file mode 100644 index 00000000..b1423a0a --- /dev/null +++ b/src/part4/crud.py @@ -0,0 +1,90 @@ +import uuid +from typing import Any + +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(uuid.uuid4()) + + +def create_product( + storage: dict[str, Product], + product_names: set[str], + fields: dict[str, Any], +) -> str | None: + price_product = normalize_price(fields[PRICE_KEY]) + quantity_product = fields[QUANTITY_KEY] + name_product = normalize_product_name(fields[NAME_KEY]) + if not name_product: + print("product name must not be blank") + return None + if name_product in product_names: + print(f"product name '{name_product}' is already taken") + return None + product_names.add(name_product) + new_id = generate_product_id() + storage[new_id] = { + NAME_KEY: name_product, + PRICE_KEY: price_product, + QUANTITY_KEY: quantity_product, + } + return new_id + + +def read_product(storage: dict[str, Product], product_id: str) -> Product | None: + reading = storage.get(product_id) + if reading is None: + print(f"no product with id {product_id}") + return reading + + +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 + if fields.get(NAME_KEY) is not None: + fields[NAME_KEY] = normalize_product_name(fields[NAME_KEY]) + if not fields[NAME_KEY]: + print("product name must not be blank") + return None + if (fields[NAME_KEY] != storage[product_id][NAME_KEY]) and ( + fields[NAME_KEY] in product_names + ): + print(f"product name '{fields[NAME_KEY]}' is already taken") + return None + if fields.get(PRICE_KEY) is not None: + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + if fields.get(NAME_KEY) is not None: + product_names.discard(storage[product_id][NAME_KEY]) + product_names.add(fields[NAME_KEY]) + storage[product_id][NAME_KEY] = fields[NAME_KEY] + if fields.get(PRICE_KEY) is not None: + storage[product_id][PRICE_KEY] = fields[PRICE_KEY] + if fields.get(QUANTITY_KEY) is not None: + storage[product_id][QUANTITY_KEY] = fields[QUANTITY_KEY] + return storage[product_id] + + +def delete_product( + storage: dict[str, Product], + product_names: set[str], + product_id: str, +) -> str | None: + if product_id not in storage: + print(f"no product with id {product_id}") + return None + product_names.discard(storage[product_id][NAME_KEY]) + del storage[product_id] + return product_id diff --git a/src/part4/run_admin.py b/src/part4/run_admin.py new file mode 100644 index 00000000..0a9da822 --- /dev/null +++ b/src/part4/run_admin.py @@ -0,0 +1,155 @@ +"""Interactive admin console for the part4 in-memory product store. + +Running this module starts a read-eval-print loop over a single product +store that lives in memory for the lifetime of the process. Every line +typed at the prompt is stripped of surrounding whitespace and matched, +with a ``match`` statement, against the set of known commands: + +* ``help`` -- print the list of commands and what each one does; +* ``exit`` -- leave the loop and end the program; +* ``show`` -- print the whole store as a text table; +* ``create `` -- add a product; +* ``read `` -- print one product; +* ``update `` -- overwrite a product; +* ``delete `` -- remove a product. + +For ``create`` and ``update`` the price and quantity are always the last +two words of the line; everything between the verb (and, for ``update``, +the id) and those two words is joined with single spaces into the +product name, so a multi-word name such as ``Gibson SG Junior`` needs no +quoting. + +The four CRUD commands forward to :mod:`src.part4.crud`; whatever +that call returns is printed unless it is ``None``. A line whose first +word is not a known verb, or that carries the wrong number of arguments +for its verb, prints an "is not a command" notice. A line that names a +command correctly but whose price or quantity argument will not parse +prints a distinct "arguments are invalid" notice. Either way the store +is left untouched and the loop keeps running; only ``exit`` stops it. +""" + +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: + parts = line.split() + match parts: + case ["exit"]: + return False + + case ["help"]: + show_help() + return True + + case ["show"]: + print(get_storage_str_representation(storage)) + return True + + case ["create", *name_parts, price_str, quantity_str] if name_parts: + name = " ".join(name_parts) + price = Decimal(price_str) + quantity = int(quantity_str) + print_result( + create_product( + storage, + product_names, + {NAME_KEY: name, PRICE_KEY: price, QUANTITY_KEY: quantity}, + ) + ) + return True + + case ["read", product_id]: + print_result(read_product(storage, product_id)) + return True + + case [ + "update", + product_id, + *name_parts, + price_str, + quantity_str, + ] if name_parts: + name = " ".join(name_parts) + price = Decimal(price_str) + quantity = int(quantity_str) + print_result( + update_product( + storage, + product_names, + product_id, + {NAME_KEY: name, PRICE_KEY: price, QUANTITY_KEY: quantity}, + ) + ) + return True + + case ["delete", product_id]: + print_result(delete_product(storage, product_names, product_id)) + return True + + case _: + print(f"'{line}' is not a command") + return True + + +def main() -> None: + """Run the admin console until the ``exit`` command is entered. + + A single product store, and the set of normalised names it holds, are + created empty and kept in memory for the whole session. Each iteration + reads one line from stdin, strips its surrounding whitespace and hands + it to :func:`run_command`. A line that names a command but whose price + or quantity argument does not parse is caught here and reported + without stopping the loop; only ``exit`` ends it. + """ + 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..564aa4ac --- /dev/null +++ b/src/part4/storage.py @@ -0,0 +1,9 @@ +from typing import Any, Final + + +type Product = dict[str, Any] + +# Name of each field inside a Product record. +NAME_KEY: Final = "name" +PRICE_KEY: Final = "price" +QUANTITY_KEY: Final = "quantity" diff --git a/src/part4/utils.py b/src/part4/utils.py new file mode 100644 index 00000000..42fb8d23 --- /dev/null +++ b/src/part4/utils.py @@ -0,0 +1,76 @@ +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(1).scaleb(-PRICE_PRECISION) + +TABLE_HEADERS: Final[tuple[str, ...]] = ("ID", "name", "price", "quantity") + +PRODUCT_FIELDS: Final[tuple[str, ...]] = (NAME_KEY, PRICE_KEY, QUANTITY_KEY) + + +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.lower().split()) + + +def len_first_column(storage: dict[str, Product]) -> int: + max_len = max((len(s) for s in storage), default=0) + return max(max_len, len(TABLE_HEADERS[0])) + + +def len_other_column(storage: dict[str, Product], column_number: int) -> int: + field_key = PRODUCT_FIELDS[column_number - 1] + max_len = max( + (len(str(product[field_key])) for product in storage.values()), + default=0, + ) + return max(max_len, len(TABLE_HEADERS[column_number])) + + +def line_string_headers(max_len_column: list[int]) -> str: + line = "|" + for column_number, header in enumerate(TABLE_HEADERS): + line += " " + header.ljust(max_len_column[column_number]) + " |" + return line + + +def line_string(product_id: str, storage_i: Product, max_len_column: list[int]) -> str: + line = "|" + line += " " + product_id.ljust(max_len_column[0]) + " |" + for column_number, field_key in enumerate(PRODUCT_FIELDS, start=1): + line += ( + " " + str(storage_i[field_key]).ljust(max_len_column[column_number]) + " |" + ) + return line + + +def line_void(max_len_column: list[int]) -> str: + line = "|" + for column_len in max_len_column: + line += "-" + "-" * column_len + "-|" + return line + + +def max_len(storage: dict[str, Product]) -> list[int]: + max_len_column = [len_first_column(storage)] + max_len_column.extend( + len_other_column(storage, i) for i in range(1, len(TABLE_HEADERS)) + ) + return max_len_column + + +def get_storage_str_representation(storage: dict[str, Product]) -> str: + max_len_column = max_len(storage) + str_representation = "" + str_representation += line_string_headers(max_len_column) + "\n" + str_representation += line_void(max_len_column) + "\n" + for product_id, storage_i in storage.items(): + str_representation += line_string(product_id, storage_i, max_len_column) + "\n" + return str_representation.rstrip("\n")