repo-autoindex/repo_autoindex/base.py

from dataclasses import dataclass
from typing import Optional, TypeVar, Type
from collections.abc import Awaitable, Callable, AsyncGenerator
from abc import ABC, abstractmethod

T = TypeVar("T")
Fetcher = Callable[[str], Awaitable[Optional[str]]]

ICON_FOLDER = "📂"
ICON_PACKAGE = "📦"
ICON_OTHER = "  "


@dataclass
class GeneratedIndex:
    content: str
    relative_dir: str = "."


@dataclass
class IndexEntry:
    href: str
    text: str
    time: str = "-"
    size: str = "-"
    padding: str = ""
    icon: str = ICON_OTHER

    @property
    def href_leading_dir(self) -> str:
        components = self.href.split("/", 1)
        if len(components) == 1:
            return ""
        return components[0]


class Repo(ABC):
    def __init__(
        self,
        base_url: str,
        entry_point_content: str,
        fetcher: Fetcher,
    ):
        self.base_url = base_url
        self.entry_point_content = entry_point_content
        self.fetcher = fetcher

    @abstractmethod
    async def render_index(
        self, index_href_suffix: str
    ) -> AsyncGenerator[GeneratedIndex, None]:
        pass

    @classmethod
    @abstractmethod
    async def probe(cls: Type[T], fetcher: Fetcher, url: str) -> Optional[T]:
        """Determine if a specified URL seems to point at a repository of this type.

        If so, returns an initialized Repo of a concrete subtype. If not, returns None.
        """
        pass