Merge pull request #200 from machow/feat-pydantic-no-extra

feat: do not accept extra fields in pydantic

Author: machow

quartodoc/layout.py

@@ -4,7 +4,7 @@
 import logging
 
 from enum import Enum
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, Extra
 
 from typing_extensions import Annotated
 from typing import Literal, Union, Optional
@@ -16,6 +16,9 @@
 class _Base(BaseModel):
     """Any data class that might appear in the quartodoc config."""
 
+    class Config:
+        extra = Extra.forbid
+
 
 class _Structural(_Base):
     """A structural element, like an index Section or Page of docs."""
@@ -245,6 +248,7 @@ class Link(_Docable):
 
     class Config:
         arbitrary_types_allowed = True
+        extra = Extra.forbid
 
 
 class Doc(_Docable):
@@ -275,6 +279,7 @@ class Doc(_Docable):
 
     class Config:
         arbitrary_types_allowed = True
+        extra = Extra.forbid
 
     @classmethod
     def from_griffe(
@@ -374,6 +379,7 @@ class Item(BaseModel):
 
     class Config:
         arbitrary_types_allowed = True
+        extra = Extra.forbid
 
 
 # Update forwared refs --------------------------------------------------------

quartodoc/tests/test_layout.py

@@ -1,5 +1,6 @@
 import pytest
 
+from pydantic import ValidationError
 from quartodoc.layout import Layout, Page, Text, Section  # noqa
 
 
@@ -27,3 +28,10 @@ def test_layout_from_config(cfg, res):
 
     layout = Layout(sections=[cfg])
     assert layout.sections[0] == res
+
+
+def test_layout_extra_forbidden():
+    with pytest.raises(ValidationError) as exc_info:
+        Section(title="abc", desc="xyz", contents=[], zzzzz=1)
+
+    assert "extra fields not permitted" in str(exc_info.value)