Skip to content

Commit c7017d3

Browse files
committed
fixed some type hints
1 parent 8336b54 commit c7017d3

File tree

6 files changed

+81
-64
lines changed

6 files changed

+81
-64
lines changed

django_valkey/async_cache/client/default.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import builtins
2-
from collections.abc import Iterable, AsyncIterable
2+
from collections.abc import Iterable, AsyncIterator
33
import contextlib
44
from contextlib import suppress
55
from typing import Any, cast, TYPE_CHECKING
@@ -454,7 +454,7 @@ async def amget(
454454
map_keys = {await self.make_key(k, version=version): k for k in keys}
455455

456456
try:
457-
results = await client.mget(*map_keys)
457+
results: list[bytes] = await client.mget(*map_keys)
458458
except _main_exceptions as e:
459459
raise ConnectionInterrupted(connection=client) from e
460460

@@ -698,7 +698,7 @@ async def aiter_keys(
698698
itersize: int | None = None,
699699
client: AValkey | Any | None = None,
700700
version: int | None = None,
701-
) -> AsyncIterable[KeyT]:
701+
) -> AsyncIterator[KeyT]:
702702
"""
703703
Same as keys, but uses cursors
704704
for make memory efficient keys iteration.
@@ -974,7 +974,7 @@ async def asrandmember(
974974
version: int | None = None,
975975
client: AValkey | Any | None = None,
976976
return_set: bool = True,
977-
) -> list | Any:
977+
) -> builtins.set | list | Any:
978978
client = await self._get_client(write=False, client=client)
979979
key = await self.make_key(key, version=version)
980980
result = await client.srandmember(key, count)
@@ -1034,7 +1034,7 @@ async def asscan_iter(
10341034
count: int = 10,
10351035
version: int | None = None,
10361036
client: AValkey | Any | None = None,
1037-
) -> AsyncIterable[Any]:
1037+
) -> AsyncIterator[Any]:
10381038
if self._has_compression_enabled() and match:
10391039
error_message = "Using match with compression is not supported."
10401040
raise ValueError(error_message)
@@ -1251,7 +1251,7 @@ async def ahmget(
12511251
keys: list,
12521252
version: int | None = None,
12531253
client: AValkey | Any | None = None,
1254-
) -> list:
1254+
) -> list[Any]:
12551255
client = await self._get_client(write=False, client=client)
12561256
nkeys = [await self.make_key(key, version=version) for key in keys]
12571257
try:

django_valkey/base.py

Lines changed: 43 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1+
import builtins
2+
from collections.abc import Iterator, AsyncIterator, Callable
13
import contextlib
24
import functools
35
import logging
46
from asyncio import iscoroutinefunction
5-
from typing import Any, TypeVar, Generic, Iterator, AsyncGenerator, Set, Callable
7+
from typing import Any, TypeVar, Generic, TYPE_CHECKING
68

79
from django.conf import settings
810
from django.core.cache.backends.base import BaseCache
911
from django.utils.module_loading import import_string
1012

1113
from django_valkey.exceptions import ConnectionInterrupted
14+
from django_valkey.typing import KeyT
15+
16+
if TYPE_CHECKING:
17+
from valkey.lock import Lock
18+
from valkey.asyncio.lock import Lock as ALock
1219

1320
Client = TypeVar("Client")
1421
Backend = TypeVar("Backend")
@@ -91,19 +98,19 @@ def client(self) -> Client:
9198
return self._client
9299

93100
@omit_exception
94-
def mset(self, *args, **kwargs):
101+
def mset(self, *args, **kwargs) -> bool:
95102
return self.client.mset(*args, **kwargs)
96103

97104
@omit_exception
98-
async def amset(self, *args, **kwargs):
105+
async def amset(self, *args, **kwargs) -> bool:
99106
return await self.client.amset(*args, **kwargs)
100107

101108
@omit_exception
102-
def mget(self, *args, **kwargs):
109+
def mget(self, *args, **kwargs) -> dict | list[Any]:
103110
return self.client.mget(*args, **kwargs)
104111

105112
@omit_exception
106-
async def amget(self, *args, **kwargs):
113+
async def amget(self, *args, **kwargs) -> dict | list[Any]:
107114
return await self.client.amget(*args, **kwargs)
108115

109116
@omit_exception
@@ -147,13 +154,13 @@ async def apexpire_at(self, *args, **kwargs) -> bool:
147154
return await self.client.apexpire_at(*args, **kwargs)
148155

149156
@omit_exception
150-
def get_lock(self, *args, **kwargs):
157+
def get_lock(self, *args, **kwargs) -> "Lock":
151158
return self.client.get_lock(*args, **kwargs)
152159

153160
lock = get_lock
154161

155162
@omit_exception
156-
async def aget_lock(self, *args, **kwargs):
163+
async def aget_lock(self, *args, **kwargs) -> "ALock":
157164
return await self.client.aget_lock(*args, **kwargs)
158165

159166
alock = aget_lock
@@ -169,7 +176,7 @@ async def adelete_pattern(self, *args, **kwargs) -> int:
169176
return await self.client.adelete_pattern(*args, **kwargs)
170177

171178
@omit_exception
172-
def ttl(self, *args, **kwargs) -> int | None:
179+
def ttl(self, *args, **kwargs) -> int:
173180
return self.client.ttl(*args, **kwargs)
174181

175182
@omit_exception
@@ -185,29 +192,29 @@ async def apttl(self, *args, **kwargs) -> int:
185192
return await self.client.apttl(*args, **kwargs)
186193

187194
@omit_exception
188-
def iter_keys(self, *args, **kwargs) -> Iterator:
195+
def iter_keys(self, *args, **kwargs) -> Iterator[KeyT]:
189196
return self.client.iter_keys(*args, **kwargs)
190197

191198
@omit_exception
192-
async def aiter_keys(self, *args, **kwargs) -> AsyncGenerator:
199+
async def aiter_keys(self, *args, **kwargs) -> AsyncIterator[KeyT]:
193200
async with contextlib.aclosing(self.client.aiter_keys(*args, **kwargs)) as it:
194201
async for key in it:
195202
yield key
196203

197204
@omit_exception
198-
def keys(self, *args, **kwargs) -> list[Any]:
205+
def keys(self, *args, **kwargs) -> list:
199206
return self.client.keys(*args, **kwargs)
200207

201208
@omit_exception
202-
async def akeys(self, *args, **kwargs) -> list[Any]:
209+
async def akeys(self, *args, **kwargs) -> list:
203210
return await self.client.akeys(*args, **kwargs)
204211

205212
@omit_exception
206-
def scan(self, *args, **kwargs) -> tuple[int, list[str]]:
213+
def scan(self, *args, **kwargs) -> tuple[int, list[Any]]:
207214
return self.client.scan(*args, **kwargs)
208215

209216
@omit_exception
210-
async def ascan(self, *args, **kwargs) -> tuple[int, list[str]]:
217+
async def ascan(self, *args, **kwargs) -> tuple[int, list[Any]]:
211218
return await self.client.ascan(*args, **kwargs)
212219

213220
@omit_exception
@@ -227,11 +234,11 @@ async def ascard(self, *args, **kwargs) -> int:
227234
return await self.client.ascard(*args, **kwargs)
228235

229236
@omit_exception
230-
def sdiff(self, *args, **kwargs) -> Set[Any]:
237+
def sdiff(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
231238
return self.client.sdiff(*args, **kwargs)
232239

233240
@omit_exception
234-
async def asdiff(self, *args, **kwargs) -> Set[Any]:
241+
async def asdiff(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
235242
return await self.client.asdiff(*args, **kwargs)
236243

237244
@omit_exception
@@ -243,11 +250,11 @@ async def asdiffstore(self, *args, **kwargs) -> int:
243250
return await self.client.asdiffstore(*args, **kwargs)
244251

245252
@omit_exception
246-
def sinter(self, *args, **kwargs) -> Set[Any]:
253+
def sinter(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
247254
return self.client.sinter(*args, **kwargs)
248255

249256
@omit_exception
250-
async def asinter(self, *args, **kwargs) -> Set[Any]:
257+
async def asinter(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
251258
return await self.client.asinter(*args, **kwargs)
252259

253260
@omit_exception
@@ -283,11 +290,11 @@ async def asismember(self, *args, **kwargs) -> bool:
283290
return await self.client.asismember(*args, **kwargs)
284291

285292
@omit_exception
286-
def smembers(self, *args, **kwargs) -> Set[Any]:
293+
def smembers(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
287294
return self.client.smembers(*args, **kwargs)
288295

289296
@omit_exception
290-
async def asmembers(self, *args, **kwargs) -> Set[Any]:
297+
async def asmembers(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
291298
return await self.client.asmembers(*args, **kwargs)
292299

293300
@omit_exception
@@ -299,19 +306,19 @@ async def asmove(self, *args, **kwargs) -> bool:
299306
return await self.client.asmove(*args, **kwargs)
300307

301308
@omit_exception
302-
def spop(self, *args, **kwargs) -> Set | Any:
309+
def spop(self, *args, **kwargs) -> builtins.set | list | Any:
303310
return self.client.spop(*args, **kwargs)
304311

305312
@omit_exception
306-
async def aspop(self, *args, **kwargs) -> Set | Any:
313+
async def aspop(self, *args, **kwargs) -> builtins.set | list | Any:
307314
return await self.client.aspop(*args, **kwargs)
308315

309316
@omit_exception
310-
def srandmember(self, *args, **kwargs) -> list | Any:
317+
def srandmember(self, *args, **kwargs) -> builtins.set | list | Any:
311318
return self.client.srandmember(*args, **kwargs)
312319

313320
@omit_exception
314-
async def asrandmember(self, *args, **kwargs) -> list | Any:
321+
async def asrandmember(self, *args, **kwargs) -> builtins.set | list | Any:
315322
return await self.client.asrandmember(*args, **kwargs)
316323

317324
@omit_exception
@@ -323,29 +330,31 @@ async def asrem(self, *args, **kwargs) -> int:
323330
return await self.client.asrem(*args, **kwargs)
324331

325332
@omit_exception
326-
def sscan(self, *args, **kwargs) -> Set[Any]:
333+
def sscan(self, *args, **kwargs) -> tuple[int, builtins.set[Any] | list[Any]]:
327334
return self.client.sscan(*args, **kwargs)
328335

329336
@omit_exception
330-
async def asscan(self, *args, **kwargs) -> Set[Any]:
337+
async def asscan(
338+
self, *args, **kwargs
339+
) -> tuple[int, builtins.set[Any] | list[Any]]:
331340
return await self.client.asscan(*args, **kwargs)
332341

333342
@omit_exception
334-
def sscan_iter(self, *args, **kwargs) -> Iterator:
343+
def sscan_iter(self, *args, **kwargs) -> Iterator[Any]:
335344
return self.client.sscan_iter(*args, **kwargs)
336345

337346
@omit_exception
338-
async def asscan_iter(self, *args, **kwargs) -> AsyncGenerator:
347+
async def asscan_iter(self, *args, **kwargs) -> AsyncIterator[Any]:
339348
async with contextlib.aclosing(self.client.asscan_iter(*args, **kwargs)) as it:
340349
async for key in it:
341350
yield key
342351

343352
@omit_exception
344-
def sunion(self, *args, **kwargs) -> Set[Any]:
353+
def sunion(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
345354
return self.client.sunion(*args, **kwargs)
346355

347356
@omit_exception
348-
async def asunion(self, *args, **kwargs) -> Set[Any]:
357+
async def asunion(self, *args, **kwargs) -> builtins.set[Any] | list[Any]:
349358
return await self.client.asunion(*args, **kwargs)
350359

351360
@omit_exception
@@ -389,19 +398,19 @@ async def ahdel_many(self, *args, **kwargs) -> int:
389398
return await self.client.ahdel_many(*args, **kwargs)
390399

391400
@omit_exception
392-
def hget(self, *args, **kwargs) -> bytes | None:
401+
def hget(self, *args, **kwargs) -> Any | None:
393402
return self.client.hget(*args, **kwargs)
394403

395404
@omit_exception
396-
async def ahget(self, *args, **kwargs) -> str | None:
405+
async def ahget(self, *args, **kwargs) -> Any | None:
397406
return await self.client.ahget(*args, **kwargs)
398407

399408
@omit_exception
400-
def hgetall(self, *args, **kwargs) -> dict:
409+
def hgetall(self, *args, **kwargs) -> dict[str, Any]:
401410
return self.client.hgetall(*args, **kwargs)
402411

403412
@omit_exception
404-
async def ahgetall(self, *args, **kwargs) -> dict:
413+
async def ahgetall(self, *args, **kwargs) -> dict[str, Any]:
405414
return await self.client.ahgetall(*args, **kwargs)
406415

407416
@omit_exception

django_valkey/base_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ def mget(
584584
map_keys = {self.make_key(k, version=version): k for k in keys}
585585

586586
try:
587-
results = client.mget(map_keys)
587+
results: list[bytes] = client.mget(map_keys)
588588
except _main_exceptions as e:
589589
raise ConnectionInterrupted(connection=client) from e
590590

@@ -1073,7 +1073,7 @@ def srandmember(
10731073
version: int | None = None,
10741074
client: Backend | Any | None = None,
10751075
return_set: bool = True,
1076-
) -> list | Any:
1076+
) -> builtins.set | list | Any:
10771077
client = self._get_client(write=False, client=client)
10781078

10791079
key = self.make_key(key, version=version)
@@ -1102,7 +1102,7 @@ def sscan(
11021102
version: int | None = None,
11031103
client: Backend | Any | None = None,
11041104
return_set: bool = True,
1105-
) -> tuple[int, builtins.set[Any]] | tuple[int, list[Any]]:
1105+
) -> tuple[int, builtins.set[Any] | list[Any]]:
11061106
if self._has_compression_enabled() and match:
11071107
err_msg = "Using match with compression is not supported."
11081108
raise ValueError(err_msg)
@@ -1275,7 +1275,7 @@ def hdel_many(
12751275
client: Backend | Any | None = None,
12761276
) -> int:
12771277
client = self._get_client(write=True, client=client)
1278-
nkeys = [self.make_key(key) for key in keys]
1278+
nkeys = [self.make_key(key, version=version) for key in keys]
12791279
return client.hdel(name, *nkeys)
12801280

12811281
def hget(
@@ -1315,7 +1315,7 @@ def hmget(
13151315
keys: list,
13161316
version: int | None = None,
13171317
client: Backend | Any | None = None,
1318-
) -> list:
1318+
) -> list[Any]:
13191319
client = self._get_client(write=False, client=client)
13201320
nkeys = [self.make_key(key, version=version) for key in keys]
13211321
try:
@@ -1373,7 +1373,7 @@ def hkeys(
13731373
self,
13741374
name: str,
13751375
client: Backend | Any | None = None,
1376-
) -> list[Any]:
1376+
) -> list[str]:
13771377
"""
13781378
Return a list of keys in hash name.
13791379
"""

0 commit comments

Comments
 (0)