add test cases for deprecation logic

Author: MaxDall

src/fundus/parser/base_parser.py

@@ -230,11 +230,11 @@ def _search_members(cls, obj_type: type) -> List[Tuple[str, Any]]:
         return members
 
     @classmethod
-    def attributes(cls) -> AttributeCollection:
+    def attributes(cls, include_all: bool = False) -> AttributeCollection:
         # We exclude both __ld and __meta here to hide them from the autogenerated tables. We do so, because
         # we neither want them to appear in the attribute_guidelines nor the supported_publishers tables.
         attrs: List[Attribute] = [
-            func for _, func in cls._search_members(Attribute) if func.__name__ not in ["__ld", "__meta"]
+            func for _, func in cls._search_members(Attribute) if include_all or func.__name__ not in ["__ld", "__meta"]
         ]
         return AttributeCollection(*attrs)
 
@@ -247,6 +247,10 @@ def functions(cls) -> FunctionCollection:
     def cache(self) -> Optional[Dict[str, Any]]:
         return self.precomputed.cache if self.precomputed else None
 
+    @property
+    def registered(self) -> List[RegisteredFunction]:
+        return self._sorted_registered_functions
+
     def _base_setup(self, html: str) -> None:
         doc = lxml.html.document_fromstring(html)
         self.precomputed = Precomputed(html, doc, get_meta_content(doc), get_ld_content(doc))

tests/fixtures/fixture_parser.py

@@ -1,4 +1,5 @@
-from datetime import datetime
+import datetime
+from typing import List
 
 import pytest
 
@@ -17,15 +18,15 @@ class EmptyParserProxy(ParserProxy):
 def parser_proxy_with_version():
     class ParserProxyWithVersion(ParserProxy):
         class Version(BaseParser):
-            VALID_UNTIL = datetime.now().date()
+            VALID_UNTIL = datetime.date.today()
 
     return ParserProxyWithVersion
 
 
 @pytest.fixture
 def parser_with_static_method():
     class ParserWithStaticMethod(BaseParser):
-        VALID_UNTIL = datetime.now().date()
+        VALID_UNTIL = datetime.date.today()
 
         @staticmethod
         def test():
@@ -37,7 +38,7 @@ def test():
 @pytest.fixture
 def parser_with_function_test():
     class ParserWithFunctionTest(BaseParser):
-        VALID_UNTIL = datetime.now().date()
+        VALID_UNTIL = datetime.date.today()
 
         @function
         def test(self):
@@ -49,7 +50,7 @@ def test(self):
 @pytest.fixture
 def parser_with_attr_title():
     class ParserWithAttrTitle(BaseParser):
-        VALID_UNTIL = datetime.now().date()
+        VALID_UNTIL = datetime.date.today()
 
         @attribute
         def title(self) -> str:
@@ -62,17 +63,36 @@ def title(self) -> str:
 def proxy_with_two_versions_and_different_attrs():
     class ProxyWithTwoVersionsAndDifferentAttrs(ParserProxy):
         class Later(BaseParser):
-            VALID_UNTIL = datetime(2023, 1, 2).date()
+            VALID_UNTIL = datetime.date(2023, 1, 2)
 
             @attribute
             def title(self) -> str:
                 return "This is a title"
 
         class Earlier(BaseParser):
-            VALID_UNTIL = datetime(2023, 1, 1).date()
+            VALID_UNTIL = datetime.date(2023, 1, 1)
 
             @attribute
             def another_title(self) -> str:
                 return "This is a another title"
 
     return ProxyWithTwoVersionsAndDifferentAttrs
+
+
+@pytest.fixture
+def proxy_with_two_deprecated_attributes():
+    class ProxyWithTwoDeprecatedAttributes(ParserProxy):
+        class ParserWithTwoDeprecatedAttributes(BaseParser):
+            @attribute
+            def title(self) -> str:
+                return "This is a title"
+
+            @attribute(deprecated=datetime.date(2024, 1, 1))
+            def topics(self) -> List[str]:
+                return ["This is a topic"]
+
+            @attribute(deprecated=datetime.date(2024, 4, 1))
+            def authors(self) -> List[str]:
+                return ["This is a author"]
+
+    return ProxyWithTwoDeprecatedAttributes

tests/test_parser.py

@@ -10,6 +10,7 @@
     AttributeCollection,
     BaseParser,
     ParserProxy,
+    RegisteredFunction,
     attribute,
 )
 from fundus.parser.utility import generic_author_parsing
@@ -174,6 +175,26 @@ def test_mapping(self, proxy_with_two_versions_and_different_attrs):
         attrs1, attrs2 = parser_proxy.attribute_mapping.values()
         assert attrs1.names != attrs2.names
 
+    def test_deprecated(self, proxy_with_two_deprecated_attributes):
+        def get_initialized_attrs(parser: BaseParser) -> List[RegisteredFunction]:
+            return parser._sorted_registered_functions
+
+        proxy: ParserProxy = proxy_with_two_deprecated_attributes()
+
+        number_of_attributes = len(proxy.latest_version.attributes(include_all=True))
+
+        parser1 = proxy(datetime.date(2023, 1, 1))
+        assert len(parser1.registered) == number_of_attributes
+
+        parser2 = proxy(datetime.date(2024, 3, 1))
+        assert len(parser2.registered) == number_of_attributes - 1
+
+        parser3 = proxy(datetime.date(2024, 4, 1))
+        assert len(parser3.registered) == number_of_attributes - 2
+
+        assert parser3 == proxy(datetime.date(2024, 5, 1))
+        assert parser3 != parser2 != parser1
+
 
 # enforce test coverage for test parsing
 # because this is also used for the generate_parser_test_files script we export it here