Use default= kwarg for models (PEP 681 compliance) (#93)

* Use `default=` kwarg for models

* Update fragments

* Move inline AST change to fragment

* Add note regarding Field AST node

Author: pederhan

codegen/ast/fragments/main/generalinfo.py

@@ -7,6 +7,6 @@
 
 class GeneralInfo(BaseModel):
     with_chartmuseum: Optional[bool] = Field(
-        None,
+        default=None,
         description="DEPRECATED: Harbor instance is deployed with nested chartmuseum.",
     )

codegen/ast/fragments/main/projectmetadata.py

@@ -12,7 +12,7 @@
 
 class ProjectMetadata(BaseModel):
     retention_id: Optional[Union[str, int]] = Field(
-        None, description="The ID of the tag retention policy for the project"
+        default=None, description="The ID of the tag retention policy for the project"
     )
 
     @field_validator("*", mode="before")

codegen/ast/fragments/main/registryproviders.py

@@ -10,6 +10,6 @@
 
 class RegistryProviders(RootModel):
     root: Dict[str, RegistryProviderInfo] = Field(
-        {},
+        default={},
         description="The registry providers. Each key is the name of the registry provider.",
     )

codegen/ast/fragments/main/replicationfilter.py

@@ -9,5 +9,5 @@
 
 class ReplicationFilter(BaseModel):
     value: Union[str, Dict[str, Any], None] = Field(
-        None, description="The value of replication policy filter."
+        default=None, description="The value of replication policy filter."
     )

codegen/ast/fragments/main/vulnerabilitysummary.py

@@ -10,23 +10,27 @@
 class VulnerabilitySummary(BaseModel):
     # Summary dict keys added as fields
     critical: int = Field(
-        0,
+        default=0,
         alias="Critical",
         description="The number of critical vulnerabilities detected.",
     )
     high: int = Field(
-        0, alias="High", description="The number of critical vulnerabilities detected."
+        default=0,
+        alias="High",
+        description="The number of critical vulnerabilities detected.",
     )
     medium: int = Field(
-        0,
+        default=0,
         alias="Medium",
         description="The number of critical vulnerabilities detected.",
     )
     low: int = Field(
-        0, alias="Low", description="The number of critical vulnerabilities detected."
+        default=0,
+        alias="Low",
+        description="The number of critical vulnerabilities detected.",
     )
     unknown: int = Field(
-        0,
+        default=0,
         alias="Unknown",
         description="The number of critical vulnerabilities detected.",
     )

codegen/ast/fragments/scanner/vulnerabilityitem.py

@@ -18,6 +18,9 @@ class VulnerabilityItem(BaseModel):
         None,
         description="The list of links to the upstream databases with the full description of the vulnerability.\n",
     )
+    severity: Severity = Field(
+        Severity.unknown, description="The severity of the vulnerability."
+    )
 
     @field_validator("severity", mode="before")
     @classmethod

codegen/ast/parser.py

@@ -118,6 +118,7 @@ def modify(self, classdef: ast.ClassDef) -> ast.ClassDef:
 Unset = object()  # Sentinel value so we can pass None as a default
 
 
+# NOTE: Unused right now. Field additions should be added using fragments.
 class Field(Modifier):
     def __init__(
         self,
@@ -184,20 +185,7 @@ def construct_field(self) -> ast.AnnAssign:
 # Changes to existing definitions (change annotation, etc.) or additions
 # that are too minor to create new fragments for.
 models: dict[str, dict[str, list[Modifier]]] = {
-    FragmentDir.scanner: {
-        "VulnerabilityItem": [
-            Field(
-                "severity",
-                "Severity",
-                default=ast.Attribute(
-                    value=ast.Name(id="Severity", ctx=ast.Load()),
-                    attr="unknown",
-                    ctx=ast.Load(),
-                ),
-                description="The severity of the vulnerability.",
-            ),
-        ],
-    },
+    FragmentDir.scanner: {},
     FragmentDir.main: {
         "ExtraAttrs": [
             Annotation(