python-ort 0.6.6__tar.gz → 0.8.0__tar.gz

{python_ort-0.6.6 → python_ort-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-ort
-Version: 0.6.6
+Version: 0.8.0
 Summary: A Python Ort model serialization library
 License-Expression: MIT
 License-File: LICENSE
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: license-expression>=30.4.4
 Requires-Dist: packageurl-python>=0.17.6
 Requires-Dist: pydantic>=2.12.5
 Requires-Python: >=3.10
@@ -20,4 +21,29 @@ Description-Content-Type: text/markdown
 
 # Python-Ort
 
-Python-Ort is a pydantic based library to serialize OSS Review Toolkit generated reports using the default models.
+Python-Ort is a pydantic v2 based library to serialize [OSS Review Toolkit](https://oss-review-toolkit.org/ort/) generated reports using the default models.
+
+## Install
+
+```bash
+pip install python-ort
+```
+
+## Simple usage example based on a report in yml format:
+
+```python
+from pprint import pprint
+from pathlib import Path
+from pydantic import ValidationError
+
+from ort import OrtResult, ort_yaml_load
+
+
+try:
+    with Path("some-result.yml").open() as fd:
+        data = ort_yaml_load(fd)
+    parsed = OrtResult(**data)
+    pprint(parsed)
+except ValidationError as e:
+    print(e)
+```

python_ort-0.8.0/README.md

@@ -0,0 +1,28 @@
+# Python-Ort
+
+Python-Ort is a pydantic v2 based library to serialize [OSS Review Toolkit](https://oss-review-toolkit.org/ort/) generated reports using the default models.
+
+## Install
+
+```bash
+pip install python-ort
+```
+
+## Simple usage example based on a report in yml format:
+
+```python
+from pprint import pprint
+from pathlib import Path
+from pydantic import ValidationError
+
+from ort import OrtResult, ort_yaml_load
+
+
+try:
+    with Path("some-result.yml").open() as fd:
+        data = ort_yaml_load(fd)
+    parsed = OrtResult(**data)
+    pprint(parsed)
+except ValidationError as e:
+    print(e)
+```

{python_ort-0.6.6 → python_ort-0.8.0}/pyproject.toml

@@ -4,13 +4,14 @@ build-backend = "uv_build"
 
 [project]
 name = "python-ort"
-version = "0.6.6"
+version = "0.8.0"
 description = "A Python Ort model serialization library"
 readme = "README.md"
 license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.10"
 dependencies = [
+    "license-expression>=30.4.4",
     "packageurl-python>=0.17.6",
     "pydantic>=2.12.5",
 ]
@@ -35,11 +36,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.6",
+    "ty>=0.0.22",
     "types-pyyaml>=6.0.12.20250915",
 ]
 
@@ -144,9 +145,7 @@ extend-select = [
     "S",   # bandit
 ]
 ignore = [
-    'N802',   # function name should be lowercase
     'SIM105', # Suggest contextlib instead of try/except with pass
-    'A004',  # Python shadow builtins
 ]
 # Unlike Flake8, default to a complexity level of 10.
 mccabe.max-complexity = 10

{python_ort-0.6.6 → python_ort-0.8.0}/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",
 ]

{python_ort-0.6.6 → python_ort-0.8.0}/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.
 

{python_ort-0.6.6 → python_ort-0.8.0}/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

python_ort-0.8.0/src/ort/models/advisor_run.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <heliocastro@gmail.com>
+# SPDX-License-Identifier: MIT
+
+
+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(BaseRun):
+    """
+    Type alias for a function that allows filtering of [AdvisorResult]s.
+
+    """
+
+    config: AdvisorConfiguration = Field(
+        description="The [AdvisorConfiguration] used for this run.",
+    )
+    results: dict[Identifier, list[AdvisorResult]] = Field(
+        default_factory=dict,
+        description="The result of this run.",
+    )

python_ort-0.8.0/src/ort/models/analyzer_run.py

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import Field
+
+from .analyzer_result import AnalyzerResult
+from .base_run import BaseRun
+from .config.analyzer_configuration import AnalyzerConfiguration
+
+
+class AnalyzerRun(BaseRun):
+    """
+    The summary of a single run of the analyzer.
+
+    """
+
+    config: AnalyzerConfiguration = Field(
+        description="The [AnalyzerConfiguration] used for this run.",
+    )
+    result: AnalyzerResult | None = Field(
+        default=None,
+        description="The result of this run.",
+    )

python_ort-0.6.6/src/ort/models/analyzer_run.py → python_ort-0.8.0/src/ort/models/base_run.py

@@ -1,16 +1,15 @@
-# SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
+# SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <dev@heliocastro.info>
+# # SPDX-FileCopyrightText: 2026 CARIAD SE
 # SPDX-License-Identifier: MIT
 
 from datetime import datetime
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from ort.models import AnalyzerResult
-from ort.models.config.analyzer_configuration import AnalyzerConfiguration
 from ort.utils.environment import Environment
 
 
-class AnalyzerRun(BaseModel):
+class BaseRun(BaseModel):
     """
     The summary of a single run of the analyzer.
 
@@ -28,10 +27,3 @@ class AnalyzerRun(BaseModel):
     environment: Environment = Field(
         description="The [Environment] in which the analyzer was executed.",
     )
-    config: AnalyzerConfiguration = Field(
-        description="The [AnalyzerConfiguration] used for this run.",
-    )
-    result: AnalyzerResult | None = Field(
-        default=None,
-        description="The result of this run.",
-    )

python_ort-0.8.0/src/ort/models/config/file_archiver_configuration.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .file_storage_configuration import FileStorageConfiguration
+from .scan_storage_configuration import PostgresStorageConfiguration
+
+
+class FileArchiverConfiguration(BaseModel):
+    """
+    The configuration model for a FileArchiver.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+
+    enabled: bool = Field(
+        default=True,
+        description="Toggle to enable or disable the file archiver functionality altogether.",
+    )
+    file_storage: FileStorageConfiguration | None = Field(
+        default=None,
+        description="Configuration of the FileStorage used for archiving the files.",
+    )
+    postgres_storage: PostgresStorageConfiguration | None = Field(
+        default=None,
+        description="Configuration of the PostgresProvenanceFileStorage used for archiving the files.",
+    )

python_ort-0.8.0/src/ort/models/config/file_list_storage_configuration.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .file_storage_configuration import FileStorageConfiguration
+from .scan_storage_configuration import PostgresStorageConfiguration
+
+
+class FileListStorageConfiguration(BaseModel):
+    """
+    Configuration for the storage backends used for persisting file lists.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    file_storage: FileStorageConfiguration | None = Field(
+        default=None,
+        description=("Configuration of the FileStorage used for storing the file lists."),
+    )
+    postgres_storage: PostgresStorageConfiguration | None = Field(
+        default=None,
+        description="Configuration of the PostgresProvenanceFileStorage used for storing the file lists.",
+    )

python_ort-0.8.0/src/ort/models/config/file_storage_configuration.py

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .http_file_storage_configuration import HttpFileStorageConfiguration
+from .local_file_storage_configuration import LocalFileStorageConfiguration
+from .s3_file_storage_configuration import S3FileStorageConfiguration
+
+
+class FileStorageConfiguration(BaseModel):
+    """
+    The configuration model for a FileStorage. Only one of the storage options
+    can be configured.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+
+    http_file_storage: HttpFileStorageConfiguration | None = Field(
+        default=None,
+        description="The configuration of a HttpFileStorage.",
+    )
+    local_file_storage: LocalFileStorageConfiguration | None = Field(
+        default=None,
+        description="The configuration of a LocalFileStorage.",
+    )
+    s3_file_storage: S3FileStorageConfiguration | None = Field(
+        default=None,
+        description="The configuration of a S3FileStorage.",
+    )

python_ort-0.8.0/src/ort/models/config/http_file_storage_configuration.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class HttpFileStorageConfiguration(BaseModel):
+    """
+    Configuration for HTTP-based file storage.
+    """
+
+    url: str = Field(
+        description='The URL of the HTTP server, e.g. "https://example.com/storage".',
+    )
+    query: str = Field(
+        default="",
+        description='Query string appended to the URL and path. Can contain auth data, e.g. "?user=standard&pwd=123".',
+    )
+    headers: dict[str, str] = Field(
+        default_factory=dict,
+        description="Custom headers added to all HTTP requests. Values may contain credentials.",
+    )
+
+    model_config = ConfigDict(extra="forbid")

{python_ort-0.6.6 → python_ort-0.8.0}/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)

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/issue_resolution_reason.py

@@ -1,10 +1,10 @@
 # SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
 # SPDX-License-Identifier: MIT
 
-from enum import IntEnum
+from ort.utils.validated_enum import ValidatedIntEnum
 
 
-class IssueResolutionReason(IntEnum):
+class IssueResolutionReason(ValidatedIntEnum):
     """
     Possible reasons for resolving an Issue using an IssueResolution.
 

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/license_finding_curation_reason.py

@@ -3,10 +3,10 @@
 # SPDX-License-Identifier: MIT
 
 
-from enum import Enum
+from ...utils.validated_enum import ValidatedIntEnum
 
 
-class LicenseFindingCurationReason(Enum):
+class LicenseFindingCurationReason(ValidatedIntEnum):
     """
     A curation for a license finding. Use it to correct a license finding or to add a license that was not
     previously detected.
@@ -20,9 +20,9 @@ class LicenseFindingCurationReason(Enum):
         REFERENCE: The findings reference a file or URL, e.g. SEE LICENSE IN LICENSE or https://jquery.org/license/.
     """
 
-    CODE = "CODE"
-    DATA_OF = "DATA_OF"
-    DOCUMENTATION_OF = "DOCUMENTATION_OF"
-    INCORRECT = "INCORRECT"
-    NOT_DETECTED = "NOT_DETECTED"
-    REFERENCE = "REFERENCE"
+    CODE = 1
+    DATA_OF = 2
+    DOCUMENTATION_OF = 3
+    INCORRECT = 4
+    NOT_DETECTED = 5
+    REFERENCE = 6

python_ort-0.8.0/src/ort/models/config/local_file_storage_configuration.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class LocalFileStorageConfiguration(BaseModel):
+    """
+    A class to hold the configuration for using local files as a storage.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    directory: str = Field(
+        ...,
+        description="The directory to use as a storage root.",
+    )
+    compression: bool = Field(
+        default=True,
+        description="Whether to use compression for storing files or not. Defaults to true.",
+    )

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/path_exclude.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 .path_exclude_reason import PathExcludeReason
 
@@ -32,8 +30,3 @@ class PathExclude(BaseModel):
         default_factory=str,
         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(PathExcludeReason, value)

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/path_exclude_reason.py

@@ -1,10 +1,10 @@
 # SPDX-FileCopyrightText: 2025 Helio Chissini de Castro <heliocastro@gmail.com>
 # SPDX-License-Identifier: MIT
 
-from enum import IntEnum
+from ort.utils.validated_enum import ValidatedIntEnum
 
 
-class PathExcludeReason(IntEnum):
+class PathExcludeReason(ValidatedIntEnum):
     """
     Possible reasons for excluding a path.
 

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/path_include.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 .path_include_reason import PathIncludeReason
 
@@ -32,8 +30,3 @@ class PathInclude(BaseModel):
         default_factory=str,
         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(PathIncludeReason, value)

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/path_include_reason.py

@@ -1,10 +1,10 @@
 # SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <heliocastro@gmail.com>
 # SPDX-License-Identifier: MIT
 
-from enum import IntEnum
+from ort.utils.validated_enum import ValidatedIntEnum
 
 
-class PathIncludeReason(IntEnum):
+class PathIncludeReason(ValidatedIntEnum):
     """
     Possible reasons for including a path.
 

python_ort-0.8.0/src/ort/models/config/postgres_connection.py

@@ -0,0 +1,97 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <heliocastro@gmail.com>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class PostgresConnection(BaseModel):
+    """
+    PostgreSQL connection configuration and HikariCP pool settings.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    url: str = Field(
+        ...,
+        description=("The database URL in JDBC format."),
+    )
+
+    provider_schema: str = Field(
+        default="public",
+        alias="schema",
+        description=("The name of the database to use."),
+    )
+
+    username: str = Field(
+        ...,
+        description=("The username to use for authentication."),
+    )
+
+    password: str = Field(
+        default_factory=str,
+        description=("The password to use for authentication."),
+    )
+
+    sslmode: str = Field(
+        default="verify-full",
+        description='The SSL mode to use, one of "disable", "allow", "prefer", "require", '
+        '"verify-ca" or "verify-full". See: '
+        "https://jdbc.postgresql.org/documentation/ssl/#configuring-the-client",
+    )
+
+    sslcert: str | None = Field(
+        None,
+        description="The full path of the certificate file. See: https://jdbc.postgresql.org/documentation/head/connect.html",
+    )
+
+    sslkey: str | None = Field(
+        None,
+        description="The full path of the key file. See: https://jdbc.postgresql.org/documentation/head/connect.html",
+    )
+
+    sslrootcert: str | None = Field(
+        None,
+        description="The full path of the root certificate file. See: "
+        "https://jdbc.postgresql.org/documentation/head/connect.html",
+    )
+
+    connection_timeout: int | None = Field(
+        None,
+        description="Maximum milliseconds to wait for connections from the pool. See: "
+        "https://github.com/brettwooldridge/HikariCP#frequently-used",
+    )
+
+    idle_timeout: int | None = Field(
+        None,
+        description="Maximum milliseconds a connection may sit idle in the pool. Requires "
+        "minimum_idle < maximum_pool_size. See: "
+        "https://github.com/brettwooldridge/HikariCP#frequently-used",
+    )
+
+    keepalive_time: int | None = Field(
+        None,
+        description="Frequency in milliseconds that the pool will keep an idle connection "
+        "alive. Must be lower than max_lifetime. See: "
+        "https://github.com/brettwooldridge/HikariCP#frequently-used",
+    )
+
+    max_lifetime: int | None = Field(
+        None,
+        description=(
+            "Maximum lifetime of a connection in milliseconds. See: "
+            "https://github.com/brettwooldridge/HikariCP#frequently-used"
+        ),
+    )
+
+    maximum_pool_size: int | None = Field(
+        None,
+        description="Maximum size of the connection pool. See: https://github.com/brettwooldridge/HikariCP#frequently-used",
+    )
+
+    minimum_idle: int | None = Field(
+        None,
+        description="Minimum number of idle connections that the pool tries to maintain. "
+        "See: https://github.com/brettwooldridge/HikariCP#frequently-used",
+    )

python_ort-0.8.0/src/ort/models/config/provenance_storage_configuration.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2026 Helio Chissini de Castro <dev@heliocastro.info>
+# SPDX-FileCopyrightText: 2026 CARIAD SE
+# SPDX-License-Identifier: MIT
+
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .file_storage_configuration import FileStorageConfiguration
+from .scan_storage_configuration import PostgresStorageConfiguration
+
+
+class ProvenanceStorageConfiguration(BaseModel):
+    """
+    Configuration of the storage to use for provenance information.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    file_storage: FileStorageConfiguration | None = Field(
+        default=None,
+        description="Configuration of a file storage.",
+    )
+    postgres_storage: PostgresStorageConfiguration | None = Field(
+        default=None,
+        description="Configuration of a PostgreSQL storage.",
+    )

{python_ort-0.6.6 → python_ort-0.8.0}/src/ort/models/config/repository_configuration.py

@@ -11,7 +11,7 @@ from .license_choice import LicenseChoice
 from .package_configuration import PackageConfiguration
 from .repository_analyzer_configuration import RepositoryAnalyzerConfiguration
 from .resolutions import Resolutions
-from .snippet_choices import SnippetChoices
+from .snippet.snippet_choices import SnippetChoices
 
 
 class RepositoryConfiguration(BaseModel):