Merge pull request #22 from heliocastro/feat/evaluation_result

feat(evaluator): Implement evaluator-result parsing

Author: heliocastro

examples/ort_result.py

@@ -6,11 +6,10 @@
 from pathlib import Path
 
 import click
-import yaml
 from pydantic import ValidationError
 from rich.pretty import pprint
 
-from ort import OrtResult
+from ort import OrtResult, ort_yaml_load
 
 logger = logging.getLogger()
 
@@ -26,7 +25,7 @@ def main(
 ) -> None:
     try:
         with Path(datafile).open() as fd:
-            data = yaml.safe_load(fd)
+            data = ort_yaml_load(fd)
         parsed = OrtResult(**data)
         if analyzer:
             pprint(parsed.analyzer)

examples/repo_config.py

@@ -6,11 +6,10 @@
 from pathlib import Path
 
 import click
-import yaml
 from pydantic import ValidationError
 from rich.pretty import pprint
 
-from ort import RepositoryConfiguration
+from ort import RepositoryConfiguration, ort_yaml_load
 
 logger = logging.getLogger()
 
@@ -20,7 +19,7 @@
 def main(datafile: str) -> None:
     try:
         with Path(datafile).open() as fd:
-            data = yaml.safe_load(fd)
+            data = ort_yaml_load(fd)
         parsed = RepositoryConfiguration(**data)
         pprint(parsed)
     except ValidationError as e:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "python-ort"
-version = "0.6.6"
+version = "0.7.0"
 description = "A Python Ort model serialization library"
 readme = "README.md"
 license = "MIT"
@@ -35,11 +35,11 @@ module-root = "src"
 
 [dependency-groups]
 dev = [
-    "datamodel-code-generator[http]>=0.54.0",
+    "datamodel-code-generator[http]>=0.55.0",
     "pytest>=9.0.2",
     "rich>=14.3.3",
-    "ruff>=0.15.4",
-    "ty>=0.0.20",
+    "ruff>=0.15.5",
+    "ty>=0.0.21",
     "types-pyyaml>=6.0.12.20250915",
 ]
 

src/ort/__init__.py

@@ -5,9 +5,12 @@
 from .models.analyzer_result import AnalyzerResult
 from .models.config.repository_configuration import RepositoryConfiguration
 from .models.ort_result import OrtResult
+from .utils.yaml_loader import OrtYamlLoader, ort_yaml_load
 
 __all__ = [
     "AnalyzerResult",
+    "OrtYamlLoader",
     "RepositoryConfiguration",
     "OrtResult",
+    "ort_yaml_load",
 ]

src/ort/models/advisor_capability.py

@@ -2,10 +2,10 @@
 # SPDX-License-Identifier: MIT
 
 
-from enum import IntEnum
+from ort.utils.validated_enum import ValidatedIntEnum
 
 
-class AdvisorCapability(IntEnum):
+class AdvisorCapability(ValidatedIntEnum):
     """
     An enum class that defines the capabilities of a specific advisor implementation.
 

src/ort/models/advisor_details.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field
 
 from ort.models import AdvisorCapability
 
@@ -22,20 +22,3 @@ class AdvisorDetails(BaseModel):
         description="The capabilities of the used advisor. This property indicates, which kind of findings"
         "are retrieved by the advisor."
     )
-
-    @field_validator("capabilities", mode="before")
-    @classmethod
-    def convert_capability(cls, v):
-        def _convert(item):
-            if isinstance(item, str):
-                try:
-                    return AdvisorCapability[item]
-                except KeyError:
-                    raise ValueError(f"Invalid capability: {item}")
-            return item
-
-        if isinstance(v, (list, set)):
-            return {_convert(item) for item in v}
-        if isinstance(v, str):
-            return _convert(v)
-        return v

src/ort/models/advisor_run.py

@@ -1,35 +1,21 @@
 # SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <heliocastro@gmail.com>
 # SPDX-License-Identifier: MIT
 
-from datetime import datetime
 
-from pydantic import BaseModel, ConfigDict, Field
-
-from ort.models import AdvisorResult
-from ort.models.config.advisor_configuration import AdvisorConfiguration
-from ort.utils.environment import Environment
+from pydantic import Field
 
+from .advisor_result import AdvisorResult
+from .base_run import BaseRun
+from .config.advisor_configuration import AdvisorConfiguration
 from .identifier import Identifier
 
 
-class AdvisorRun(BaseModel):
+class AdvisorRun(BaseRun):
     """
     Type alias for a function that allows filtering of [AdvisorResult]s.
 
     """
 
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    start_time: datetime = Field(
-        description="The time the advisor was started.",
-    )
-    end_time: datetime = Field(
-        description="The time the advisor has finished.",
-    )
-    environment: Environment = Field(
-        description="The [Environment] in which the advisor was executed.",
-    )
     config: AdvisorConfiguration = Field(
         description="The [AdvisorConfiguration] used for this run.",
     )

src/ort/models/analyzer_run.py

@@ -1,33 +1,20 @@
 # SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
 # SPDX-License-Identifier: MIT
 
-from datetime import datetime
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import Field
 
-from ort.models import AnalyzerResult
-from ort.models.config.analyzer_configuration import AnalyzerConfiguration
-from ort.utils.environment import Environment
+from .analyzer_result import AnalyzerResult
+from .base_run import BaseRun
+from .config.analyzer_configuration import AnalyzerConfiguration
 
 
-class AnalyzerRun(BaseModel):
+class AnalyzerRun(BaseRun):
     """
     The summary of a single run of the analyzer.
 
     """
 
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    start_time: datetime = Field(
-        description="The time the analyzer was started.",
-    )
-    end_time: datetime = Field(
-        description="The time the analyzer has finished.",
-    )
-    environment: Environment = Field(
-        description="The [Environment] in which the analyzer was executed.",
-    )
     config: AnalyzerConfiguration = Field(
         description="The [AnalyzerConfiguration] used for this run.",
     )

src/ort/models/base_run.py

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
+# SPDX-License-Identifier: MIT
+
+from datetime import datetime
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from ort.utils.environment import Environment
+
+
+class BaseRun(BaseModel):
+    """
+    The summary of a single run of the analyzer.
+
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    start_time: datetime = Field(
+        description="The time the analyzer was started.",
+    )
+    end_time: datetime = Field(
+        description="The time the analyzer has finished.",
+    )
+    environment: Environment = Field(
+        description="The [Environment] in which the analyzer was executed.",
+    )

src/ort/models/config/issue_resolution.py

@@ -2,9 +2,7 @@
 # SPDX-License-Identifier: MIT
 
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
-
-from ort.utils import convert_enum
+from pydantic import BaseModel, ConfigDict, Field
 
 from .issue_resolution_reason import IssueResolutionReason
 
@@ -32,8 +30,3 @@ class IssueResolution(BaseModel):
     comment: str = Field(
         description="A comment to further explain why the [reason] is applicable here.",
     )
-
-    @field_validator("reason", mode="before")
-    @classmethod
-    def validate_reason(cls, value):
-        return convert_enum(IssueResolutionReason, value)