aboutsummaryrefslogtreecommitdiffstats
path: root/bsie/reader/base.py
blob: a7757016e1d1ed869a680b7546ea8bb1edab630a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# standard imports
import abc
import typing

# bsie imports
from bsie.utils import bsfs

# exports
__all__: typing.Sequence[str] = (
    'Reader',
    )


## code ##

class Reader(abc.ABC):
    """Read and return some content from a file."""

    def __str__(self) -> str:
        return bsfs.typename(self)

    def __repr__(self) -> str:
        return f'{bsfs.typename(self)}()'

    def __eq__(self, other: typing.Any) -> bool:
        return isinstance(other, type(self))

    def __hash__(self) -> int:
        return hash(type(self))

    @abc.abstractmethod
    def __call__(self, path: str) -> typing.Any:
        """Return some content of the file at *path*.
        Raises a `ReaderError` if the reader cannot make sense of the file format.
        """

## EOF ##