Enforce extra=forbid in pydantic models

Author: NMertsch

discord_guild_config.schema.json

@@ -1,6 +1,7 @@
 {
   "$defs": {
     "Category": {
+      "additionalProperties": false,
       "properties": {
         "name": {
           "title": "Name",
@@ -47,6 +48,7 @@
       "type": "object"
     },
     "ForumChannel": {
+      "additionalProperties": false,
       "properties": {
         "type": {
           "const": "forum",
@@ -90,6 +92,7 @@
       "type": "object"
     },
     "PermissionOverwrite": {
+      "additionalProperties": false,
       "properties": {
         "roles": {
           "items": {
@@ -236,6 +239,7 @@
       "type": "object"
     },
     "Role": {
+      "additionalProperties": false,
       "properties": {
         "name": {
           "title": "Name",
@@ -330,6 +334,7 @@
       "type": "object"
     },
     "TextChannel": {
+      "additionalProperties": false,
       "properties": {
         "type": {
           "const": "text",
@@ -368,6 +373,7 @@
       "type": "object"
     },
     "VoiceChannel": {
+      "additionalProperties": false,
       "properties": {
         "type": {
           "const": "voice",
@@ -394,6 +400,7 @@
       "type": "object"
     }
   },
+  "additionalProperties": false,
   "properties": {
     "roles": {
       "items": {

pyproject.toml

@@ -77,3 +77,6 @@ fixable = [
 
 [tool.ruff.lint.pydocstyle]
 convention = "pep257"
+
+[tool.ruff.lint.flake8-tidy-imports.banned-api]
+"pydantic.BaseModel" = { msg = "Use the custom StrictBaseModel instead" }

src/discord_guild_configurator/_utils.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel, ConfigDict  # noqa: TID251 (plain BaseModel)
+
+
+class StrictBaseModel(BaseModel):
+    model_config = ConfigDict(extra="forbid")

src/discord_guild_configurator/models.py

@@ -4,7 +4,9 @@
 import textwrap
 from typing import Annotated, Literal, Self
 
-from pydantic import AfterValidator, BaseModel, Field, model_validator
+from pydantic import AfterValidator, Field, model_validator
+
+from discord_guild_configurator._utils import StrictBaseModel
 
 MultilineString = Annotated[
     str,
@@ -71,13 +73,13 @@
 ]
 
 
-class PermissionOverwrite(BaseModel):
+class PermissionOverwrite(StrictBaseModel):
     roles: list[str]
     allow: list[Permission] = Field(default_factory=list)
     deny: list[Permission] = Field(default_factory=list)
 
 
-class ForumChannel(BaseModel):
+class ForumChannel(StrictBaseModel):
     type: Literal["forum"] = "forum"
 
     name: str
@@ -88,7 +90,7 @@ class ForumChannel(BaseModel):
     require_tag: bool = False
 
 
-class TextChannel(BaseModel):
+class TextChannel(StrictBaseModel):
     type: Literal["text"] = "text"
 
     name: str
@@ -98,30 +100,30 @@ class TextChannel(BaseModel):
     channel_messages: list[MultilineString] = Field(default_factory=list)
 
 
-class VoiceChannel(BaseModel):
+class VoiceChannel(StrictBaseModel):
     type: Literal["voice"] = "voice"
 
     name: str
     permission_overwrites: list[PermissionOverwrite] = Field(default_factory=list)
 
 
-class Category(BaseModel):
+class Category(StrictBaseModel):
     name: str
     channels: list[
         Annotated[TextChannel | ForumChannel | VoiceChannel, Field(discriminator="type")]
     ]
     permission_overwrites: list[PermissionOverwrite] = Field(default_factory=list)
 
 
-class Role(BaseModel):
+class Role(StrictBaseModel):
     name: str
     color: str = Field(pattern=re.compile("^#[0-9A-F]{6}$"))
     hoist: bool = False
     mentionable: bool = False
     permissions: list[Permission] = Field(default_factory=list)
 
 
-class GuildConfig(BaseModel):
+class GuildConfig(StrictBaseModel):
     roles: list[Role]
     rules_channel_name: str
     system_channel_name: str