From 563629a68be37202735a5212b752ff65d517ba85 Mon Sep 17 00:00:00 2001 From: EvgrafovMichail Date: Mon, 5 Oct 2026 20:08:25 +0300 Subject: [PATCH 1/3] Get rid of hw notation --- src/part2/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From b9a357bbeef9697fe8d804893654111e9b052706 Mon Sep 17 00:00:00 2001 From: EvgrafovMichail Date: Mon, 5 Oct 2026 20:35:44 +0300 Subject: [PATCH 2/3] Add part3 of complex task --- src/part3/TASK.md | 459 +++++++++++++++++++++++++++++++++++++++++ src/part3/__init__.py | 0 src/part3/crud.py | 131 ++++++++++++ src/part3/run_admin.py | 119 +++++++++++ src/part3/storage.py | 35 ++++ src/part3/utils.py | 95 +++++++++ 6 files changed, 839 insertions(+) create mode 100644 src/part3/TASK.md create mode 100644 src/part3/__init__.py create mode 100644 src/part3/crud.py create mode 100644 src/part3/run_admin.py create mode 100644 src/part3/storage.py create mode 100644 src/part3/utils.py diff --git a/src/part3/TASK.md b/src/part3/TASK.md new file mode 100644 index 00000000..07c8fc60 --- /dev/null +++ b/src/part3/TASK.md @@ -0,0 +1,459 @@ +# Задача: нормализация имён, печать хранилища таблицей и админ-консоль + +## Легенда + +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)). + +--- + +## Модуль `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[0]) # (1, 'cordless drill', Decimal('90.00'), 12) +``` + +Товара с таким идентификатором нет, а пустое имя отвергается раньше, чем +выполняется поиск по идентификатору: + +```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` цена и + количество — это два последних слова строки, а всё между ними — имя товара + (поэтому имя может содержать пробелы и не требует кавычек). + +### Разбор команд + +Команда определяется по строке, разбитой по пробельным символам. +Распознаются следующие формы (число слов должно совпадать точно): + +| Форма ввода | Действие | +| --- | --- | +| `help` | напечатать `HELP_TEXT` | +| `exit` | завершить цикл | +| `show` | напечатать всё хранилище выравненной таблицей | +| `create <имя...> <цена> <количество>` | добавить товар; `<имя...>` — одно или больше слов | +| `read ` | напечатать один товар | +| `update <имя...> <цена> <количество>` | перезаписать поля товара; `<имя...>` — одно или больше слов | +| `delete ` | удалить товар | + +Для `create` и `update` два последних слова строки — это цена и количество, а +всё между глаголом (и, для `update`, идентификатором) и этими двумя словами +склеивается через один пробел в имя товара. Имя обязано быть непустым: `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`, чтобы увидеть +список команд (после того как вы реализуете `HELP_TEXT`), и `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 "" From 6fb4cade40267fc783774426073c4fd436a7cce0 Mon Sep 17 00:00:00 2001 From: EvgrafovMichail Date: Mon, 5 Oct 2026 20:37:56 +0300 Subject: [PATCH 3/3] Add part3 reference into README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index eeb5cbca..d810c576 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ - [Часть 1. Генератор идентификаторов Twitter Snowflake](src/part1/TASK.md) — нужно написать генератор 64-битных числовых идентификаторов, в которые упакованы метка времени, номер узла и счётчик последовательности. Такие идентификаторы уникальны и примерно упорядочены по времени, а из самого идентификатора можно узнать, когда и на каком узле он был создан. - [Часть 2. CRUD и корзина для интернет-магазина](src/part2/TASK.md) — нужно реализовать хранилище товаров в памяти (список кортежей), операции создания, чтения, изменения и удаления записей, аккуратную работу с ценами через `Decimal` и корзину покупателя, в которую товары переносятся со склада и обратно без потери количества. +- [Часть 3. Нормализация имён и консоль администратора](src/part3/TASK.md) — нужно привести названия товаров к единому написанию и следить за их уникальностью, научить хранилище печатать себя выровненной текстовой таблицей и написать интерактивную консоль администратора, через которую можно создавать, просматривать, изменять и удалять товары. ## Дедлайны @@ -18,6 +19,7 @@ |---|---|---| | [Часть 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 | активно | ## Критерии оценивания