source_uploader.py

"""Module for the upload source endpoint."""

from abc import abstractmethod
from typing import Optional

from pydantic import StrictStr

from admin_api_lib.api_endpoints.uploader_base import UploaderBase
from admin_api_lib.models.key_value_pair import KeyValuePair


class SourceUploader(UploaderBase):
    """Abstract base class for source uploader API endpoints."""

    @abstractmethod
    def cancel_upload(self, identification: str) -> None:
        """
        Signal cancellation for an in-flight source upload.

        Parameters
        ----------
        identification : str
            Document identification (for example ``confluence:my_space``).
        """

    @abstractmethod
    async def upload_source(
        self,
        source_type: StrictStr,
        name: StrictStr,
        kwargs: list[KeyValuePair],
        timeout: Optional[float],
    ) -> None:
        """
        Upload the parameters for source content extraction.

        Parameters
        ----------
        source_type : str
            The type of the source. Is used by the extractor service to determine the correct extraction method.
        name : str
            Display name of the source.
        kwargs : list[KeyValuePair]
            List of KeyValuePair with parameters used for the extraction.
        timeout : float, optional
            Timeout for the operation.

        Returns
        -------
        None
        """