From cbed79f2f50a2b9631f207d95477465a27237a78 Mon Sep 17 00:00:00 2001 From: AN Long Date: Sat, 14 Mar 2026 19:52:21 +0900 Subject: [PATCH] =?UTF-8?q?=E2=9A=97=EF=B8=8F=20Update=20parameter=20names?= =?UTF-8?q?=20in=20the=20meta=20client?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++--- memcache/async_memcache.py | 2 +- memcache/experiment/async_meta_client.py | 30 ++++++++++++------------ memcache/experiment/meta_client.py | 30 ++++++++++++------------ memcache/memcache.py | 2 +- tests/test_async_meta_client.py | 28 +++++++++++----------- tests/test_meta_client.py | 28 +++++++++++----------- 7 files changed, 63 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 32ddb02..69daa03 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,9 @@ client = MetaClient(("localhost", 11211)) # get returns a GetResult with rich metadata result = client.get( "key", - return_cas=True, - return_ttl=True, - return_hit_before=True, + with_cas=True, + with_ttl=True, + with_hit_before=True, ) if result is not None: print(result.value) diff --git a/memcache/async_memcache.py b/memcache/async_memcache.py index b16e1ae..e66cae1 100644 --- a/memcache/async_memcache.py +++ b/memcache/async_memcache.py @@ -88,7 +88,7 @@ async def gets(self, key: Union[bytes, str]) -> Optional[Tuple[Any, int]]: :param key: The key to retrieve :return: A tuple of (value, cas_token) or None if key doesn't exist """ - r = await self._meta.get(key, return_cas=True) + r = await self._meta.get(key, with_cas=True) if r is None: return None if r.cas_token is None: diff --git a/memcache/experiment/async_meta_client.py b/memcache/experiment/async_meta_client.py index 8d2e074..88c612f 100644 --- a/memcache/experiment/async_meta_client.py +++ b/memcache/experiment/async_meta_client.py @@ -91,11 +91,11 @@ async def get( self, key: Union[str, bytes], *, - return_cas: bool = False, - return_ttl: bool = False, - return_last_access: bool = False, - return_size: bool = False, - return_hit_before: bool = False, + with_cas: bool = False, + with_ttl: bool = False, + with_last_access: bool = False, + with_size: bool = False, + with_hit_before: bool = False, update_ttl: Optional[int] = None, no_lru_bump: bool = False, vivify_on_miss_ttl: Optional[int] = None, @@ -104,15 +104,15 @@ async def get( ) -> Optional[GetResult[Any]]: key_bytes = self._to_bytes(key) flags: List[bytes] = [b"v", b"f"] - if return_cas: + if with_cas: flags.append(b"c") - if return_ttl: + if with_ttl: flags.append(b"t") - if return_last_access: + if with_last_access: flags.append(b"l") - if return_size: + if with_size: flags.append(b"s") - if return_hit_before: + if with_hit_before: flags.append(b"h") if update_ttl is not None: flags.append(b"T%d" % update_ttl) @@ -138,15 +138,15 @@ async def get( gr.is_stale = parsed.get("is_stale", False) gr.won_recache = parsed.get("won_recache", False) gr.already_won = parsed.get("already_won", False) - if return_cas: + if with_cas: gr.cas_token = parsed.get("cas_token") - if return_ttl: + if with_ttl: gr.ttl = parsed.get("ttl") - if return_last_access: + if with_last_access: gr.last_access = parsed.get("last_access") - if return_size: + if with_size: gr.size = parsed.get("size") - if return_hit_before: + if with_hit_before: gr.hit_before = parsed.get("hit_before") if "key" in parsed: gr.key = parsed["key"] diff --git a/memcache/experiment/meta_client.py b/memcache/experiment/meta_client.py index a5ae2c6..a671dd0 100644 --- a/memcache/experiment/meta_client.py +++ b/memcache/experiment/meta_client.py @@ -116,11 +116,11 @@ def get( self, key: Union[str, bytes], *, - return_cas: bool = False, - return_ttl: bool = False, - return_last_access: bool = False, - return_size: bool = False, - return_hit_before: bool = False, + with_cas: bool = False, + with_ttl: bool = False, + with_last_access: bool = False, + with_size: bool = False, + with_hit_before: bool = False, update_ttl: Optional[int] = None, no_lru_bump: bool = False, vivify_on_miss_ttl: Optional[int] = None, @@ -129,15 +129,15 @@ def get( ) -> Optional[GetResult[Any]]: key_bytes = self._to_bytes(key) flags: List[bytes] = [b"v", b"f"] - if return_cas: + if with_cas: flags.append(b"c") - if return_ttl: + if with_ttl: flags.append(b"t") - if return_last_access: + if with_last_access: flags.append(b"l") - if return_size: + if with_size: flags.append(b"s") - if return_hit_before: + if with_hit_before: flags.append(b"h") if update_ttl is not None: flags.append(b"T%d" % update_ttl) @@ -163,15 +163,15 @@ def get( gr.is_stale = parsed.get("is_stale", False) gr.won_recache = parsed.get("won_recache", False) gr.already_won = parsed.get("already_won", False) - if return_cas: + if with_cas: gr.cas_token = parsed.get("cas_token") - if return_ttl: + if with_ttl: gr.ttl = parsed.get("ttl") - if return_last_access: + if with_last_access: gr.last_access = parsed.get("last_access") - if return_size: + if with_size: gr.size = parsed.get("size") - if return_hit_before: + if with_hit_before: gr.hit_before = parsed.get("hit_before") if "key" in parsed: gr.key = parsed["key"] diff --git a/memcache/memcache.py b/memcache/memcache.py index 3867df5..7daf453 100644 --- a/memcache/memcache.py +++ b/memcache/memcache.py @@ -85,7 +85,7 @@ def gets(self, key: Union[bytes, str]) -> Optional[Tuple[Any, int]]: :param key: The key to retrieve :return: A tuple of (value, cas_token) or None if key doesn't exist """ - r = self._meta.get(key, return_cas=True) + r = self._meta.get(key, with_cas=True) if r is None: return None if r.cas_token is None: diff --git a/tests/test_async_meta_client.py b/tests/test_async_meta_client.py index 420ced7..8336bf8 100644 --- a/tests/test_async_meta_client.py +++ b/tests/test_async_meta_client.py @@ -71,18 +71,18 @@ async def test_get_update_ttl(client: AsyncMetaClient) -> None: @pytest.mark.asyncio -async def test_get_return_cas(client: AsyncMetaClient) -> None: +async def test_get_with_cas(client: AsyncMetaClient) -> None: await client.set("gr_cas", "v") - r = await client.get("gr_cas", return_cas=True) + r = await client.get("gr_cas", with_cas=True) assert r is not None assert isinstance(r.cas_token, int) assert r.cas_token > 0 @pytest.mark.asyncio -async def test_get_return_ttl(client: AsyncMetaClient) -> None: +async def test_get_with_ttl(client: AsyncMetaClient) -> None: await client.set("gr_ttl", "v", expire=3600) - r = await client.get("gr_ttl", return_ttl=True) + r = await client.get("gr_ttl", with_ttl=True) assert r is not None assert r.ttl is not None assert r.ttl > 0 @@ -97,28 +97,28 @@ async def test_get_no_ttl_requested(client: AsyncMetaClient) -> None: @pytest.mark.asyncio -async def test_get_return_size(client: AsyncMetaClient) -> None: +async def test_get_with_size(client: AsyncMetaClient) -> None: await client.set("gr_size", b"hello") - r = await client.get("gr_size", return_size=True) + r = await client.get("gr_size", with_size=True) assert r is not None assert r.size == 5 @pytest.mark.asyncio -async def test_get_return_hit_before(client: AsyncMetaClient) -> None: +async def test_get_with_hit_before(client: AsyncMetaClient) -> None: await client.set("gr_hit", "v") - r1 = await client.get("gr_hit", return_hit_before=True) + r1 = await client.get("gr_hit", with_hit_before=True) assert r1 is not None assert r1.hit_before is False - r2 = await client.get("gr_hit", return_hit_before=True) + r2 = await client.get("gr_hit", with_hit_before=True) assert r2 is not None assert r2.hit_before is True @pytest.mark.asyncio -async def test_get_return_last_access(client: AsyncMetaClient) -> None: +async def test_get_with_last_access(client: AsyncMetaClient) -> None: await client.set("gr_la", "v") - r = await client.get("gr_la", return_last_access=True) + r = await client.get("gr_la", with_last_access=True) assert r is not None assert r.last_access is not None assert isinstance(r.last_access, int) @@ -257,7 +257,7 @@ async def test_prepend_vivify(client: AsyncMetaClient) -> None: @pytest.mark.asyncio async def test_cas_success(client: AsyncMetaClient) -> None: await client.set("cas_key", "initial") - r = await client.get("cas_key", return_cas=True) + r = await client.get("cas_key", with_cas=True) assert r is not None assert r.cas_token is not None assert await client.cas("cas_key", "updated", r.cas_token) is True @@ -269,7 +269,7 @@ async def test_cas_success(client: AsyncMetaClient) -> None: @pytest.mark.asyncio async def test_cas_conflict(client: AsyncMetaClient) -> None: await client.set("cas_conf", "v") - r = await client.get("cas_conf", return_cas=True) + r = await client.get("cas_conf", with_cas=True) assert r is not None assert r.cas_token is not None await client.set("cas_conf", "modified") @@ -304,7 +304,7 @@ async def test_delete_missing(client: AsyncMetaClient) -> None: @pytest.mark.asyncio async def test_delete_with_cas(client: AsyncMetaClient) -> None: await client.set("del_cas", "v") - r = await client.get("del_cas", return_cas=True) + r = await client.get("del_cas", with_cas=True) assert r is not None assert r.cas_token is not None assert await client.delete("del_cas", cas_token=r.cas_token) is True diff --git a/tests/test_meta_client.py b/tests/test_meta_client.py index 6ad701d..a267bb3 100644 --- a/tests/test_meta_client.py +++ b/tests/test_meta_client.py @@ -89,17 +89,17 @@ def test_get_update_ttl(client: MetaClient) -> None: assert r.value == "v" -def test_get_return_cas(client: MetaClient) -> None: +def test_get_with_cas(client: MetaClient) -> None: client.set("gr_cas", "v") - r = client.get("gr_cas", return_cas=True) + r = client.get("gr_cas", with_cas=True) assert r is not None assert isinstance(r.cas_token, int) assert r.cas_token > 0 -def test_get_return_ttl(client: MetaClient) -> None: +def test_get_with_ttl(client: MetaClient) -> None: client.set("gr_ttl", "v", expire=3600) - r = client.get("gr_ttl", return_ttl=True) + r = client.get("gr_ttl", with_ttl=True) assert r is not None assert r.ttl is not None assert r.ttl > 0 @@ -112,28 +112,28 @@ def test_get_no_ttl_requested(client: MetaClient) -> None: assert r.ttl is None -def test_get_return_size(client: MetaClient) -> None: +def test_get_with_size(client: MetaClient) -> None: client.set("gr_size", b"hello") - r = client.get("gr_size", return_size=True) + r = client.get("gr_size", with_size=True) assert r is not None assert r.size == 5 -def test_get_return_hit_before(client: MetaClient) -> None: +def test_get_with_hit_before(client: MetaClient) -> None: client.set("gr_hit", "v") # First get: not hit before - r1 = client.get("gr_hit", return_hit_before=True) + r1 = client.get("gr_hit", with_hit_before=True) assert r1 is not None assert r1.hit_before is False # Second get: hit before - r2 = client.get("gr_hit", return_hit_before=True) + r2 = client.get("gr_hit", with_hit_before=True) assert r2 is not None assert r2.hit_before is True -def test_get_return_last_access(client: MetaClient) -> None: +def test_get_with_last_access(client: MetaClient) -> None: client.set("gr_la", "v") - r = client.get("gr_la", return_last_access=True) + r = client.get("gr_la", with_last_access=True) assert r is not None assert r.last_access is not None assert isinstance(r.last_access, int) @@ -257,7 +257,7 @@ def test_prepend_vivify(client: MetaClient) -> None: def test_cas_success(client: MetaClient) -> None: client.set("cas_key", "initial") - r = client.get("cas_key", return_cas=True) + r = client.get("cas_key", with_cas=True) assert r is not None assert r.cas_token is not None assert client.cas("cas_key", "updated", r.cas_token) is True @@ -268,7 +268,7 @@ def test_cas_success(client: MetaClient) -> None: def test_cas_conflict(client: MetaClient) -> None: client.set("cas_conf", "v") - r = client.get("cas_conf", return_cas=True) + r = client.get("cas_conf", with_cas=True) assert r is not None assert r.cas_token is not None client.set("cas_conf", "modified") @@ -299,7 +299,7 @@ def test_delete_missing(client: MetaClient) -> None: def test_delete_with_cas(client: MetaClient) -> None: client.set("del_cas", "v") - r = client.get("del_cas", return_cas=True) + r = client.get("del_cas", with_cas=True) assert r is not None assert r.cas_token is not None assert client.delete("del_cas", cas_token=r.cas_token) is True