diff --git a/src/part1/constants.py b/src/part1/constants.py index 9abfbba2..2cc5954b 100644 --- a/src/part1/constants.py +++ b/src/part1/constants.py @@ -19,20 +19,22 @@ # Все константы, зависящие от ёмкостей *_BITS, должны вычисляться из них. # Twitter's original Snowflake epoch: 2010-11-04 01:42:54.657 UTC. -EPOCH_MS_DEFAULT: Final[int] = 0 +EPOCH_MS_DEFAULT: Final[int] = 1288834974657 # Node identifier used when the caller does not supply one. -NODE_ID_DEFAULT: Final[int] = 0 +NODE_ID_DEFAULT: Final[int] = 1 # Width of each field, in bits. -TIMESTAMP_BITS: Final[int] = 0 -NODE_ID_BITS: Final[int] = 0 -SEQUENCE_ID_BITS: Final[int] = 0 +TIMESTAMP_BITS: Final[int] = 41 +NODE_ID_BITS: Final[int] = 10 +SEQUENCE_ID_BITS: Final[int] = 12 # Largest value each field can hold. -TIMESTAMP_MS_MAX: Final[int] = 0 -NODE_ID_MAX: Final[int] = 0 -SEQUENCE_ID_MAX: Final[int] = 0 +TIMESTAMP_MS_MAX: Final[int] = 2**TIMESTAMP_BITS - 1 +NODE_ID_MAX: Final[int] = 2**NODE_ID_BITS - 1 +SEQUENCE_ID_MAX: Final[int] = 2**SEQUENCE_ID_BITS - 1 # Здесь можно добавить собственные вспомогательные константы # (например, сдвиги полей при сборке идентификатора). +NODE_ID_SHIFT: Final[int] = SEQUENCE_ID_BITS +TIMESTAMP_SHIFT: Final[int] = NODE_ID_BITS + SEQUENCE_ID_BITS diff --git a/src/part1/snowflake.py b/src/part1/snowflake.py index d3abf050..0bb11774 100644 --- a/src/part1/snowflake.py +++ b/src/part1/snowflake.py @@ -13,14 +13,16 @@ :func:`decode_node_id` and :func:`decode_sequence_id`. """ -import time # noqa: F401 +from time import time -from .constants import ( # noqa: F401 +from .constants import ( EPOCH_MS_DEFAULT, NODE_ID_DEFAULT, NODE_ID_MAX, + NODE_ID_SHIFT, SEQUENCE_ID_MAX, TIMESTAMP_MS_MAX, + TIMESTAMP_SHIFT, ) @@ -34,8 +36,7 @@ def read_current_millis(epoch_ms: int) -> int: The count of whole milliseconds between ``epoch_ms`` and now. May be negative if ``epoch_ms`` lies in the future. """ - # TODO: реализуйте функцию - return 0 + return int(time() * 1000 - epoch_ms) def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> int: @@ -50,8 +51,7 @@ def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> The absolute Unix time in milliseconds at which the identifier was generated. """ - # TODO: реализуйте функцию - return 0 + return (snowflake_id >> TIMESTAMP_SHIFT) + epoch_ms def decode_node_id(snowflake_id: int) -> int: @@ -64,8 +64,7 @@ def decode_node_id(snowflake_id: int) -> int: The node identifier packed into ``snowflake_id``, in the range ``[0, NODE_ID_MAX]``. """ - # TODO: реализуйте функцию - return 0 + return (snowflake_id >> NODE_ID_SHIFT) & NODE_ID_MAX def decode_sequence_id(snowflake_id: int) -> int: @@ -78,8 +77,7 @@ def decode_sequence_id(snowflake_id: int) -> int: The per-millisecond sequence counter packed into ``snowflake_id``, in the range ``[0, SEQUENCE_ID_MAX]``. """ - # TODO: реализуйте функцию - return 0 + return snowflake_id & SEQUENCE_ID_MAX def generate_snowflake_id( @@ -110,5 +108,17 @@ def generate_snowflake_id( timestamp field (roughly 69 years after ``epoch_ms``). In each of those cases an explanatory message is printed to stdout first. """ - # TODO: реализуйте функцию - return 0 + if not (0 <= node_id <= NODE_ID_MAX): + print(f"node_id must be in [0, {NODE_ID_MAX}], got {node_id}") + return None + + if not (0 <= sequence_id <= SEQUENCE_ID_MAX): + print(f"sequence_id must be in [0, {SEQUENCE_ID_MAX}], got {sequence_id}") + return None + + elapsed_ms = read_current_millis(epoch_ms) + if elapsed_ms > TIMESTAMP_MS_MAX: + print("overflows") + return None + + return (elapsed_ms << TIMESTAMP_SHIFT) | (node_id << NODE_ID_SHIFT) | sequence_id 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..aed9bb72 --- /dev/null +++ b/src/part4/cart.py @@ -0,0 +1,87 @@ +"""Shopping-cart operations layered on top of the product store. + +The cart is a plain dictionary mapping each product identifier to the +number of units of that product in the cart. Moving units between the +store and the cart keeps the two sides in balance: :func:`add_to_cart` takes +units out of stock, :func:`remove_from_cart` puts them back. + +Like the CRUD layer, the failure path never raises -- the operation prints +an explanatory message to stdout and returns ``None``. +""" + +from .storage import Product + + +# TODO: при необходимости добавьте свои вспомогательные функции + + +def add_to_cart( + storage: dict[str, Product], + product_names: set[str], + cart: dict[str, int], + product_id: str, + quantity: int, +) -> int | None: + """Move ``quantity`` units of ``product_id`` from the store into ``cart``. + + The product is looked up in ``storage``. If it is missing, a message is + printed and nothing changes. If the store holds fewer units than + requested, an explanatory message is printed and nothing changes. + Otherwise the store record is decremented by ``quantity`` and the cart + gains ``quantity`` units of ``product_id`` -- the product is added when + the cart had none of it. + + Args: + storage: The product store to draw stock from; modified in place on + success. + product_names: The normalised names in ``storage``; a + quantity-only change never renames a product, so it is left + unchanged here. + cart: The cart to add the units to; modified in place on success. + product_id: The identifier of the product to add. + quantity: Number of units to move into the cart. + + Returns: + The quantity of ``product_id`` in the cart after the addition, or + ``None`` when the product is unknown or the store cannot cover the + request. + """ + # TODO: реализуйте функцию + return 0 + + +def remove_from_cart( + storage: dict[str, Product], + product_names: set[str], + cart: dict[str, int], + product_id: str, + quantity: int, +) -> int | None: + """Move ``quantity`` units of ``product_id`` from ``cart`` back to the store. + + If the cart holds no units of ``product_id``, a message is printed and + nothing changes. If it holds fewer units than requested, an explanatory + message is printed and nothing changes. If the product is missing from + ``storage``, a message is printed and nothing changes. Otherwise the cart loses + ``quantity`` units of the product -- the product is dropped from the + cart when its quantity reaches zero -- and the store record gains + ``quantity`` units back. + + Args: + storage: The product store to return stock to; modified in place on + success. + product_names: The normalised names in ``storage``; a + quantity-only change never renames a product, so it is left + unchanged here. + cart: The cart to take the units from; modified in place on + success. + product_id: The identifier of the product to remove. + quantity: Number of units to move back into the store. + + Returns: + The quantity of ``product_id`` left in the cart after the removal + (zero means the product was dropped from the cart), or ``None`` when + the cart does not hold the product or holds too few units. + """ + # TODO: реализуйте функцию + return 0 diff --git a/src/part4/crud.py b/src/part4/crud.py new file mode 100644 index 00000000..471eff00 --- /dev/null +++ b/src/part4/crud.py @@ -0,0 +1,157 @@ +"""Create/read/update/delete operations over the in-memory product store. + +Every operation takes the store -- a dictionary mapping product id to its +:data:`~src.part4.storage.Product` record -- as its first argument and +works on it in place. ``create_product``, ``update_product`` and +``delete_product`` additionally take ``product_names``, the ``set[str]`` +of normalised names currently in ``storage`` (see +:mod:`src.part4.storage`), and keep it in sync with ``storage`` on +every successful call. The failure path never raises: the operation +prints an explanatory message to stdout and returns ``None``. + +The identifier of a new product is a freshly generated UUID string +(:func:`generate_product_id`), independent of insertion order or of any +identifier already in ``storage``. + +Every product name that reaches the store is passed through +:func:`~src.part4.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 -- via an O(1) membership test against ``product_names`` rather +than a scan over ``storage.values()``. +""" + +import uuid # noqa: F401 +from typing import Any + +from .storage import ( # noqa: F401 + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) +from .utils import normalize_price, normalize_product_name # noqa: F401 + + +def generate_product_id() -> str: + """Generate an identifier for a new product. + + Returns: + A freshly generated UUID, stringified. + """ + # TODO: реализуйте функцию + return "" + + +def create_product( + storage: dict[str, Product], + product_names: set[str], + fields: dict[str, Any], +) -> str | None: + """Add a new product to ``storage`` and return its new identifier. + + Args: + storage: The product store to add to; modified in place on + success. + product_names: The normalised names already in ``storage``; the + new name is added to it in place on success. + fields: A dictionary with the ``name``, ``price`` and ``quantity`` + keys (see :data:`~src.part4.storage.NAME_KEY`, + :data:`~src.part4.storage.PRICE_KEY` and + :data:`~src.part4.storage.QUANTITY_KEY`) 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`` + and ``product_names`` are left unchanged and an explanatory + message is printed. + """ + # TODO: реализуйте функцию + return "" + + +def read_product(storage: dict[str, Product], product_id: str) -> 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 record, or ``None`` when no product carries + that identifier (a message is printed in that case). + """ + # TODO: реализуйте функцию + return {} + + +def update_product( + storage: dict[str, Product], + product_names: set[str], + product_id: str, + fields: dict[str, Any], +) -> Product | None: + """Overwrite the fields of the product stored under ``product_id``. + + The identifier itself is preserved. ``fields`` may carry any subset of + ``name``, ``price`` and ``quantity``; a key that is missing keeps the + value the product already has, so a caller can update a single field + without repeating the other two. + + Args: + storage: The product store to modify; the matching record is + updated in place on success. + product_names: The normalised names already in ``storage``; on a + successful rename the old name is removed from it and the new + one added. + product_id: The identifier of the product to change. + fields: A dictionary with any of the ``name``, ``price`` and + ``quantity`` keys (see :data:`~src.part4.storage.NAME_KEY`, + :data:`~src.part4.storage.PRICE_KEY` and + :data:`~src.part4.storage.QUANTITY_KEY`) holding the new + values. ``price`` is a :class:`~decimal.Decimal` amount and is + rounded to the stored money precision before it is saved. + Mutated in place: a ``name`` or ``price`` value present in + ``fields`` is overwritten with its normalised form. + + Returns: + The updated product record, or ``None`` when ``name`` is present + and blank once normalised, no product carries that identifier, or + the normalised name is already taken by another product. In every + ``None`` case ``storage`` and ``product_names`` are left unchanged + and an explanatory message is printed. Renaming a product to its + own current name is allowed. + """ + # TODO: реализуйте функцию + return {} + + +def delete_product( + storage: dict[str, Product], + product_names: set[str], + product_id: str, +) -> str | None: + """Remove the product stored under ``product_id`` from ``storage``. + + Args: + storage: The product store to remove from; modified in place on + success. + product_names: The normalised names already in ``storage``; the + departing product's name is removed from it 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`` and ``product_names`` + are left unchanged and a message is printed). + """ + # TODO: реализуйте функцию + return "" diff --git a/src/part4/run_admin.py b/src/part4/run_admin.py new file mode 100644 index 00000000..2247b29b --- /dev/null +++ b/src/part4/run_admin.py @@ -0,0 +1,123 @@ +"""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 # noqa: F401 +from typing import Final + +from .crud import ( # noqa: F401 + create_product, + delete_product, + read_product, + update_product, +) +from .storage import NAME_KEY, PRICE_KEY, QUANTITY_KEY, Product # noqa: F401 +from .utils import get_storage_str_representation # noqa: F401 + + +# TODO: задайте приглашение и текст справки (используйте своё решение части 3) +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: реализуйте функцию (используйте своё решение части 3) + + +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: реализуйте функцию (используйте своё решение части 3) + + +def run_command( + storage: dict[str, Product], product_names: set[str], 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. + product_names: The normalised names already in ``storage``; kept + in sync 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 the 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, 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..9acedf07 --- /dev/null +++ b/src/part4/storage.py @@ -0,0 +1,45 @@ +"""In-memory product store for the shop CRUD exercise. + +The store is deliberately primitive: a plain dictionary, with no +persistence and no schema enforcement. It maps a product's ``id`` -- a +UUID string assigned by the create operation in :mod:`src.part4.crud` +-- to its :data:`Product` record -- a dictionary with the keys ``name``, +``price`` and ``quantity`` -- where: + +* the ``storage`` key itself -- unique string identifier, assigned by the + create operation in :mod:`src.part4.crud`; it is not duplicated + inside the record; +* ``name`` -- human-readable product name, unique across the store, held + in normalised form (see + :func:`src.part4.utils.normalize_product_name`); +* ``price`` -- price of a single unit, held as a :class:`~decimal.Decimal` + amount rounded to a fixed number of decimal places (see + :func:`src.part4.utils.normalize_price`) so that money is never + subject to binary floating-point error; +* ``quantity`` -- number of units currently in stock. + +Field names are exposed as ``*_KEY`` constants so callers never hard-code +the dictionary keys. + +Every caller that mutates the store also threads along a second +structure, a ``set[str]`` of the normalised names currently in use -- +see, for example, the ``product_names`` parameter of +:func:`src.part4.crud.create_product`. Keeping that name index as a +plain set passed next to ``storage``, rather than bundling the two into +an object, lets a name-uniqueness check become an O(1) membership test +against the set instead of a linear scan over ``storage.values()``. The +set must always mirror the normalised names present in ``storage``; the +functions in :mod:`src.part4.crud` keep the two in sync on every +successful create, update and delete. +""" + +from typing import Any, Final + + +type Product = dict[str, Any] + +# Name of each field inside a Product record. +# TODO: задайте имена полей записи +NAME_KEY: Final = "" +PRICE_KEY: Final = "" +QUANTITY_KEY: Final = "" diff --git a/src/part4/utils.py b/src/part4/utils.py new file mode 100644 index 00000000..d2a940ea --- /dev/null +++ b/src/part4/utils.py @@ -0,0 +1,100 @@ +"""Standalone helpers shared by the part4 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 ( # noqa: F401 + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) + + +# Number of fractional digits every stored price is rounded to. +# Quantisation step derived from PRICE_PRECISION, e.g. Decimal("0.01"). +# TODO: задайте число знаков после запятой и шаг квантования (используйте своё +# решение части 3) +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: задайте заголовки столбцов таблицы (используйте своё решение части 3) +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: реализуйте функцию (используйте своё решение части 3) + 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: реализуйте функцию (используйте своё решение части 3) + return "" + + +# TODO: при необходимости добавьте свои вспомогательные функции + + +def get_storage_str_representation(storage: dict[str, 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 insertion order. When + ``storage`` is empty only the header and separator rows are + returned, sized to the header labels. + """ + # TODO: реализуйте функцию (используйте своё решение части 3) + return ""