diff --git a/src/part1/constants.py b/src/part1/constants.py index 9abfbba2..753c2dda 100644 --- a/src/part1/constants.py +++ b/src/part1/constants.py @@ -1,38 +1,11 @@ -"""Bit layout and default epoch for the Twitter Snowflake ID generator. - -A Snowflake identifier is a 63-bit positive integer packed as follows, from -the most significant bit downwards: - - 1 bit unused sign bit, always zero - 41 bits milliseconds elapsed since a custom epoch - 10 bits node identifier - 12 bits per-millisecond sequence counter - -The shift and mask constants should be derived from the bit widths so that -changing a width keeps everything else consistent. -""" - from typing import Final -# TODO: замените заглушки (0) на корректные значения, см. TASK.md. -# Все константы, зависящие от ёмкостей *_BITS, должны вычисляться из них. - -# Twitter's original Snowflake epoch: 2010-11-04 01:42:54.657 UTC. -EPOCH_MS_DEFAULT: Final[int] = 0 - -# Node identifier used when the caller does not supply one. -NODE_ID_DEFAULT: Final[int] = 0 - -# Width of each field, in bits. -TIMESTAMP_BITS: Final[int] = 0 -NODE_ID_BITS: Final[int] = 0 -SEQUENCE_ID_BITS: Final[int] = 0 - -# Largest value each field can hold. -TIMESTAMP_MS_MAX: Final[int] = 0 -NODE_ID_MAX: Final[int] = 0 -SEQUENCE_ID_MAX: Final[int] = 0 - -# Здесь можно добавить собственные вспомогательные константы -# (например, сдвиги полей при сборке идентификатора). +EPOCH_MS_DEFAULT: Final[int] = 1288834974657 +NODE_ID_DEFAULT: Final[int] = 1 +TIMESTAMP_BITS: Final[int] = 41 +NODE_ID_BITS: Final[int] = 10 +SEQUENCE_ID_BITS: Final[int] = 12 +TIMESTAMP_MS_MAX: Final[int] = 2**TIMESTAMP_BITS - 1 +NODE_ID_MAX: Final[int] = 2**NODE_ID_BITS - 1 +SEQUENCE_ID_MAX: Final[int] = 2**SEQUENCE_ID_BITS - 1 diff --git a/src/part1/snowflake.py b/src/part1/snowflake.py index d3abf050..3348e9f4 100644 --- a/src/part1/snowflake.py +++ b/src/part1/snowflake.py @@ -1,21 +1,6 @@ -"""Twitter Snowflake identifier generator. +import time -Snowflake produces roughly time-ordered 64-bit integer identifiers without -coordination between nodes. Each identifier packs the milliseconds elapsed -since a custom epoch, a node identifier and a per-millisecond sequence counter -into a single 63-bit positive integer (see ``constants`` for the layout). - -The public entry point is :func:`generate_snowflake_id`. It is stateless: the -caller passes the sequence counter on every call and is responsible for -advancing it within a millisecond and resetting it when the clock ticks over. - -Each packed field can be read back on its own with :func:`decode_timestamp_ms`, -:func:`decode_node_id` and :func:`decode_sequence_id`. -""" - -import time # noqa: F401 - -from .constants import ( # noqa: F401 +from .constants import ( EPOCH_MS_DEFAULT, NODE_ID_DEFAULT, NODE_ID_MAX, @@ -25,90 +10,39 @@ def read_current_millis(epoch_ms: int) -> int: - """Read the number of milliseconds elapsed since the custom epoch. - - Args: - epoch_ms: The custom epoch expressed as Unix milliseconds. - - Returns: - The count of whole milliseconds between ``epoch_ms`` and now. May be - negative if ``epoch_ms`` lies in the future. - """ - # TODO: реализуйте функцию - return 0 + return int(time.time() * 1000) - epoch_ms def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> int: - """Read the timestamp field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced against the same epoch. - epoch_ms: The epoch the identifier was generated against. Defaults to - the original Twitter epoch (2010-11-04 01:42:54.657 UTC). - - Returns: - The absolute Unix time in milliseconds at which the identifier was - generated. - """ - # TODO: реализуйте функцию - return 0 + return int(bin(snowflake_id)[3:44], 2) + epoch_ms def decode_node_id(snowflake_id: int) -> int: - """Read the node identifier field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by :func:`generate_snowflake_id`. - - Returns: - The node identifier packed into ``snowflake_id``, in the range - ``[0, NODE_ID_MAX]``. - """ - # TODO: реализуйте функцию - return 0 + return int(bin(snowflake_id)[44:54], 2) def decode_sequence_id(snowflake_id: int) -> int: - """Read the sequence counter field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by :func:`generate_snowflake_id`. - - Returns: - The per-millisecond sequence counter packed into ``snowflake_id``, in - the range ``[0, SEQUENCE_ID_MAX]``. - """ - # TODO: реализуйте функцию - return 0 + return int(bin(snowflake_id)[54:], 2) def generate_snowflake_id( - sequence_id: int, - node_id: int = NODE_ID_DEFAULT, - epoch_ms: int = EPOCH_MS_DEFAULT, + sequence_id: int, node_id: int = NODE_ID_DEFAULT, epoch_ms: int = EPOCH_MS_DEFAULT ) -> int | None: - """Build and return a Snowflake identifier for the current millisecond. - - The function is stateless: the caller passes the per-millisecond sequence - counter explicitly. It is the caller's responsibility to increment - ``sequence_id`` for identifiers minted within the same millisecond and to - reset it once the clock advances. - - Args: - sequence_id: The per-millisecond sequence counter, in the range - ``[0, SEQUENCE_ID_MAX]``. - node_id: The identifier of this node, in the range ``[0, NODE_ID_MAX]``. - Optional; defaults to ``NODE_ID_DEFAULT``. - epoch_ms: The start of the epoch as Unix milliseconds. Optional; - defaults to the original Twitter epoch (2010-11-04 01:42:54.657 - UTC). - - Returns: - The Snowflake identifier as a positive 63-bit integer, or ``None`` if - ``node_id`` is outside ``[0, NODE_ID_MAX]``, ``sequence_id`` is outside - ``[0, SEQUENCE_ID_MAX]``, or the elapsed time no longer fits in the - timestamp field (roughly 69 years after ``epoch_ms``). In each of those - cases an explanatory message is printed to stdout first. - """ - # TODO: реализуйте функцию - return 0 + if node_id < 0 or node_id > NODE_ID_MAX: + print(f"node_id must be in [0, {NODE_ID_MAX}]") + return None + elif sequence_id < 0 or sequence_id > SEQUENCE_ID_MAX: + print(f"sequence_id be in [0, {SEQUENCE_ID_MAX}]") + return None + else: + timestamp = time.time() + if timestamp > TIMESTAMP_MS_MAX: + print("overflows") + return None + return int( + "0" + + bin(int(time.time() * 1000) + epoch_ms)[2:].zfill(41) + + bin(node_id)[2:].zfill(10) + + bin(sequence_id)[2:].zfill(12), + 2, + ) diff --git a/src/part2/cart.py b/src/part2/cart.py index 063f9aea..20317bdc 100644 --- a/src/part2/cart.py +++ b/src/part2/cart.py @@ -1,18 +1,7 @@ -"""Shopping-cart operations layered on top of the product store. - -The cart is a plain list of tuples, one :data:`CartLine` -- -``(product_id, quantity)`` -- per distinct product. 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 typing import Final -from .crud import read_product, update_product # noqa: F401 -from .storage import ( # noqa: F401 +from .crud import read_product, update_product +from .storage import ( NAME_INDEX, PRICE_INDEX, QUANTITY_INDEX, @@ -22,9 +11,8 @@ type CartLine = tuple[int, int] -# TODO: задайте позиции полей внутри кортежа CartLine LINE_PRODUCT_ID_INDEX: Final = 0 -LINE_QUANTITY_INDEX: Final = 0 +LINE_QUANTITY_INDEX: Final = 1 def add_to_cart( @@ -33,28 +21,35 @@ def add_to_cart( product_id: int, quantity: int, ) -> CartLine | None: - """Move ``quantity`` units of ``product_id`` from the store into ``cart``. - - The product is looked up in ``storage``. If it is missing, a message is - printed (by :func:`~src.part2.crud.read_product`) and nothing - changes. If the store holds fewer units than requested, an explanatory - message is printed and nothing changes. Otherwise the store record is - decremented by ``quantity`` and the cart line for ``product_id`` gains - ``quantity`` units -- a new line is created when the cart had none. - - Args: - storage: The product store to draw stock from; modified in place on - success. - cart: The cart to add the units to; modified in place on success. - product_id: The identifier of the product to add. - quantity: Number of units to move into the cart. - - Returns: - The cart line for ``product_id`` after the addition, or ``None`` - when the product is unknown or the store cannot cover the request. - """ - # TODO: реализуйте функцию - return (0, 0) + prod = read_product(storage, product_id) + if prod is None: + return None + if prod[QUANTITY_INDEX] < quantity: + print( + f"not enough stock for product {product_id}: {prod[QUANTITY_INDEX]} available, {quantity} requested" + ) + return None + updated = update_product( + storage, + product_id, + (prod[NAME_INDEX], prod[PRICE_INDEX], prod[QUANTITY_INDEX] - quantity), + ) + if updated is None: + return None + storage[storage.index(prod)] = updated + for i in range(len(cart)): + if cart[i][LINE_PRODUCT_ID_INDEX] is product_id: + cart[i] = (product_id, cart[i][LINE_QUANTITY_INDEX] + quantity) + return cart[i] + cart.append((product_id, quantity)) + return cart[-1] + + +def find_cart_line(cart: list[CartLine], product_id: int) -> CartLine | None: + for line in cart: + if line[LINE_PRODUCT_ID_INDEX] is product_id: + return line + return None def remove_from_cart( @@ -63,27 +58,31 @@ def remove_from_cart( product_id: int, quantity: int, ) -> CartLine | None: - """Move ``quantity`` units of ``product_id`` from ``cart`` back to the store. - - The cart line for ``product_id`` is looked up. If there is none, a - message is printed and nothing changes. If the line holds fewer units - than requested, an explanatory message is printed and nothing changes. - Otherwise the cart line loses ``quantity`` units -- the line is dropped - when it reaches zero -- and the store record gains ``quantity`` units - back. - - Args: - storage: The product store to return stock to; modified in place on - success. - cart: The cart to take the units from; modified in place on - success. - product_id: The identifier of the product to remove. - quantity: Number of units to move back into the store. - - Returns: - The cart line for ``product_id`` after the removal (a quantity of - zero means the line was dropped), or ``None`` when the cart has no - line for the product or holds too few units. - """ - # TODO: реализуйте функцию - return (0, 0) + prod_cart = find_cart_line(cart, product_id) + if prod_cart is None: + print(f"product {product_id} is not in the cart") + return None + if prod_cart[LINE_QUANTITY_INDEX] < quantity: + print( + f"cart holds only {prod_cart[LINE_QUANTITY_INDEX]} unit(s) of product {product_id}, cannot remove {quantity}" + ) + return None + prod = read_product(storage, product_id) + if prod is None: + return None + updated = update_product( + storage, + product_id, + (prod[NAME_INDEX], prod[PRICE_INDEX], prod[QUANTITY_INDEX] - quantity), + ) + if updated is None: + return None + storage[storage.index(prod)] = updated + if (prod_cart[LINE_QUANTITY_INDEX] - quantity) == 0: + cart.remove(prod_cart) + return None + cart[cart.index(prod_cart)] = ( + product_id, + prod_cart[LINE_QUANTITY_INDEX] - quantity, + ) + return cart[cart.index(prod_cart)] diff --git a/src/part2/crud.py b/src/part2/crud.py index d026cbcb..f8b4d357 100644 --- a/src/part2/crud.py +++ b/src/part2/crud.py @@ -1,79 +1,42 @@ -"""Create/read/update/delete operations over the in-memory product store. - -Every operation takes the store -- a list of -:data:`~src.part2.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.part2.storage.PRODUCT_ID_MIN` when the store is empty. -Product names are kept unique -- :func:`create_product` refuses a name that -is already taken. -""" - from decimal import Decimal -from .storage import ( # noqa: F401 +from .storage import ( NAME_INDEX, PRODUCT_ID_INDEX, - PRODUCT_ID_MIN, Product, ) -from .utils import normalize_price # noqa: F401 +from .utils import normalize_price def generate_product_id(storage: list[Product]) -> int: - """Choose the identifier for the next product added to ``storage``. - - Args: - storage: The product store to inspect. - - Returns: - One past the greatest identifier currently held in ``storage``, or - :data:`~src.part2.storage.PRODUCT_ID_MIN` when ``storage`` is - empty. - """ - # TODO: реализуйте функцию - return 0 + if not storage: + return 0 + return max(storage)[PRODUCT_ID_INDEX] + 1 def create_product( storage: list[Product], fields: tuple[str, Decimal, int] ) -> int | None: - """Append a new product to ``storage`` and return its new identifier. - - Args: - storage: The product store to append to; modified in place on - success. - fields: A ``(name, price, quantity)`` tuple describing the product. - ``price`` is a :class:`~decimal.Decimal` amount and is rounded - to the stored money precision before it is saved. - - Returns: - The identifier generated for the new product, or ``None`` when a - product with the same name already exists. In the ``None`` case - ``storage`` is left unchanged and a message naming the clashing - name is printed. - """ - # TODO: реализуйте функцию - return 0 + for prod in storage: + if fields[0] == prod[NAME_INDEX]: + print(f"product name '{fields[0]}' is already taken") + return None + new_product = ( + generate_product_id(storage), + fields[0], + normalize_price(fields[1]), + fields[2], + ) + storage.append(new_product) + return new_product[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: реализуйте функцию - return (0, "", Decimal(0), 0) + for prod in storage: + if prod[0] == product_id: + return prod + print(f"no product with id {product_id}") + return None def update_product( @@ -81,40 +44,18 @@ def update_product( product_id: int, fields: tuple[str, Decimal, int], ) -> Product | None: - """Overwrite the fields of the product stored under ``product_id``. - - The identifier itself is preserved; only ``name``, ``price`` and - ``quantity`` are replaced. - - Args: - storage: The product store to modify; the matching record is - replaced in place on success. - product_id: The identifier of the product to change. - fields: A ``(name, price, quantity)`` tuple with the new values. - ``price`` is a :class:`~decimal.Decimal` amount and is rounded - to the stored money precision before it is saved. - - Returns: - The updated ``(product_id, name, price, quantity)`` record, or - ``None`` when no product carries that identifier (``storage`` is - left unchanged and a message is printed). - """ - # TODO: реализуйте функцию - return (0, "", Decimal(0), 0) + for i in range(len(storage)): + if storage[i][PRODUCT_ID_INDEX] == product_id: + storage[i] = (product_id, fields[0], normalize_price(fields[1]), fields[2]) + return storage[i] + print(f"no product with id {product_id}") + return None def delete_product(storage: list[Product], product_id: int) -> int | None: - """Remove the product stored under ``product_id`` from ``storage``. - - Args: - storage: The product store to remove from; modified in place on - success. - product_id: The identifier of the product to remove. - - Returns: - ``product_id`` when a product was removed, or ``None`` when no - product carried that identifier (``storage`` is left unchanged and - a message is printed). - """ - # TODO: реализуйте функцию - return 0 + for i in range(len(storage)): + if storage[i][PRODUCT_ID_INDEX] == product_id: + del storage[i] + return product_id + print(f"no product with id {product_id}") + return None diff --git a/src/part2/storage.py b/src/part2/storage.py index b63d5fc7..81651a75 100644 --- a/src/part2/storage.py +++ b/src/part2/storage.py @@ -1,34 +1,12 @@ -"""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.part2.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.part2.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 PRODUCT_ID_INDEX: Final = 0 -NAME_INDEX: Final = 0 -PRICE_INDEX: Final = 0 -QUANTITY_INDEX: Final = 0 +NAME_INDEX: Final = 1 +PRICE_INDEX: Final = 2 +QUANTITY_INDEX: Final = 3 -# TODO: задайте идентификатор первого товара в пустом хранилище -PRODUCT_ID_MIN: Final[int] = 0 +PRODUCT_ID_MIN: Final[int] = 1 diff --git a/src/part2/utils.py b/src/part2/utils.py index 11bd7a76..1efcd42a 100644 --- a/src/part2/utils.py +++ b/src/part2/utils.py @@ -1,29 +1,10 @@ -"""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 -digits (:data:`PRICE_PRECISION`) that every stored price uses, keeping -currency values free of binary floating-point error. -""" - -from decimal import ROUND_HALF_UP, Decimal # noqa: F401 +from decimal import ROUND_HALF_UP, Decimal from typing import Final -# TODO: задайте число знаков после запятой и шаг квантования -PRICE_PRECISION: Final[int] = 0 -PRICE_STEP: Final = Decimal(0) +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final = Decimal(1).scaleb(-PRICE_PRECISION) def normalize_price(price: Decimal) -> Decimal: - """Round a price to the precision every stored record uses. - - Args: - price: The raw price amount. - - Returns: - ``price`` quantised to :data:`PRICE_PRECISION` fractional digits, - with halves rounded up. - """ - # TODO: реализуйте функцию - return Decimal(0) + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) diff --git a/src/part3/crud.py b/src/part3/crud.py index 68811d7e..ab8e7eaf 100644 --- a/src/part3/crud.py +++ b/src/part3/crud.py @@ -1,87 +1,47 @@ -"""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 +from .storage import ( NAME_INDEX, PRODUCT_ID_INDEX, PRODUCT_ID_MIN, Product, ) -from .utils import normalize_price, normalize_product_name # noqa: F401 +from .utils import normalize_price, normalize_product_name 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 + if not storage: + return PRODUCT_ID_MIN + return max(storage)[PRODUCT_ID_INDEX] + 1 def create_product( storage: list[Product], fields: tuple[str, Decimal, int] ) -> int | None: - """Append a new product to ``storage`` and return its new identifier. - - Args: - storage: The product store to append to; modified in place on - success. - fields: A ``(name, price, quantity)`` tuple describing the product. - ``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 + fields = (normalize_product_name(fields[0]), fields[1], fields[2]) + if fields[0] == "": + print("product name must not be blank") + return None + for prod in storage: + if fields[0] == prod[NAME_INDEX]: + print(f"product name '{fields[0]}' is already taken") + return None + new_product = ( + generate_product_id(storage), + fields[0], + normalize_price(fields[1]), + fields[2], + ) + storage.append(new_product) + return new_product[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) + for prod in storage: + if prod[0] == product_id: + return prod + print(f"no product with id {product_id}") + return None def update_product( @@ -89,43 +49,32 @@ def update_product( product_id: int, fields: tuple[str, Decimal, int], ) -> Product | None: - """Overwrite the fields of the product stored under ``product_id``. - - The identifier itself is preserved; only ``name``, ``price`` and - ``quantity`` are replaced. - - Args: - storage: The product store to modify; the matching record is - replaced in place on success. - product_id: The identifier of the product to change. - fields: A ``(name, price, quantity)`` tuple with the new values. - ``price`` is a :class:`~decimal.Decimal` amount and is rounded - to the stored money precision before it is saved. - - Returns: - The updated ``(product_id, name, price, quantity)`` record, or - ``None`` when ``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) + norm_name = normalize_product_name(fields[0]) + if norm_name == "": + print("product name must not be blank") + return None + prod = None + for i in range(len(storage)): + if ( + storage[i][NAME_INDEX] == norm_name + and storage[i][PRODUCT_ID_INDEX] != product_id + ): + print(f"product name '{norm_name}' is already taken") + return None + elif storage[i][PRODUCT_ID_INDEX] == product_id: + prod = (product_id, norm_name, normalize_price(fields[1]), fields[2]) + prod_num = i + if prod != None: + storage[prod_num] = prod + return prod + print(f"no product with id {product_id}") + return None def delete_product(storage: list[Product], product_id: int) -> int | None: - """Remove the product stored under ``product_id`` from ``storage``. - - Args: - storage: The product store to remove from; modified in place on - success. - product_id: The identifier of the product to remove. - - Returns: - ``product_id`` when a product was removed, or ``None`` when no - product carried that identifier (``storage`` is left unchanged and - a message is printed). - """ - # TODO: реализуйте функцию (используйте своё решение части 2) - return 0 + for i in range(len(storage)): + if storage[i][PRODUCT_ID_INDEX] == product_id: + del storage[i] + return product_id + print(f"no product with id {product_id}") + return None diff --git a/src/part3/run_admin.py b/src/part3/run_admin.py index c5feeb0b..53cb87b1 100644 --- a/src/part3/run_admin.py +++ b/src/part3/run_admin.py @@ -1,107 +1,96 @@ -"""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 decimal import Decimal from typing import Final -from .crud import ( # noqa: F401 +from .crud import ( create_product, delete_product, read_product, update_product, ) from .storage import Product -from .utils import get_storage_str_representation # noqa: F401 +from .utils import get_storage_str_representation -# TODO: задайте приглашение и текст справки -PROMPT: Final[str] = "" -HELP_TEXT: Final[str] = "" +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 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 show_help() -> None: + print(HELP_TEXT) 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: реализуйте функцию + if result: + print(result) 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 + words = line.split() + match words: + case ["help"]: + show_help() + return True + case ["exit"]: + return False + case ["show"]: + get_storage_str_representation(storage) + return True + case [ + "create", + *_, + price, + quantity, + ]: + name = " ".join(words[1:-2]) + pocket_create = create_product( + storage, (name, Decimal(price), int(quantity)) + ) + if pocket_create: + print(pocket_create) + return True + case ["read", id_num]: + output = read_product(storage, int(id_num)) + if output: + print(output) + return True + case [ + "update", + id_num, + *_, + price, + quantity, + ]: + name = " ".join(words[2:-2]) + pocket_update = update_product( + storage, int(id_num), (name, Decimal(price), int(quantity)) + ) + if pocket_update: + print(pocket_update) + return True + case ["delete", id_num]: + pocket_delete = delete_product(storage, int(id_num)) + if pocket_delete: + print(pocket_delete) + return True + case _: + sentance = " ".join(words) + print(f"'{sentance}' is not a command") + return True 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 @@ -111,7 +100,7 @@ def main() -> None: try: running = run_command(storage, line) - except (ValueError, InvalidOperation): + except ValueError: print(f"{line!r} names a command but its arguments are invalid") diff --git a/src/part3/storage.py b/src/part3/storage.py index c5e34be5..81651a75 100644 --- a/src/part3/storage.py +++ b/src/part3/storage.py @@ -1,35 +1,12 @@ -"""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 +NAME_INDEX: Final = 1 +PRICE_INDEX: Final = 2 +QUANTITY_INDEX: Final = 3 -# TODO: задайте идентификатор первого товара в пустом хранилище -PRODUCT_ID_MIN: Final[int] = 0 +PRODUCT_ID_MIN: Final[int] = 1 diff --git a/src/part3/utils.py b/src/part3/utils.py index 318ded0b..37a954eb 100644 --- a/src/part3/utils.py +++ b/src/part3/utils.py @@ -1,95 +1,59 @@ -"""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 decimal import ROUND_HALF_UP, Decimal 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, ...]] = () +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final = Decimal(1).scaleb(-PRICE_PRECISION) +TABLE_HEADERS: Final[tuple[str, ...]] = ("ID", "name", "price", "quantity") 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) + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) 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: при необходимости добавьте свои вспомогательные функции + return (" ".join(name.split())).lower() + + +def size_check(storage: list[Product]) -> list[int]: # находит нужные размеры столбцов + column_size = [[2], [4], [5], [8]] + for prod in storage: + for ind in range(4): + column_size[ind].append(len(str(prod[ind]))) + return [max(column_size[i]) for i in range(4)] + + +def output_line( + values: Product | tuple[str, ...], size: list[int] +) -> str: # выводит строку таблицы + if values[0] == "-": + line = ( + "|" + + "-" * (2 + size[0]) + + "|" + + "-" * (2 + size[1]) + + "|" + + "-" * (2 + size[2]) + + "|" + + "-" * (2 + size[3]) + + "|" + ) + else: + line = "|" + for ind in range(4): + value = str(values[ind]) + line += f" {value} " + " " * (size[ind] - len(value)) + "|" + print(line) + return line 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 "" + final_size = size_check(storage) + result = "" + result += output_line(TABLE_HEADERS, final_size) + result += output_line(tuple("-"), final_size) + for prod in storage: + result += output_line(prod, final_size) + return result diff --git a/src/part4/cart.py b/src/part4/cart.py index aed9bb72..d33513ef 100644 --- a/src/part4/cart.py +++ b/src/part4/cart.py @@ -1,53 +1,31 @@ -"""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: при необходимости добавьте свои вспомогательные функции +from .crud import id_check +from .storage import QUANTITY_KEY, Product def add_to_cart( storage: dict[str, Product], - product_names: set[str], + 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. + if not id_check(product_id, storage): + return None + if storage[product_id][QUANTITY_KEY] < quantity: + print( + f"not enough stock for product {product_id}: {storage[product_id][QUANTITY_KEY]} available, {quantity} requested" + ) + return None - 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. + if product_id in cart: + cart[product_id] += quantity + else: + cart[product_id] = storage[product_id][QUANTITY_KEY] + cart[product_id] = quantity + storage[product_id][QUANTITY_KEY] -= quantity - 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 + return cart[product_id] def remove_from_cart( @@ -57,31 +35,21 @@ def remove_from_cart( 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 + 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) of product {product_id}, cannot remove {quantity}" + ) + return None + if not id_check(product_id, storage): + return None + + storage[product_id][QUANTITY_KEY] += quantity + cart[product_id] -= quantity + if cart[product_id] == 0: + del cart[product_id] + return 0 + return cart[product_id] diff --git a/src/part4/crud.py b/src/part4/crud.py index 471eff00..68947c14 100644 --- a/src/part4/crud.py +++ b/src/part4/crud.py @@ -1,48 +1,34 @@ -"""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 +import uuid from typing import Any -from .storage import ( # noqa: F401 +from .storage import ( NAME_KEY, PRICE_KEY, - QUANTITY_KEY, Product, ) -from .utils import normalize_price, normalize_product_name # noqa: F401 +from .utils import normalize_price, normalize_product_name def generate_product_id() -> str: - """Generate an identifier for a new product. + return str(uuid.uuid4()) - Returns: - A freshly generated UUID, stringified. - """ - # TODO: реализуйте функцию - return "" + +def name_check(name: str, product_names: set[str]) -> bool | str: + name = normalize_product_name(name) + if name == "": + print("product name must not be blank") + return False + if name in product_names: + print(f"product name {name} is already taken") + return False + return name + + +def id_check(num_id: str, storage: dict[str, Product]) -> bool: + if num_id not in storage: + print(f"no product with id {num_id}") + return False + return True def create_product( @@ -50,46 +36,22 @@ def create_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 "" + check1 = name_check(fields[NAME_KEY], product_names) + if not check1: + return None + fields[NAME_KEY] = check1 + product_names.add(fields[NAME_KEY]) + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + new_id = generate_product_id() + storage[new_id] = fields + return new_id -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 read_product(storage: dict[str, Product], product_id: str) -> Product | None: + if not id_check(product_id, storage): + return None + return storage[product_id] def update_product( @@ -98,39 +60,29 @@ def update_product( 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 {} + + if not id_check(product_id, storage): + return None + + if NAME_KEY in fields: + fields[NAME_KEY] = normalize_product_name(fields[NAME_KEY]) + name = fields[NAME_KEY] + if name == "": + print("product name must not be blank") + return None + if name in product_names and storage[product_id][NAME_KEY] != name: + print(f"product name {name} is already taken") + return None + if storage[product_id][NAME_KEY] != name: + product_names.add(name) + product_names.remove(storage[product_id][NAME_KEY]) + + if PRICE_KEY in fields: + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + + for nkey, value in fields.items(): + storage[product_id][nkey] = value + return storage[product_id] def delete_product( @@ -138,20 +90,9 @@ def delete_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 "" + + if not id_check(product_id, storage): + return None + product_names.remove(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 index 2247b29b..2438e8bf 100644 --- a/src/part4/run_admin.py +++ b/src/part4/run_admin.py @@ -1,110 +1,100 @@ -"""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 decimal import Decimal from typing import Final -from .crud import ( # noqa: F401 +from .crud import ( 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 +from .storage import NAME_KEY, PRICE_KEY, QUANTITY_KEY, Product +from .utils import get_storage_str_representation -# TODO: задайте приглашение и текст справки (используйте своё решение части 3) -PROMPT: Final[str] = "" -HELP_TEXT: Final[str] = "" +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 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 show_help() -> None: + print(HELP_TEXT) 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) + if result: + print(result) 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 + words = line.split() + match words: + case ["help"]: + show_help() + return True + case ["exit"]: + return False + case ["show"]: + get_storage_str_representation(storage) + return True + case ["create", *_, price, quantity]: + name = " ".join(words[1:-2]) + pocket_create = create_product( + storage, + product_names, + { + NAME_KEY: name, + PRICE_KEY: Decimal(price), + QUANTITY_KEY: int(quantity), + }, + ) + if pocket_create: + print(pocket_create) + return True + case ["read", id_num]: + output = read_product(storage, str(id_num)) + if output: + print(output) + return True + case ["update", id_num, *_, price, quantity]: + name = " ".join(words[2:-2]) + pocket_update = update_product( + storage, + product_names, + str(id_num), + { + NAME_KEY: name, + PRICE_KEY: Decimal(price), + QUANTITY_KEY: int(quantity), + }, + ) + if pocket_update: + print(pocket_update) + return True + case ["delete", id_num]: + pocket_delete = delete_product(storage, product_names, str(id_num)) + if pocket_delete: + print(pocket_delete) + return True + case _: + sentance = " ".join(words) + print(f"'{sentance}' 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 @@ -115,7 +105,7 @@ def main() -> None: try: running = run_command(storage, product_names, line) - except (ValueError, InvalidOperation): + except ValueError: print(f"{line!r} names a command but its arguments are invalid") diff --git a/src/part4/storage.py b/src/part4/storage.py index 9acedf07..fe192215 100644 --- a/src/part4/storage.py +++ b/src/part4/storage.py @@ -1,45 +1,8 @@ -"""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 = "" +NAME_KEY: Final = "name" +PRICE_KEY: Final = "price" +QUANTITY_KEY: Final = "quantity" diff --git a/src/part4/utils.py b/src/part4/utils.py index d2a940ea..8ae18b2b 100644 --- a/src/part4/utils.py +++ b/src/part4/utils.py @@ -1,27 +1,7 @@ -"""Standalone helpers shared by the part4 storage and CRUD modules. +from decimal import ROUND_HALF_UP, Decimal +from typing import Any, Final -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 +from .storage import ( NAME_KEY, PRICE_KEY, QUANTITY_KEY, @@ -29,72 +9,72 @@ ) -# 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, ...]] = () +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final = Decimal(1).scaleb(-PRICE_PRECISION) +TABLE_HEADERS: Final[tuple[str, ...]] = ("ID", NAME_KEY, PRICE_KEY, QUANTITY_KEY) 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) + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) 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: при необходимости добавьте свои вспомогательные функции + return (" ".join(name.split())).lower() + + +def size_check( + storage: dict[str, Product], +) -> dict[str, int]: # находит нужные размеры столбцов + column_size = {"ID": [2], NAME_KEY: [4], PRICE_KEY: [5], QUANTITY_KEY: [8]} + for num, value in storage.items(): + column_size["ID"].append(len(str(num))) + for prod in value: + column_size[prod].append(len(str(value[prod]))) + return {name: max(column_size[name]) for name in column_size} + + +def output_line( + values: tuple[Any, ...], size: dict[str, int] +) -> str: # выводит строку таблицы + if values[0] == "-": + line = ( + "|" + + "-" * (2 + size["ID"]) + + "|" + + "-" * (2 + size[NAME_KEY]) + + "|" + + "-" * (2 + size[PRICE_KEY]) + + "|" + + "-" * (2 + size[QUANTITY_KEY]) + + "|" + ) + else: + line = "|" + for ind in range(4): + value = str(values[ind]) + line += f" {value} " + " " * (size[TABLE_HEADERS[ind]] - len(value)) + "|" + print(line) + return line + + +def tuple_with_dict( + object: tuple[Any, dict[str, Any]], +) -> tuple[Any, ...]: # Объект в корзине -> tuple + rez = [] + for part in object: + if isinstance(part, dict): + for name in TABLE_HEADERS[1:]: + rez.append(part[name]) + else: + rez.append(part) + return tuple(rez) 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 "" + final_size = size_check(storage) + result = "" + result += output_line(TABLE_HEADERS, final_size) + result += output_line(tuple("-"), final_size) + for prod in storage.items(): + result += output_line(tuple_with_dict(prod), final_size) + return result diff --git a/src/part5/cart.py b/src/part5/cart.py index a2363b3a..05c04b20 100644 --- a/src/part5/cart.py +++ b/src/part5/cart.py @@ -1,18 +1,5 @@ -"""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: при необходимости добавьте свои вспомогательные функции +from .crud import id_check +from .storage import QUANTITY_KEY, Product def add_to_cart( @@ -22,33 +9,23 @@ def add_to_cart( product_id: int, 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 (by :func:`~src.part5.crud.read_product`) and nothing - changes. If the store holds fewer units than requested, an explanatory - message is printed and nothing changes. Otherwise the store record is - decremented by ``quantity`` and the cart gains ``quantity`` units of - ``product_id`` -- the product is added when the cart had none of it. + if not id_check(product_id, storage): + return None + if storage[product_id][QUANTITY_KEY] < quantity: + print( + f"not enough stock for product {product_id}: {storage[product_id][QUANTITY_KEY]} available, {quantity} requested" + ) + return None - Args: - storage: The product store to draw stock from; modified in place on - success. - product_names: The normalised names in ``storage``; threaded - through to :func:`~src.part5.crud.update_product`, which - keeps it in sync (a quantity-only update 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. + if product_id in cart: + cart[product_id] += quantity + else: + cart[product_id] = storage[product_id][QUANTITY_KEY] + cart[product_id] = quantity + storage[product_id][QUANTITY_KEY] -= quantity - 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: реализуйте функцию (используйте своё решение части 4) - return 0 + return cart[product_id] def remove_from_cart( @@ -58,31 +35,21 @@ def remove_from_cart( product_id: int, 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. 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``; threaded - through to :func:`~src.part5.crud.update_product`, which - keeps it in sync (a quantity-only update 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: реализуйте функцию (используйте своё решение части 4) - return 0 + 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) of product {product_id}, cannot remove {quantity}" + ) + return None + if not id_check(product_id, storage): + return None + + storage[product_id][QUANTITY_KEY] += quantity + cart[product_id] -= quantity + if cart[product_id] == 0: + del cart[product_id] + return 0 + return cart[product_id] diff --git a/src/part5/constants.py b/src/part5/constants.py index 984671bb..5a104935 100644 --- a/src/part5/constants.py +++ b/src/part5/constants.py @@ -1,37 +1,14 @@ -"""Bit layout and default epoch for the Twitter Snowflake ID generator. - -A Snowflake identifier is a 63-bit positive integer packed as follows, from -the most significant bit downwards: - - 1 bit unused sign bit, always zero - 41 bits milliseconds elapsed since a custom epoch - 10 bits node identifier - 12 bits per-millisecond sequence counter - -The shift and mask constants should be derived from the bit widths so that -changing a width keeps everything else consistent. -""" - from typing import Final -# TODO: замените заглушки (0) на корректные значения (используйте своё решение -# части 1). - -# Twitter's original Snowflake epoch: 2010-11-04 01:42:54.657 UTC. -EPOCH_MS_DEFAULT: Final[int] = 0 - -# Node identifier used when the caller does not supply one. -NODE_ID_DEFAULT: Final[int] = 0 +EPOCH_MS_DEFAULT: Final[int] = 1288834974657 -# Width of each field, in bits. -TIMESTAMP_BITS: Final[int] = 0 -NODE_ID_BITS: Final[int] = 0 -SEQUENCE_ID_BITS: Final[int] = 0 +NODE_ID_DEFAULT: Final[int] = 1 -# 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_BITS: Final[int] = 41 +NODE_ID_BITS: Final[int] = 10 +SEQUENCE_ID_BITS: Final[int] = 12 -# Здесь можно добавить собственные вспомогательные константы +TIMESTAMP_MS_MAX: Final[int] = 2**TIMESTAMP_BITS - 1 +NODE_ID_MAX: Final[int] = 2**NODE_ID_BITS - 1 +SEQUENCE_ID_MAX: Final[int] = 2**SEQUENCE_ID_BITS - 1 diff --git a/src/part5/crud.py b/src/part5/crud.py index 243b0528..8ed73738 100644 --- a/src/part5/crud.py +++ b/src/part5/crud.py @@ -1,191 +1,124 @@ -"""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.part5.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.part5.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 not chosen by :func:`create_product` -itself: the caller hands in a zero-argument ``generate_id`` function that -returns the next identifier (or ``None`` when it cannot issue one), so the -identifier scheme can be swapped without touching the CRUD code. The module -supplies :func:`generate_snowflake_id`, backed by a Twitter Snowflake -generator (see :mod:`src.part5.snowflake`); the identifiers it issues -grow with creation time, so they are roughly ordered by insertion. - -Every product name that reaches the store is passed through -:func:`~src.part5.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()``. - -The four store operations (everything except :func:`generate_snowflake_id`) -should be decorated with :func:`~src.part5.decorators.collect_stats`, which -counts their successful calls and their failed ones (those returning -``None``) in the module-level :data:`STATS_REGISTRY`, filed under -:data:`CREATE_KEY`, :data:`READ_KEY`, :data:`UPDATE_KEY` and -:data:`DELETE_KEY`. The counters live for the lifetime of the process and -are shared by every store. -""" - from collections.abc import Callable from typing import Any, Final -from .decorators import Registry -from .storage import Product +from .decorators import Registry, collect_stats +from .snowflake import get_snowflake_id_generator +from .storage import ( + NAME_KEY, + PRICE_KEY, + Product, +) +from .utils import normalize_price, normalize_product_name STATS_REGISTRY: Final[Registry] = {} -# TODO: задайте ключи операций в реестре, см. TASK.md -CREATE_KEY: Final[str] = "" -READ_KEY: Final[str] = "" -UPDATE_KEY: Final[str] = "" -DELETE_KEY: Final[str] = "" -# TODO: при необходимости заведите здесь общий генератор Snowflake-идентификаторов -# для generate_snowflake_id (см. TASK.md) +CREATE_KEY: Final[str] = "create" +READ_KEY: Final[str] = "read" +UPDATE_KEY: Final[str] = "update" +DELETE_KEY: Final[str] = "delete" + + +general_generator = get_snowflake_id_generator() def generate_snowflake_id() -> int | None: - """Issue the next product identifier from the shared Snowflake generator. + if general_generator is None: + return None + result = general_generator() + return result - This is the identifier source callers pass to :func:`create_product`. - Returns: - A positive 63-bit Snowflake integer, or ``None`` (after a message - has been printed) when no identifier can be issued right now -- see - :func:`~src.part5.snowflake.get_snowflake_id_generator` for the - cases. - """ - # TODO: реализуйте функцию - return 0 +def name_check(name: str, product_names: set[str]) -> bool | str: + name = normalize_product_name(name) + if name == "": + print("product name must not be blank") + return False + if name in product_names: + print(f"product name {name} is already taken") + return False + return name -# TODO: оберните операцию декоратором collect_stats +@collect_stats(CREATE_KEY, STATS_REGISTRY) def create_product( storage: dict[int, Product], product_names: set[str], fields: dict[str, Any], generate_id: Callable[[], int | None], ) -> int | None: - """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.part5.storage.NAME_KEY`, - :data:`~src.part5.storage.PRICE_KEY` and - :data:`~src.part5.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. - generate_id: A zero-argument function returning the identifier for - the new product, or ``None`` if it cannot issue one (for - example :func:`generate_snowflake_id`). It is only expected to - return an identifier that is not yet a key of ``storage``. - - Returns: - The identifier returned by ``generate_id`` for the new product, or - ``None`` when ``name`` is blank once normalised, a product with - the same normalised name already exists, or ``generate_id`` - returned ``None``. In the ``None`` case ``storage`` and - ``product_names`` are left unchanged and an explanatory message is - printed (for the last case, by ``generate_id`` itself). - """ - # TODO: реализуйте функцию - return 0 - - -# TODO: оберните операцию декоратором collect_stats -def read_product(storage: dict[int, 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. + check = name_check(fields[NAME_KEY], product_names) + if not check: + return None + + new_id = generate_id() + if new_id is None: + return None + + fields[NAME_KEY] = check + product_names.add(fields[NAME_KEY]) + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) - Returns: - The matching product record, or ``None`` when no product carries - that identifier (a message is printed in that case). - """ - # TODO: реализуйте функцию (используйте своё решение части 4) - return {} + storage[new_id] = fields + return new_id -# TODO: оберните операцию декоратором collect_stats +def id_check(num_id: int, storage: dict[int, Product]) -> bool: + if num_id not in storage: + print(f"no product with id {num_id}") + return False + return True + + +@collect_stats(READ_KEY, STATS_REGISTRY) +def read_product(storage: dict[int, Product], product_id: int) -> Product | None: + if not id_check(product_id, storage): + return None + return storage[product_id] + + +@collect_stats(UPDATE_KEY, STATS_REGISTRY) def update_product( storage: dict[int, Product], product_names: set[str], product_id: int, fields: dict[str, Any], ) -> Product | None: - """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.part5.storage.NAME_KEY`, - :data:`~src.part5.storage.PRICE_KEY` and - :data:`~src.part5.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: реализуйте функцию (используйте своё решение части 4) - return {} - - -# TODO: оберните операцию декоратором collect_stats + if not id_check(product_id, storage): + return None + + if NAME_KEY in fields: + fields[NAME_KEY] = normalize_product_name(fields[NAME_KEY]) + name = fields[NAME_KEY] + if name == "": + print("product name must not be blank") + return None + if name in product_names and storage[product_id][NAME_KEY] != name: + print(f"product name {name} is already taken") + return None + if storage[product_id][NAME_KEY] != name: + product_names.add(name) + product_names.remove(storage[product_id][NAME_KEY]) + + if PRICE_KEY in fields: + fields[PRICE_KEY] = normalize_price(fields[PRICE_KEY]) + + for nkey, value in fields.items(): + storage[product_id][nkey] = value + return storage[product_id] + + +@collect_stats(DELETE_KEY, STATS_REGISTRY) def delete_product( storage: dict[int, Product], product_names: set[str], 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_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: реализуйте функцию (используйте своё решение части 4) - return 0 + + if not id_check(product_id, storage): + return None + product_names.remove(storage[product_id][NAME_KEY]) + del storage[product_id] + return product_id diff --git a/src/part5/decorators.py b/src/part5/decorators.py index 21a9f237..11efbb90 100644 --- a/src/part5/decorators.py +++ b/src/part5/decorators.py @@ -1,25 +1,10 @@ -"""Decorators that add bookkeeping around the part5 CRUD operations. - -The module provides :func:`collect_stats`, a parametric decorator that counts -how often a function succeeds and how often it fails. The counters are kept in -a *registry* shared with the caller -- a plain dictionary mapping a string key -to a :data:`Stats` record -- so that other code (for example the ``stats`` -command of :mod:`src.part5.run_admin`) can read them without knowing -anything about the decorated functions. - -A call counts as a failure when the decorated function returns ``None`` -- the -convention every operation in :mod:`src.part5.crud` uses to report that it -printed an explanation and changed nothing. Any other return value, including -a falsy one such as ``0``, counts as a success. -""" - from collections.abc import Callable -from typing import Final +from functools import wraps +from typing import Any, Final -# TODO: задайте имена двух счётчиков, см. TASK.md -SUCCESS_KEY: Final[str] = "" -FAILS_KEY: Final[str] = "" +SUCCESS_KEY: Final[str] = "success" +FAILS_KEY: Final[str] = "fails" type Stats = dict[str, int] @@ -29,29 +14,25 @@ def collect_stats[**P, R]( key: str, registry: Registry ) -> Callable[[Callable[P, R | None]], Callable[P, R | None]]: - """Build a decorator that counts successful and failed calls of a function. - - Decorating registers a fresh record ``{"success": 0, "fails": 0}`` in - ``registry`` under ``key``. Every call of the decorated function then - updates that record in place: a call that returns ``None`` adds one to the - failure counter, any other result adds one to the success counter. The - result is passed through unchanged, and a call that raises an exception - is not counted at all. - - If ``key`` is already in ``registry``, a message is printed, the existing - record is left untouched and the function is returned undecorated, so its - calls never mix into the counters of whoever registered the key first. - - Args: - key: The registry key to keep this function's counters under, for - example the name of the console command it implements. - registry: The dictionary that receives the counters; modified in - place when the function is decorated and on every later call. - - Returns: - A decorator for a function whose result is either some value or - ``None``. The decorated function has the same signature, name and - docstring as the original (see :func:`functools.wraps`). - """ - # TODO: реализуйте декоратор - return lambda function: function + + def generator(function: Callable[P, R | None]) -> Callable[P, R | None]: + + if key in registry: + print(f"stats key {key!r} is already registered") + return function + registry[key] = {"success": 0, "fails": 0} + + @wraps(function) + def wrapper(*args: Any, **kwargs: Any) -> R | None: + result = function(*args, **kwargs) + + if result is None: + registry[key][FAILS_KEY] += 1 + else: + registry[key][SUCCESS_KEY] += 1 + + return result + + return wrapper + + return generator diff --git a/src/part5/run_admin.py b/src/part5/run_admin.py index d2e83947..7e1a6d9d 100644 --- a/src/part5/run_admin.py +++ b/src/part5/run_admin.py @@ -1,112 +1,114 @@ -"""Interactive admin console for the part5 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; -* ``stats`` -- print how many times each CRUD command succeeded and failed, - with its success rate, as a text table. - -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.part5.crud`; whatever -that call returns is printed unless it is ``None``. ``create`` hands -:func:`~src.part5.crud.generate_snowflake_id` to the CRUD layer as the -source of the new product's identifier; the ```` typed for ``read``, -``update`` and ``delete`` is converted to an integer before it is looked -up. The counters behind ``stats`` are collected by the CRUD layer itself -(:data:`~src.part5.crud.STATS_REGISTRY`); a command whose arguments do -not parse never reaches it and is not counted. 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 InvalidOperation +from decimal import Decimal, InvalidOperation from typing import Final -from .storage import Product - - -# TODO: задайте приглашение и текст справки (используйте своё решение части 4, -# не забудьте добавить команду stats, см. TASK.md) -PROMPT: Final[str] = "" -HELP_TEXT: Final[str] = "" +from .crud import ( + STATS_REGISTRY, + create_product, + delete_product, + generate_snowflake_id, + read_product, + update_product, +) +from .storage import NAME_KEY, PRICE_KEY, QUANTITY_KEY, Product +from .utils import get_stats_str_representation, get_storage_str_representation + + +PROMPT: Final[str] = "admin> " +HELP_TEXT: Final[str] = """Available commands: + help show this message + exit leave the console + show print the whole store as a table + create add a product, print its new id + read print the product with that id + update overwrite that product's fields + delete remove the product with that id + stats print call statistics of the CRUD commands + +For create and update the price and quantity are the last two words of the +line; everything before them is the product name, so it may contain spaces +(for example "Gibson SG Junior") and needs no quoting.""" def show_help() -> None: - """Print 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: реализуйте функцию (используйте своё решение части 4) + print(HELP_TEXT) 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: реализуйте функцию (используйте своё решение части 4) + if result: + print(result) def run_command( storage: dict[int, 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 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 + words = line.split() + match words: + case ["help"]: + show_help() + return True + + case ["exit"]: + return False + + case ["show"]: + get_storage_str_representation(storage) + return True + + case ["create", *_, price, quantity]: + name = " ".join(words[1:-2]) + pocket_create = create_product( + storage, + product_names, + { + NAME_KEY: name, + PRICE_KEY: Decimal(price), + QUANTITY_KEY: int(quantity), + }, + generate_snowflake_id, + ) + if pocket_create: + print(pocket_create) + return True + + case ["read", id_num]: + output = read_product(storage, int(id_num)) + if output: + print(output) + return True + + case ["update", id_num, *_, price, quantity]: + name = " ".join(words[2:-2]) + pocket_update = update_product( + storage, + product_names, + int(id_num), + { + NAME_KEY: name, + PRICE_KEY: Decimal(price), + QUANTITY_KEY: int(quantity), + }, + ) + if pocket_update: + print(pocket_update) + return True + + case ["delete", id_num]: + pocket_delete = delete_product(storage, product_names, int(id_num)) + if pocket_delete: + print(pocket_delete) + return True + + case ["stats"]: + get_stats_str_representation(STATS_REGISTRY) + return True + + case _: + sentance = " ".join(words) + print(f"'{sentance}' 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[int, Product] = {} product_names: set[str] = set() running = True diff --git a/src/part5/snowflake.py b/src/part5/snowflake.py index 64e28468..720b18b0 100644 --- a/src/part5/snowflake.py +++ b/src/part5/snowflake.py @@ -1,112 +1,70 @@ -"""Twitter Snowflake identifier generator. - -Snowflake produces roughly time-ordered 64-bit integer identifiers without -coordination between nodes. Each identifier packs the milliseconds elapsed -since a custom epoch, a node identifier and a per-millisecond sequence counter -into a single 63-bit positive integer (see ``constants`` for the layout). - -The public entry point is :func:`get_snowflake_id_generator`. It validates the -node identifier once and returns a closure that keeps the sequence counter and -the last seen millisecond itself, so each new identifier needs only a call -without arguments. - -Each packed field can be read back on its own with :func:`decode_timestamp_ms`, -:func:`decode_node_id` and :func:`decode_sequence_id`. -""" - +import time from collections.abc import Callable -from .constants import EPOCH_MS_DEFAULT, NODE_ID_DEFAULT +from .constants import ( + EPOCH_MS_DEFAULT, + NODE_ID_DEFAULT, + NODE_ID_MAX, + SEQUENCE_ID_MAX, + TIMESTAMP_MS_MAX, +) def read_current_millis(epoch_ms: int) -> int: - """Read the number of milliseconds elapsed since the custom epoch. - - Args: - epoch_ms: The custom epoch expressed as Unix milliseconds. - - Returns: - The count of whole milliseconds between ``epoch_ms`` and now. Negative - if ``epoch_ms`` lies in the future. - """ - # TODO: реализуйте функцию (используйте своё решение части 1) - return 0 + return int(time.time() * 1000) - epoch_ms def decode_timestamp_ms(snowflake_id: int, epoch_ms: int = EPOCH_MS_DEFAULT) -> int: - """Read the timestamp field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced against the same epoch. - epoch_ms: The epoch the identifier was generated against. Defaults to - the original Twitter epoch (2010-11-04 01:42:54.657 UTC). - - Returns: - The absolute Unix time in milliseconds at which the identifier was - generated. - """ - # TODO: реализуйте функцию (используйте своё решение части 1) - return 0 + return int((bin(snowflake_id)[2:]).zfill(64)[1:42], 2) + epoch_ms def decode_node_id(snowflake_id: int) -> int: - """Read the node identifier field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by a generator from - :func:`get_snowflake_id_generator`. - - Returns: - The node identifier packed into ``snowflake_id``, in the range - ``[0, NODE_ID_MAX]``. - """ - # TODO: реализуйте функцию (используйте своё решение части 1) - return 0 + return int((bin(snowflake_id)[2:]).zfill(64)[42:52], 2) def decode_sequence_id(snowflake_id: int) -> int: - """Read the sequence counter field out of a Snowflake identifier. - - Args: - snowflake_id: An identifier produced by a generator from - :func:`get_snowflake_id_generator`. - - Returns: - The per-millisecond sequence counter packed into ``snowflake_id``, in - the range ``[0, SEQUENCE_ID_MAX]``. - """ - # TODO: реализуйте функцию (используйте своё решение части 1) - return 0 + return int(bin(snowflake_id)[52:], 2) def get_snowflake_id_generator( node_id: int = NODE_ID_DEFAULT, epoch_ms: int = EPOCH_MS_DEFAULT, ) -> Callable[[], int | None] | None: - """Create a stateful Snowflake identifier generator bound to one node. - - The returned closure remembers the millisecond of its previous call and the - per-millisecond sequence counter, so callers never pass them in. - - Args: - node_id: The identifier of this node, in the range ``[0, NODE_ID_MAX]``. - Optional; defaults to ``NODE_ID_DEFAULT``. - epoch_ms: The start of the epoch as Unix milliseconds. Optional; - defaults to the original Twitter epoch (2010-11-04 01:42:54.657 - UTC). - - Returns: - A zero-argument function ``generate_snowflake_id``. Each call returns a - positive 63-bit integer identifier. It returns ``None`` (after printing - an explanatory message to stdout) if more than ``SEQUENCE_ID_MAX + 1`` - identifiers are requested within one millisecond, or if the elapsed - time no longer fits in the timestamp field (roughly 69 years after - ``epoch_ms``). A failed call does not break the generator: it recovers - once the clock moves on to the next millisecond. - - ``None`` is returned instead of a generator, after printing a message - to stdout, if ``node_id`` is outside ``[0, NODE_ID_MAX]`` or - ``epoch_ms`` lies in the future. - """ - # TODO: реализуйте функцию - return lambda: 0 + + if node_id > NODE_ID_MAX or node_id < 0: + print(f"node_id must be in [0, {NODE_ID_MAX}], got {node_id}") + return None + if read_current_millis(epoch_ms) < 0: + print(f"epoch_ms must not be in the future, got {epoch_ms}") + return None + + sequence_id = -1 + internal_time = time.time() + + def generator() -> int | None: + nonlocal internal_time + nonlocal sequence_id + + if internal_time != time.time(): + sequence_id = 0 + internal_time = time.time() + else: + sequence_id += 1 + + if sequence_id > SEQUENCE_ID_MAX: + print(f"sequence_id must be in [0, {SEQUENCE_ID_MAX}], got {sequence_id}") + return None + + time_id = read_current_millis(epoch_ms) + if time_id > TIMESTAMP_MS_MAX: + print(f"timestamp {time_id} ms overflows {TIMESTAMP_MS_MAX} ms") + return None + + return int( + bin(time_id)[2:].zfill(41) + + bin(node_id)[2:].zfill(10) + + bin(sequence_id)[2:].zfill(12), + 2, + ) + + return generator diff --git a/src/part5/storage.py b/src/part5/storage.py index fa8ef3bb..fe192215 100644 --- a/src/part5/storage.py +++ b/src/part5/storage.py @@ -1,44 +1,8 @@ -"""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 -Snowflake integer issued by the identifier generator handed to the create -operation in :mod:`src.part5.crud` -- to its :data:`Product` record -- -a dictionary with the keys ``name``, ``price`` and ``quantity`` -- where: - -* the ``storage`` key itself -- unique integer identifier, issued by the - generator passed to the create operation in :mod:`src.part5.crud`; - it is not duplicated inside the record; -* ``name`` -- human-readable product name, unique across the store, held - in normalised form (see - :func:`src.part5.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.part5.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.part5.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.part5.crud` keep the two in sync on every -successful create, update and delete. -""" - from typing import Any, Final type Product = dict[str, Any] -# TODO: задайте имена полей записи (используйте своё решение части 4) -NAME_KEY: Final = "" -PRICE_KEY: Final = "" -QUANTITY_KEY: Final = "" +NAME_KEY: Final = "name" +PRICE_KEY: Final = "price" +QUANTITY_KEY: Final = "quantity" diff --git a/src/part5/utils.py b/src/part5/utils.py index b2ad4dc4..da0b07ae 100644 --- a/src/part5/utils.py +++ b/src/part5/utils.py @@ -1,120 +1,125 @@ -"""Standalone helpers shared by the part5 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. -* :func:`get_stats_str_representation` renders the call statistics gathered - by :func:`~src.part5.decorators.collect_stats` as a table of the same - look, with the success rate of every command as a percentage. -""" - -from decimal import Decimal -from typing import Final +from decimal import ROUND_HALF_UP, Decimal +from typing import Any, Final from .decorators import Registry -from .storage import Product - +from .storage import ( + NAME_KEY, + PRICE_KEY, + QUANTITY_KEY, + Product, +) -# TODO: задайте число знаков после запятой и шаг квантования (используйте своё -# решение части 4) -PRICE_PRECISION: Final[int] = 0 -PRICE_STEP: Final = Decimal(0) +PRICE_PRECISION: Final[int] = 2 +PRICE_STEP: Final = Decimal(1).scaleb(-PRICE_PRECISION) -# TODO: задайте заголовки столбцов таблицы (используйте своё решение части 4) -TABLE_HEADERS: Final[tuple[str, ...]] = () -# TODO: задайте заголовки столбцов таблицы статистики, см. TASK.md -STATS_TABLE_HEADERS: Final[tuple[str, ...]] = () +TABLE_HEADERS: Final[tuple[str, ...]] = ("ID", NAME_KEY, PRICE_KEY, QUANTITY_KEY) +STATS_TABLE_HEADERS: Final[tuple[str, ...]] = ( + "command name", + "success", + "fails", + "success rate", +) 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: реализуйте функцию (используйте своё решение части 4) - return Decimal(0) + return price.quantize(PRICE_STEP, rounding=ROUND_HALF_UP) 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: реализуйте функцию (используйте своё решение части 4) - return "" - - -# TODO: при необходимости добавьте свои вспомогательные функции + return (" ".join(name.split())).lower() + + +def size_check( + storage: dict[Any, dict[str, Any]], headers: tuple[str, ...] +) -> dict[str, int]: # находит нужные размеры столбцов + + column_size = {} + for item in headers: + column_size[item] = [len(item)] + + for name, values in storage.items(): + column_size[headers[0]].append(len(str(name))) + for prod in values: + column_size[prod].append(len(str(values[prod]))) + + return {name: max(column_size[name]) for name in column_size} + + +def output_line( + values: tuple[Any, ...], size: dict[Any, int], headers: tuple[str, ...] +) -> str: # выводит строку таблицы + if values[0] == "-": + line = ( + "|" + + "-" * (2 + size[headers[0]]) + + "|" + + "-" * (2 + size[headers[1]]) + + "|" + + "-" * (2 + size[headers[2]]) + + "|" + + "-" * (2 + size[headers[3]]) + + "|" + ) + else: + line = "|" + for ind in range(len(values)): + value = str(values[ind]) + line += f" {value} " + " " * (size[headers[ind]] - len(value)) + "|" + + if len(values) == 3: + if values[1] + values[2] == 0: + line += " 0.00% " + " " * (size[headers[ind]] - len(value)) + "|" + else: + value = round(values[1] / (values[1] + values[2]), 4) + line += ( + f" {f'{value:.2%}'} " + + " " * (size[headers[ind]] - len(f"{value:.2%}")) + + "|" + ) + + print(line) + return line + "\n" + + +def tuple_with_dict( + object: tuple[Any, dict[str, Any]], + headers: tuple[str, ...], +) -> tuple[Any, ...]: # Объект в корзине -> tuple + rez = [] + for part in object: + if isinstance(part, dict): + if headers is STATS_TABLE_HEADERS: + for name in headers[1:-1]: + rez.append(part[name]) + else: + for name in headers[1:]: + rez.append(part[name]) + else: + rez.append(part) + return tuple(rez) def get_storage_str_representation(storage: dict[int, 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: реализуйте функцию (используйте своё решение части 4) - return "" + result = "" + final_size = size_check(storage, TABLE_HEADERS) + result += output_line(TABLE_HEADERS, final_size, TABLE_HEADERS) + result += output_line(tuple("-"), final_size, TABLE_HEADERS) + for prod in storage.items(): + result += output_line( + tuple_with_dict(prod, TABLE_HEADERS), final_size, TABLE_HEADERS + ) + return result def get_stats_str_representation(registry: Registry) -> str: - """Render the call statistics as a text table with data-sized columns. - - The table has the columns named by :data:`STATS_TABLE_HEADERS` -- command - name, number of successful calls, number of failed calls and success - rate. It is laid out like the one from - :func:`get_storage_str_representation`: every column is as wide as the - longest value it carries, its header counted. - - Args: - registry: The statistics to render, a mapping of command name to the - counters kept by :func:`~src.part5.decorators.collect_stats`. - - Returns: - A multi-line string: a header row, a dashed separator row, then one - row per registry entry in insertion order. When ``registry`` is - empty only the header and separator rows are returned, sized to the - header labels. - """ - # TODO: реализуйте функцию - return "" + result = "" + final_size = size_check(registry, STATS_TABLE_HEADERS) + result += output_line(STATS_TABLE_HEADERS, final_size, STATS_TABLE_HEADERS) + result += output_line(tuple("-"), final_size, STATS_TABLE_HEADERS) + for line in registry.items(): + result += output_line( + tuple_with_dict(line, STATS_TABLE_HEADERS), final_size, STATS_TABLE_HEADERS + ) + + return result