Skip to content

Commit 3909758

Browse files
committed
refactor: rename kv to kvs per convention
1 parent 155caf2 commit 3909758

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

src/apify/scrapy/extensions/httpcache.py

+18-18
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def __init__(self, settings: BaseSettings) -> None:
3838
self._expiration_max_items = 100
3939
self._expiration_secs: int = settings.getint('HTTPCACHE_EXPIRATION_SECS')
4040
self._spider: Spider | None = None
41-
self._kv: KeyValueStore | None = None
41+
self._kvs: KeyValueStore | None = None
4242
self._fingerprinter: RequestFingerprinterProtocol | None = None
4343
self._async_thread: AsyncThread | None = None
4444

@@ -47,19 +47,19 @@ def open_spider(self, spider: Spider) -> None:
4747
logger.debug('Using Apify key value cache storage', extra={'spider': spider})
4848
self._spider = spider
4949
self._fingerprinter = spider.crawler.request_fingerprinter
50-
kv_name = f'httpcache-{spider.name}'
50+
kvs_name = f'httpcache-{spider.name}'
5151

52-
async def open_kv() -> KeyValueStore:
52+
async def open_kvs() -> KeyValueStore:
5353
config = Configuration.get_global_configuration()
5454
if config.is_at_home:
5555
storage_client = ApifyStorageClient.from_config(config)
56-
return await KeyValueStore.open(name=kv_name, storage_client=storage_client)
57-
return await KeyValueStore.open(name=kv_name)
56+
return await KeyValueStore.open(name=kvs_name, storage_client=storage_client)
57+
return await KeyValueStore.open(name=kvs_name)
5858

5959
logger.debug("Starting background thread for cache storage's event loop")
6060
self._async_thread = AsyncThread()
61-
logger.debug(f"Opening cache storage's {kv_name!r} key value store")
62-
self._kv = self._async_thread.run_coro(open_kv())
61+
logger.debug(f"Opening cache storage's {kvs_name!r} key value store")
62+
self._kvs = self._async_thread.run_coro(open_kvs())
6363

6464
def close_spider(self, _: Spider, current_time: int | None = None) -> None:
6565
"""Close the cache storage for a spider."""
@@ -71,28 +71,28 @@ def close_spider(self, _: Spider, current_time: int | None = None) -> None:
7171
if current_time is None:
7272
current_time = int(time())
7373

74-
async def expire_kv() -> None:
75-
if self._kv is None:
74+
async def expire_kvs() -> None:
75+
if self._kvs is None:
7676
raise ValueError('Key value store not initialized')
7777
i = 0
78-
async for item in self._kv.iterate_keys():
79-
value = await self._kv.get_value(item.key)
78+
async for item in self._kvs.iterate_keys():
79+
value = await self._kvs.get_value(item.key)
8080
try:
8181
gzip_time = read_gzip_time(value)
8282
except Exception as e:
8383
logger.warning(f'Malformed cache item {item.key}: {e}')
84-
await self._kv.set_value(item.key, None)
84+
await self._kvs.set_value(item.key, None)
8585
else:
8686
if self._expiration_secs < current_time - gzip_time:
8787
logger.debug(f'Expired cache item {item.key}')
88-
await self._kv.set_value(item.key, None)
88+
await self._kvs.set_value(item.key, None)
8989
else:
9090
logger.debug(f'Valid cache item {item.key}')
9191
if i == self._expiration_max_items:
9292
break
9393
i += 1
9494

95-
self._async_thread.run_coro(expire_kv())
95+
self._async_thread.run_coro(expire_kvs())
9696

9797
logger.debug('Closing cache storage')
9898
try:
@@ -108,13 +108,13 @@ def retrieve_response(self, _: Spider, request: Request, current_time: int | Non
108108
"""Retrieve a response from the cache storage."""
109109
if self._async_thread is None:
110110
raise ValueError('Async thread not initialized')
111-
if self._kv is None:
111+
if self._kvs is None:
112112
raise ValueError('Key value store not initialized')
113113
if self._fingerprinter is None:
114114
raise ValueError('Request fingerprinter not initialized')
115115

116116
key = self._fingerprinter.fingerprint(request).hex()
117-
value = self._async_thread.run_coro(self._kv.get_value(key))
117+
value = self._async_thread.run_coro(self._kvs.get_value(key))
118118

119119
if value is None:
120120
logger.debug('Cache miss', extra={'request': request})
@@ -140,7 +140,7 @@ def store_response(self, _: Spider, request: Request, response: Response) -> Non
140140
"""Store a response in the cache storage."""
141141
if self._async_thread is None:
142142
raise ValueError('Async thread not initialized')
143-
if self._kv is None:
143+
if self._kvs is None:
144144
raise ValueError('Key value store not initialized')
145145
if self._fingerprinter is None:
146146
raise ValueError('Request fingerprinter not initialized')
@@ -153,7 +153,7 @@ def store_response(self, _: Spider, request: Request, response: Response) -> Non
153153
'body': response.body,
154154
}
155155
value = to_gzip(data)
156-
self._async_thread.run_coro(self._kv.set_value(key, value))
156+
self._async_thread.run_coro(self._kvs.set_value(key, value))
157157

158158

159159
def to_gzip(data: dict, mtime: int | None = None) -> bytes:

0 commit comments

Comments
 (0)