Address PR Feedback

Author: strawgate

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

@@ -138,8 +138,8 @@ class ElasticsearchStore(
 
     Stores collections in their own indices and stores values in Flattened fields.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
     To avoid issues, you may want to consider leveraging the `ElasticsearchV1KeySanitizationStrategy` and
     `ElasticsearchV1CollectionSanitizationStrategy` strategies.

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

@@ -1,6 +1,5 @@
 """Python keyring-based key-value store."""
 
-
 from key_value.shared.utils.compound import compound_key
 from key_value.shared.utils.managed_entry import ManagedEntry
 from key_value.shared.utils.sanitization import HybridSanitizationStrategy, PassthroughStrategy, SanitizationStrategy
@@ -22,7 +21,16 @@
 ALLOWED_KEY_COLLECTION_CHARACTERS: str = ALPHANUMERIC_CHARACTERS
 
 
-class KeyringV1SanitizationStrategy(HybridSanitizationStrategy):
+class KeyringV1KeySanitizationStrategy(HybridSanitizationStrategy):
+    def __init__(self) -> None:
+        super().__init__(
+            replacement_character="_",
+            max_length=MAX_KEY_COLLECTION_LENGTH,
+            allowed_characters=ALLOWED_KEY_COLLECTION_CHARACTERS,
+        )
+
+
+class KeyringV1CollectionSanitizationStrategy(HybridSanitizationStrategy):
     def __init__(self) -> None:
         super().__init__(
             replacement_character="_",
@@ -34,13 +42,14 @@ def __init__(self) -> None:
 class KeyringStore(BaseStore):
     """Python keyring-based key-value store using keyring library.
 
-    This store uses the Python keyring to persist key-value pairs. Each entry is stored
+    This store uses the system's keyring to persist key-value pairs. Each entry is stored
     as a password in the keychain with the combination of collection and key as the username.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
-    To avoid issues, you may want to consider leveraging the `KeyringV1SanitizationStrategy` strategy.
+    To avoid issues, you may want to consider leveraging the `KeyringV1KeySanitizationStrategy`
+    and `KeyringV1CollectionSanitizationStrategy` strategies.
 
     Note: TTL is not natively supported by Python keyring, so TTL information is stored
     within the JSON payload and checked at retrieval time.

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

@@ -5,7 +5,7 @@
 from bson.errors import InvalidDocument
 from key_value.shared.errors import DeserializationError, SerializationError
 from key_value.shared.utils.managed_entry import ManagedEntry
-from key_value.shared.utils.sanitization import HybridSanitizationStrategy, PassthroughStrategy, SanitizationStrategy
+from key_value.shared.utils.sanitization import HybridSanitizationStrategy, SanitizationStrategy
 from key_value.shared.utils.sanitize import ALPHANUMERIC_CHARACTERS
 from key_value.shared.utils.serialization import SerializationAdapter
 from typing_extensions import Self, override
@@ -200,7 +200,7 @@ def __init__(
 
         super().__init__(
             default_collection=default_collection,
-            collection_sanitization_strategy=collection_sanitization_strategy or PassthroughStrategy(),
+            collection_sanitization_strategy=collection_sanitization_strategy,
         )
 
     @override

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

@@ -39,8 +39,8 @@ class WindowsRegistryStore(BaseStore):
     This store uses the Windows Registry to persist key-value pairs. Each entry is stored
     as a string value in the registry under HKEY_CURRENT_USER\\Software\\{root}\\{collection}\\{key}.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
     To avoid issues, you may want to consider leveraging the `WindowsRegistryV1SanitizationStrategy` strategy.
 

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

@@ -117,8 +117,8 @@ class ElasticsearchStore(
 
     Stores collections in their own indices and stores values in Flattened fields.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
     To avoid issues, you may want to consider leveraging the `ElasticsearchV1KeySanitizationStrategy` and
     `ElasticsearchV1CollectionSanitizationStrategy` strategies.

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

@@ -24,7 +24,14 @@
 ALLOWED_KEY_COLLECTION_CHARACTERS: str = ALPHANUMERIC_CHARACTERS
 
 
-class KeyringV1SanitizationStrategy(HybridSanitizationStrategy):
+class KeyringV1KeySanitizationStrategy(HybridSanitizationStrategy):
+    def __init__(self) -> None:
+        super().__init__(
+            replacement_character="_", max_length=MAX_KEY_COLLECTION_LENGTH, allowed_characters=ALLOWED_KEY_COLLECTION_CHARACTERS
+        )
+
+
+class KeyringV1CollectionSanitizationStrategy(HybridSanitizationStrategy):
     def __init__(self) -> None:
         super().__init__(
             replacement_character="_", max_length=MAX_KEY_COLLECTION_LENGTH, allowed_characters=ALLOWED_KEY_COLLECTION_CHARACTERS
@@ -34,13 +41,14 @@ def __init__(self) -> None:
 class KeyringStore(BaseStore):
     """Python keyring-based key-value store using keyring library.
 
-    This store uses the Python keyring to persist key-value pairs. Each entry is stored
+    This store uses the system's keyring to persist key-value pairs. Each entry is stored
     as a password in the keychain with the combination of collection and key as the username.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
-    To avoid issues, you may want to consider leveraging the `KeyringV1SanitizationStrategy` strategy.
+    To avoid issues, you may want to consider leveraging the `KeyringV1KeySanitizationStrategy`
+    and `KeyringV1CollectionSanitizationStrategy` strategies.
 
     Note: TTL is not natively supported by Python keyring, so TTL information is stored
     within the JSON payload and checked at retrieval time.

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

@@ -8,7 +8,7 @@
 from bson.errors import InvalidDocument
 from key_value.shared.errors import DeserializationError, SerializationError
 from key_value.shared.utils.managed_entry import ManagedEntry
-from key_value.shared.utils.sanitization import HybridSanitizationStrategy, PassthroughStrategy, SanitizationStrategy
+from key_value.shared.utils.sanitization import HybridSanitizationStrategy, SanitizationStrategy
 from key_value.shared.utils.sanitize import ALPHANUMERIC_CHARACTERS
 from key_value.shared.utils.serialization import SerializationAdapter
 from typing_extensions import Self, override
@@ -196,10 +196,7 @@ def __init__(
         self._collections_by_name = {}
         self._adapter = MongoDBSerializationAdapter(native_storage=native_storage)
 
-        super().__init__(
-            default_collection=default_collection,
-            collection_sanitization_strategy=collection_sanitization_strategy or PassthroughStrategy(),
-        )
+        super().__init__(default_collection=default_collection, collection_sanitization_strategy=collection_sanitization_strategy)
 
     @override
     def __enter__(self) -> Self:

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

@@ -45,8 +45,8 @@ class WindowsRegistryStore(BaseStore):
     This store uses the Windows Registry to persist key-value pairs. Each entry is stored
     as a string value in the registry under HKEY_CURRENT_USER\\Software\\{root}\\{collection}\\{key}.
 
-    By default, keys and collections are not sanitized. This means that there are character and length restrictions on
-    keys and collections that may cause errors when trying to get and put entries.
+    This store has specific restrictions on what is allowed in keys and collections. Keys and collections are not sanitized
+    by default which may result in errors when using the store.
 
     To avoid issues, you may want to consider leveraging the `WindowsRegistryV1SanitizationStrategy` strategy.