Keyring fixes

Author: strawgate

key-value/key-value-aio/src/key_value/aio/stores/keyring/store.py

@@ -1,5 +1,7 @@
 """Python keyring-based key-value store."""
 
+import os
+
 from key_value.shared.errors.key_value import ValueTooLargeError
 from key_value.shared.utils.compound import compound_key
 from key_value.shared.utils.managed_entry import ManagedEntry
@@ -18,6 +20,14 @@
 
 DEFAULT_KEYCHAIN_SERVICE = "py-key-value"
 
+
+def is_value_too_large(value: bytes) -> bool:
+    value_length = len(value)
+    if os.name == "nt":
+        return value_length > WINDOWS_MAX_VALUE_LENGTH
+    return False
+
+
 WINDOWS_MAX_VALUE_LENGTH = 2560  # bytes
 
 MAX_KEY_COLLECTION_LENGTH = 256
@@ -111,7 +121,7 @@ async def _put_managed_entry(self, *, key: str, collection: str, managed_entry:
         json_str: str = self._serialization_adapter.dump_json(entry=managed_entry, key=key, collection=collection)
         encoded_json_bytes: bytes = json_str.encode(encoding="utf-8")
 
-        if len(encoded_json_bytes) > WINDOWS_MAX_VALUE_LENGTH:
+        if is_value_too_large(value=encoded_json_bytes):
             raise ValueTooLargeError(size=len(encoded_json_bytes), max_size=2560, collection=sanitized_collection, key=sanitized_key)
 
         keyring.set_password(service_name=self._service_name, username=combo_key, password=json_str)

key-value/key-value-aio/tests/stores/keyring/test_keyring.py

@@ -34,6 +34,7 @@ async def test_get_large_put_get(self, store: BaseStore, data: dict[str, Any], j
 
 
 @pytest.mark.skipif(condition=not detect_on_macos(), reason="Keyrings do not support large values on MacOS")
+@pytest.mark.filterwarnings("ignore:A configured store is unstable and may change in a backwards incompatible way. Use at your own risk.")
 class TestMacOSKeychainStore(BaseTestKeychainStore):
     pass
 

key-value/key-value-sync/src/key_value/sync/code_gen/stores/keyring/store.py

@@ -3,6 +3,8 @@
 # DO NOT CHANGE! Change the original file instead.
 """Python keyring-based key-value store."""
 
+import os
+
 from key_value.shared.errors.key_value import ValueTooLargeError
 from key_value.shared.utils.compound import compound_key
 from key_value.shared.utils.managed_entry import ManagedEntry
@@ -21,6 +23,14 @@
 
 DEFAULT_KEYCHAIN_SERVICE = "py-key-value"
 
+
+def is_value_too_large(value: bytes) -> bool:
+    value_length = len(value)
+    if os.name == "nt":
+        return value_length > WINDOWS_MAX_VALUE_LENGTH
+    return False
+
+
 WINDOWS_MAX_VALUE_LENGTH = 2560  # bytes
 
 MAX_KEY_COLLECTION_LENGTH = 256
@@ -110,7 +120,7 @@ def _put_managed_entry(self, *, key: str, collection: str, managed_entry: Manage
         json_str: str = self._serialization_adapter.dump_json(entry=managed_entry, key=key, collection=collection)
         encoded_json_bytes: bytes = json_str.encode(encoding="utf-8")
 
-        if len(encoded_json_bytes) > WINDOWS_MAX_VALUE_LENGTH:
+        if is_value_too_large(value=encoded_json_bytes):
             raise ValueTooLargeError(size=len(encoded_json_bytes), max_size=2560, collection=sanitized_collection, key=sanitized_key)
 
         keyring.set_password(service_name=self._service_name, username=combo_key, password=json_str)

key-value/key-value-sync/tests/code_gen/stores/keyring/test_keyring.py

@@ -41,6 +41,7 @@ def test_get_large_put_get(self, store: BaseStore, data: dict[str, Any], json: s
 
 
 @pytest.mark.skipif(condition=not detect_on_macos(), reason="Keyrings do not support large values on MacOS")
+@pytest.mark.filterwarnings("ignore:A configured store is unstable and may change in a backwards incompatible way. Use at your own risk.")
 class TestMacOSKeychainStore(BaseTestKeychainStore):
     pass