fix: pydantic extra keywords deprecated (#753)

Pydantic deprecates using extra keyword arguments on Field.
Used json_schema_extra instead.

Deprecated in Pydantic V2.0 to be removed in V3.0.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

src/akkudoktoreos/server/dash/configuration.py

@@ -77,6 +77,65 @@ def get_nested_value(
         return default
 
 
+def get_field_extra_dict(
+    subfield_info: Union[FieldInfo, ComputedFieldInfo],
+) -> Dict[str, Any]:
+    """Extract json_schema_extra.
+
+    Extract regardless of whether it is defined directly
+    on the field (Pydantic v2) or inherited from v1 compatibility wrappers.
+    Always returns a dictionary.
+    """
+    # Pydantic v2 location
+    extra = getattr(subfield_info, "json_schema_extra", None)
+    if isinstance(extra, dict):
+        return extra
+
+    # Pydantic v1 compatibility fallbacks
+    fi = getattr(subfield_info, "field_info", None)
+    if fi is not None:
+        extra = getattr(fi, "json_schema_extra", None)
+        if isinstance(extra, dict):
+            return extra
+
+    return {}
+
+
+def get_description(
+    subfield_info: Union[FieldInfo, ComputedFieldInfo],
+    extra: Dict[str, Any],
+) -> str:
+    """Fetch description.
+
+    Priority:
+    1) json_schema_extra["description"]
+    2) field_info.description
+    3) empty string
+    """
+    if "description" in extra:
+        return str(extra["description"])
+
+    desc = getattr(subfield_info, "description", None)
+    return str(desc) if desc is not None else ""
+
+
+def get_deprecated(
+    subfield_info: Union[FieldInfo, ComputedFieldInfo],
+    extra: Dict[str, Any],
+) -> Optional[Any]:
+    """Fetch deprecated.
+
+    Priority:
+    1) json_schema_extra["deprecated"]
+    2) field_info.deprecated
+    3) None
+    """
+    if "deprecated" in extra:
+        return extra["deprecated"]
+
+    return getattr(subfield_info, "deprecated", None)
+
+
 def get_default_value(field_info: Union[FieldInfo, ComputedFieldInfo], regular_field: bool) -> Any:
     """Retrieve the default value of a field.
 
@@ -163,6 +222,7 @@ def configuration(
                 ):
                     if found_basic:
                         continue
+                    extra = get_field_extra_dict(subfield_info)
 
                     config: dict[str, Optional[Any]] = {}
                     config["name"] = ".".join(values_prefix + parent_types)
@@ -170,12 +230,8 @@ def configuration(
                         get_nested_value(values, values_prefix + parent_types, "<unknown>")
                     )
                     config["default"] = json.dumps(get_default_value(subfield_info, regular_field))
-                    config["description"] = (
-                        subfield_info.description if subfield_info.description else ""
-                    )
-                    config["deprecated"] = (
-                        subfield_info.deprecated if subfield_info.deprecated else None
-                    )
+                    config["description"] = get_description(subfield_info, extra)
+                    config["deprecated"] = get_deprecated(subfield_info, extra)
                     if isinstance(subfield_info, ComputedFieldInfo):
                         config["read-only"] = "ro"
                         type_description = str(subfield_info.return_type)

src/akkudoktoreos/server/server.py

@@ -153,31 +153,42 @@ class ServerCommonSettings(SettingsBaseModel):
 
     host: Optional[str] = Field(
         default=get_default_host(),
-        description="EOS server IP address. Defaults to 127.0.0.1.",
-        examples=["127.0.0.1", "localhost"],
+        json_schema_extra={
+            "description": "EOS server IP address. Defaults to 127.0.0.1.",
+            "examples": ["127.0.0.1", "localhost"],
+        },
     )
     port: Optional[int] = Field(
         default=8503,
-        description="EOS server IP port number. Defaults to 8503.",
-        examples=[
-            8503,
-        ],
+        json_schema_extra={
+            "description": "EOS server IP port number. Defaults to 8503.",
+            "examples": [
+                8503,
+            ],
+        },
+    )
+    verbose: Optional[bool] = Field(
+        default=False, json_schema_extra={"description": "Enable debug output"}
     )
-    verbose: Optional[bool] = Field(default=False, description="Enable debug output")
     startup_eosdash: Optional[bool] = Field(
-        default=True, description="EOS server to start EOSdash server. Defaults to True."
+        default=True,
+        json_schema_extra={"description": "EOS server to start EOSdash server. Defaults to True."},
     )
     eosdash_host: Optional[str] = Field(
         default=None,
-        description="EOSdash server IP address. Defaults to EOS server IP address.",
-        examples=["127.0.0.1", "localhost"],
+        json_schema_extra={
+            "description": "EOSdash server IP address. Defaults to EOS server IP address.",
+            "examples": ["127.0.0.1", "localhost"],
+        },
     )
     eosdash_port: Optional[int] = Field(
         default=None,
-        description="EOSdash server IP port number. Defaults to EOS server IP port number + 1.",
-        examples=[
-            8504,
-        ],
+        json_schema_extra={
+            "description": "EOSdash server IP port number. Defaults to EOS server IP port number + 1.",
+            "examples": [
+                8504,
+            ],
+        },
     )
 
     @field_validator("host", "eosdash_host", mode="before")