Source code for wfcommons.common.file

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (c) 2020-2024 The WfCommons Team.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

import logging

from logging import Logger
from typing import Dict, Optional, Union

from ..utils import NoValue




class File:
    """Representation of a file.

    :param file_id: The id of the file.
    :type file_id: str
    :param size: File size in bytes.
    :type size: int
    :param logger: The logger where to log information/warning or errors.
    :type logger: Optional[Logger]
    """

    def __init__(self, file_id: str, 
                 size: int, 
                 logger: Optional[Logger] = None) -> None:
        """A file used by tasks."""
        self.logger: Logger = logger if logger else logging.getLogger(__name__)

        self.file_id: str = file_id
        self.size: int = size



    def as_dict(self) -> Dict[str, Union[str, int]]:
        """A JSON representation of the file.

        :return: A JSON object representation of the file.
        :rtype: Dict[str, Union[str, int]]
        """
        return {
            'id': self.file_id,
            'sizeInBytes': self.size
        }


    def __str__(self) -> str:
        return self.file_id

    def __eq__(self, value: object) -> bool:
        return self.file_id == value.file_id and self.size == value.size
    
    def __hash__(self) -> int:
        return hash((self.file_id, self.size))