Cleanup: use a type for associated products rather than Dict[str, object]

Author: i80and

snooty/parser.py

@@ -73,7 +73,13 @@
 from .page import Page, PendingTask
 from .postprocess import Postprocessor, PostprocessorResult
 from .target_database import ProjectInterface, TargetDatabase
-from .types import BuildIdentifierSet, ParsedBannerConfig, ProjectConfig, StaticAsset
+from .types import (
+    AssociatedProduct,
+    BuildIdentifierSet,
+    ParsedBannerConfig,
+    ProjectConfig,
+    StaticAsset,
+)
 from .util import RST_EXTENSIONS
 
 NO_CHILDREN = (n.SubstitutionReference,)
@@ -1078,16 +1084,15 @@ def __make_child_visitor(self) -> "JSONVisitor":
 
 def validate_toc_entries(
     node_entries: List[TocTreeDirectiveEntry],
-    associated_products: List[Dict[str, object]],
+    associated_products: List[AssociatedProduct],
     line: int,
 ) -> List[Diagnostic]:
     """
     validates that external toc node exists as one of the associated products
     if not found, removes this node and emits a warning
-    associated_products come in form of {name: str, versions: List[str]}
     """
     diagnostics: List[Diagnostic] = []
-    associated_product_names = [product["name"] for product in associated_products]
+    associated_product_names = [product.name for product in associated_products]
     for toc_entry in node_entries:
         if (
             toc_entry.ref_project

snooty/postprocess.py

@@ -1581,7 +1581,9 @@ def generate_metadata(cls, context: Context) -> n.SerializedNode:
         if project_config.deprecated_versions:
             document["deprecated_versions"] = project_config.deprecated_versions
         if project_config.associated_products:
-            document["associated_products"] = project_config.associated_products
+            document["associated_products"] = [
+                product.serialize() for product in project_config.associated_products
+            ]
         # Update metadata document with key-value pairs defined in event parser
         document["slugToTitle"] = {
             k: [node.serialize() for node in v]

snooty/test_types.py

@@ -35,8 +35,8 @@ def test_project() -> None:
     project_config, project_diganostics = ProjectConfig.open(path)
     assert len(project_diganostics) == 0
     assert len(project_config.associated_products) > 0
-    assert project_config.associated_products[0]["name"] == "test-name"
-    assert project_config.associated_products[0]["versions"] == ["v1.0", "v1.2"]
+    assert project_config.associated_products[0].name == "test-name"
+    assert project_config.associated_products[0].versions == ["v1.0", "v1.2"]
     assert project_config.name == "test_data"
 
 

snooty/types.py

@@ -18,7 +18,7 @@
     UnmarshallingError,
 )
 from .flutter import LoadError, check_type, checked
-from .n import FileId
+from .n import FileId, SerializableType
 
 FileSource = Union[Path, str]
 PAT_VARIABLE = re.compile(r"{\+([\w-]+)\+}")
@@ -123,6 +123,16 @@ class BundleConfig:
     manpages: Optional[str] = field(default=None)
 
 
+@checked
+@dataclass
+class AssociatedProduct:
+    name: str
+    versions: List[str]
+
+    def serialize(self) -> SerializableType:
+        return {"name": self.name, "versions": self.versions}
+
+
 @checked
 @dataclass
 class ProjectConfig:
@@ -148,7 +158,7 @@ class ProjectConfig:
     manpages: Dict[str, ManPageConfig] = field(default_factory=dict)
     bundle: BundleConfig = field(default_factory=BundleConfig)
     data: Dict[str, object] = field(default_factory=dict)
-    associated_products: List[Dict[str, object]] = field(default_factory=list)
+    associated_products: List[AssociatedProduct] = field(default_factory=list)
 
     @property
     def source_path(self) -> Path: