Skip to content

refactor: switch input parameters from dict to Mapping #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 26, 2025
Merged

refactor: switch input parameters from dict to Mapping #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b29d2e9
refactor: switch input parameters from dict to Mapping
github-actions[bot] Oct 26, 2025
55adfe3
chore: regenerate sync library after Mapping refactor
github-actions[bot] Oct 26, 2025
ad70497
fix: resolve type checking issues with Mapping refactor
github-actions[bot] Oct 26, 2025
db2448a
Merge branch 'main' into claude/issue-94-20251026-0043
strawgate Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/adapters/raise_on_missing/adapter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, Literal, SupportsFloat, overload

from key_value.shared.errors import MissingKeyError
Expand Down Expand Up @@ -138,7 +138,7 @@ async def ttl_many(

return results

async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
"""Store a key-value pair in the specified collection with optional TTL.

Args:
Expand All @@ -153,7 +153,7 @@ async def put(self, key: str, value: dict[str, Any], *, collection: str | None =
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/protocols/key_value.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, Protocol, SupportsFloat, runtime_checkable


Expand Down Expand Up @@ -36,7 +36,7 @@ async def ttl(self, key: str, *, collection: str | None = None) -> tuple[dict[st
"""
...

async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
"""Store a key-value pair in the specified collection with optional TTL.

Args:
Expand Down Expand Up @@ -85,7 +85,7 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
18 changes: 9 additions & 9 deletions key-value/key-value-aio/src/key_value/aio/stores/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from abc import ABC, abstractmethod
from asyncio.locks import Lock
from collections import defaultdict
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from types import TracebackType
from typing import Any, SupportsFloat

Expand Down Expand Up @@ -134,15 +134,15 @@ async def get(
if managed_entry.is_expired:
return None

return managed_entry.value
return dict(managed_entry.value)

@override
async def get_many(self, keys: list[str], *, collection: str | None = None) -> list[dict[str, Any] | None]:
collection = collection or self.default_collection
await self.setup_collection(collection=collection)

entries = await self._get_managed_entries(keys=keys, collection=collection)
return [entry.value if entry and not entry.is_expired else None for entry in entries]
return [dict(entry.value) if entry and not entry.is_expired else None for entry in entries]

@override
async def ttl(self, key: str, *, collection: str | None = None) -> tuple[dict[str, Any] | None, float | None]:
Expand All @@ -154,7 +154,7 @@ async def ttl(self, key: str, *, collection: str | None = None) -> tuple[dict[st
if not managed_entry or managed_entry.is_expired:
return (None, None)

return (managed_entry.value, managed_entry.ttl)
return (dict(managed_entry.value), managed_entry.ttl)

@override
async def ttl_many(
Expand All @@ -172,7 +172,7 @@ async def ttl_many(
await self.setup_collection(collection=collection)

entries = await self._get_managed_entries(keys=keys, collection=collection)
return [(entry.value, entry.ttl) if entry and not entry.is_expired else (None, None) for entry in entries]
return [(dict(entry.value), entry.ttl) if entry and not entry.is_expired else (None, None) for entry in entries]

@abstractmethod
async def _put_managed_entry(self, *, collection: str, key: str, managed_entry: ManagedEntry) -> None:
Expand All @@ -190,7 +190,7 @@ async def _put_managed_entries(self, *, collection: str, keys: list[str], manage
)

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
"""Store a key-value pair in the specified collection with optional TTL."""
collection = collection or self.default_collection
await self.setup_collection(collection=collection)
Expand All @@ -204,8 +204,8 @@ async def put(self, key: str, value: dict[str, Any], *, collection: str | None =
)

def _prepare_put_many(
self, *, keys: list[str], values: Sequence[dict[str, Any]], ttl: Sequence[SupportsFloat | None] | SupportsFloat | None
) -> tuple[list[str], Sequence[dict[str, Any]], list[float | None]]:
self, *, keys: list[str], values: Sequence[Mapping[str, Any]], ttl: Sequence[SupportsFloat | None] | SupportsFloat | None
) -> tuple[list[str], Sequence[Mapping[str, Any]], list[float | None]]:
"""Prepare multiple managed entries for a put_many operation.

Inheriting classes can use this method if they need to modify a put_many operation."""
Expand All @@ -226,7 +226,7 @@ def _prepare_put_many(
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/wrappers/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from typing_extensions import override
Expand Down Expand Up @@ -28,14 +28,14 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return await self.key_value.ttl_many(collection=collection, keys=keys)

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
return await self.key_value.put(collection=collection, key=key, value=value, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
10 changes: 5 additions & 5 deletions key-value/key-value-aio/src/key_value/aio/wrappers/compression/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import base64
import gzip
import json
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from key_value.shared.utils.managed_entry import ManagedEntry
Expand Down Expand Up @@ -131,18 +131,18 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return [(self._decompress_value(value), ttl) for value, ttl in results]

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
compressed_value = self._compress_value(value)
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
compressed_value = self._compress_value(dict(value))
return await self.key_value.put(key=key, value=compressed_value, collection=collection, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
) -> None:
compressed_values = [self._compress_value(value) for value in values]
compressed_values = [self._compress_value(dict(value)) for value in values]
return await self.key_value.put_many(keys=keys, values=compressed_values, collection=collection, ttl=ttl)
10 changes: 5 additions & 5 deletions key-value/key-value-aio/src/key_value/aio/wrappers/encryption/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import base64
import json
from collections.abc import Callable, Sequence
from collections.abc import Callable, Mapping, Sequence
from typing import Any, SupportsFloat

from key_value.shared.errors.key_value import SerializationError
Expand Down Expand Up @@ -158,18 +158,18 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return [(self._decrypt_value(value), ttl) for value, ttl in results]

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
encrypted_value = self._encrypt_value(value)
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
encrypted_value = self._encrypt_value(dict(value))
return await self.key_value.put(key=key, value=encrypted_value, collection=collection, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
) -> None:
encrypted_values = [self._encrypt_value(value) for value in values]
encrypted_values = [self._encrypt_value(dict(value)) for value in values]
return await self.key_value.put_many(keys=keys, values=encrypted_values, collection=collection, ttl=ttl)
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/wrappers/fallback/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from typing_extensions import override
Expand Down Expand Up @@ -71,7 +71,7 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return await self.fallback_key_value.ttl_many(keys=keys, collection=collection)

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
if self.write_to_fallback:
try:
return await self.primary_key_value.put(key=key, value=value, collection=collection, ttl=ttl)
Expand All @@ -84,7 +84,7 @@ async def put(self, key: str, value: dict[str, Any], *, collection: str | None =
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
12 changes: 6 additions & 6 deletions key-value/key-value-aio/src/key_value/aio/wrappers/limit_size/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from key_value.shared.errors.wrappers.limit_size import EntryTooLargeError, EntryTooSmallError
Expand Down Expand Up @@ -80,28 +80,28 @@ def _within_size_limit(self, value: dict[str, Any], *, collection: str | None =
return True

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
if self._within_size_limit(value=value, collection=collection, key=key):
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
if self._within_size_limit(value=dict(value), collection=collection, key=key):
await self.key_value.put(collection=collection, key=key, value=value, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
) -> None:
filtered_keys: list[str] = []
filtered_values: list[dict[str, Any]] = []
filtered_values: list[Mapping[str, Any]] = []
Copy link

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type annotation should remain list[dict[str, Any]] since the values are passed through unchanged to the underlying store. The Mapping type is only needed for the input parameter, not for internal storage.

Copilot uses AI. Check for mistakes.
filtered_ttls: list[SupportsFloat | None] | None = None

if isinstance(ttl, Sequence):
filtered_ttls = []

for i, (k, v) in enumerate(zip(keys, values, strict=True)):
if self._within_size_limit(value=v, collection=collection, key=k):
if self._within_size_limit(value=dict(v), collection=collection, key=k):
filtered_keys.append(k)
filtered_values.append(v)
if isinstance(ttl, Sequence):
Expand Down
10 changes: 5 additions & 5 deletions key-value/key-value-aio/src/key_value/aio/wrappers/logging/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import json
import logging
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, Literal, SupportsFloat

from typing_extensions import override
Expand Down Expand Up @@ -59,7 +59,7 @@ def _format_message(
action: str,
keys: list[str] | str,
collection: str | None,
values: dict[str, Any] | Sequence[dict[str, Any]] | None = None,
values: Mapping[str, Any] | Sequence[Mapping[str, Any]] | None = None,
extra: dict[str, Any] | None = None,
) -> str:
if self.structured_logs:
Expand Down Expand Up @@ -92,7 +92,7 @@ def _log(
action: str,
keys: list[str] | str,
collection: str | None,
values: dict[str, Any] | Sequence[dict[str, Any]] | None = None,
values: Mapping[str, Any] | Sequence[Mapping[str, Any]] | None = None,
extra: dict[str, Any] | None = None,
) -> None:
self.logger.log(
Expand Down Expand Up @@ -146,7 +146,7 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return results

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
self._log(state="start", action="PUT", keys=key, collection=collection, values=value, extra={"ttl": ttl})

await self.key_value.put(key=key, value=value, collection=collection, ttl=ttl)
Expand All @@ -157,7 +157,7 @@ async def put(self, key: str, value: dict[str, Any], *, collection: str | None =
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/wrappers/passthrough_cache/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from typing_extensions import override
Expand Down Expand Up @@ -155,7 +155,7 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return [key_to_value[key] for key in keys]

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
_ = await self.cache_key_value.delete(collection=collection, key=key)

await self.primary_key_value.put(collection=collection, key=key, value=value, ttl=ttl)
Expand All @@ -164,7 +164,7 @@ async def put(self, key: str, value: dict[str, Any], *, collection: str | None =
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/wrappers/prefix_collections/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from key_value.shared.utils.compound import prefix_collection, unprefix_collection
Expand Down Expand Up @@ -52,15 +52,15 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return await self.key_value.ttl_many(keys=keys, collection=new_collection)

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
new_collection: str = self._prefix_collection(collection=collection)
return await self.key_value.put(key=key, value=value, collection=new_collection, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
6 changes: 3 additions & 3 deletions key-value/key-value-aio/src/key_value/aio/wrappers/prefix_keys/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from collections.abc import Sequence
from collections.abc import Mapping, Sequence
from typing import Any, SupportsFloat

from key_value.shared.utils.compound import prefix_key, unprefix_key
Expand Down Expand Up @@ -49,15 +49,15 @@ async def ttl_many(self, keys: list[str], *, collection: str | None = None) -> l
return await self.key_value.ttl_many(keys=new_keys, collection=collection)

@override
async def put(self, key: str, value: dict[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
async def put(self, key: str, value: Mapping[str, Any], *, collection: str | None = None, ttl: SupportsFloat | None = None) -> None:
new_key: str = self._prefix_key(key=key)
return await self.key_value.put(key=new_key, value=value, collection=collection, ttl=ttl)

@override
async def put_many(
self,
keys: list[str],
values: Sequence[dict[str, Any]],
values: Sequence[Mapping[str, Any]],
*,
collection: str | None = None,
ttl: Sequence[SupportsFloat | None] | None = None,
Expand Down
Loading
Loading