Core Models

class SubmissionInfo(AuditRecord):
    """Submission metadata"""

    dataset_id: str
    """The dataset that the submission relates to."""
    file_name: str
    """The name of the submitted file."""
    file_extension: str
    """The extension of the file received."""
    submission_method: Optional[str] = None  # type: ignore
    """The method that the file was submitted"""
    submitting_org: Optional[str] = None  # type: ignore
    """The organisation who submitted the file."""
    reporting_period_start: Optional[str] = None  # type: ignore
    """The start of the reporting period the submission relates to."""
    reporting_period_end: Optional[str] = None  # type: ignore
    """The end of the reporting period the submission relates to."""
    file_size: Optional[int] = None  # type: ignore
    """The size (in bytes) of the file received."""
    datetime_received: Optional[dt.datetime] = None  # type: ignore
    """The datetime the file was received."""

    @field_validator("file_extension")
    def _ensure_just_file_stem(
        cls, extension: str, info: ValidationInfo  # pylint: disable=W0613
    ):  # pylint: disable=no-self-argument
        return extension.rsplit(".", 1)[-1]

    @property
    def file_name_with_ext(self):
        """Return file name with extension."""
        if self.file_extension:
            return f"{self.file_name}.{self.file_extension}"
        return self.file_name

    @classmethod
    def from_metadata_file(cls, submission_id: str, metadata_uri: Location):
        """Create a submission metadata instance from DVE metadata file."""
        metadata_uri = resolve_location(metadata_uri)
        with open_stream(metadata_uri, "r", "utf-8") as stream:
            try:
                metadata_dict: dict[str, Any] = json.load(stream)
            except json.JSONDecodeError as exc:
                raise ValueError(f"File found at {metadata_uri!r} is not valid JSON") from exc

        if isinstance(metadata_dict, list):
            raise ValueError(f"File found at {metadata_uri!r} is not a JSON mapping")

        if not metadata_dict.get("file_name"):
            metadata_dict["file_name"] = get_file_stem(metadata_uri)

        return cls(submission_id=submission_id, **metadata_dict)

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, SubmissionInfo):
            raise NotImplementedError("Unable to determine equality if not a SubmissionInfo object")
        _exclude = ["date_updated", "time_updated"]
        return {k: v for k, v in self.model_dump().items() if k not in _exclude} == {
            k: v for k, v in other.model_dump().items() if k not in _exclude
        }