lint: fix

Author: kostahuffman

aiocache/serializers/serializers.py

@@ -1,6 +1,5 @@
 import logging
 import pickle  # noqa: S403
-import yaml
 from abc import ABC, abstractmethod
 from typing import Any, Optional
 
@@ -18,6 +17,12 @@
     msgpack = None
     logger.debug("msgpack not installed, MsgPackSerializer unavailable")
 
+try:
+    import yaml  # noqa: I900
+except ImportError:
+    yaml = None
+    logger.debug("yaml not installed, YamlSerializer unavailable")
+
 
 _NOT_SET = object()
 
@@ -202,17 +207,14 @@ def loads(self, value):
 
 class YamlSerializer(BaseSerializer):
     """
-    Transform data to YAML string with ``yaml.dump`` and ``yaml.load`` to retrieve it back.
+    Transform data to YAML string with ``yaml.dump`` and ``yaml.load`` to retrieve it back. You need
+    to have ``yaml`` installed in order to be able to use this serializer.
     """
 
-    def __init__(self, *args, loader=yaml.SafeLoader, **kwargs):
-        """
-        Initialize the YamlSerializer with the specified loader.
-
-        :param loader: The YAML loader to use for deserialization. Default is yaml.SafeLoader.
-        """
+    def __init__(self, *args, **kwargs):
+        if not yaml:
+            raise RuntimeError("yaml not installed, YamlSerializer unavailable")
         super().__init__(*args, **kwargs)
-        self.loader = loader
 
     def dumps(self, value):
         """
@@ -232,4 +234,4 @@ def loads(self, value):
         """
         if value is None:
             return None
-        return yaml.load(value, Loader=self.loader)
+        return yaml.safe_load(value)

requirements.txt

@@ -9,3 +9,4 @@ pytest-asyncio==0.25.3
 pytest-cov==6.0.0
 pytest-mock==3.14.0
 redis==5.2.1
+pyyaml==6.0.2

tests/ut/test_serializers.py

@@ -1,5 +1,4 @@
 import pickle
-import yaml
 from collections import namedtuple
 from unittest import mock
 
@@ -20,6 +19,7 @@
 
 TYPES = [1, 2.0, "hi", True, ["1", 1], {"key": "value"}, Dummy(1, 2)]
 JSON_TYPES = [1, 2.0, "hi", True, ["1", 1], {"key": "value"}]
+YAML_TYPES = [1, 2.0, "hi", True, ["1", 1], {"key": "value"}]
 
 
 class TestNullSerializer:
@@ -183,13 +183,14 @@ def test_init(self):
         assert isinstance(serializer, BaseSerializer)
         assert serializer.DEFAULT_ENCODING == "utf-8"
         assert serializer.encoding == "utf-8"
-        assert serializer.loader == yaml.SafeLoader
 
-    def test_init_with_custom_loader(self):
-        serializer = YamlSerializer(loader=yaml.FullLoader)
-        assert serializer.loader == yaml.FullLoader
+    def test_init_fails_if_yaml_not_installed(self):
+        with mock.patch("aiocache.serializers.serializers.yaml", None):
+            with pytest.raises(RuntimeError):
+                YamlSerializer()
+            assert JsonSerializer(), "Other serializers should still initialize"
 
-    @pytest.mark.parametrize("obj", TYPES)
+    @pytest.mark.parametrize("obj", YAML_TYPES)
     def test_set_types(self, obj):
         serializer = YamlSerializer()
         assert serializer.loads(serializer.dumps(obj)) == obj