Skip to content

hyperion.sources.base

hyperion.sources.base

Base abstract class for sources.

Source 

Source(catalog)

Bases: ABC

Source code in hyperion/sources/base.py 
46
47
48
49
def __init__(self, catalog: Catalog) -> None:
    if self.source is NotImplemented:
        raise NotImplementedError("Cannot instantiate a source without a source name.")
    self.catalog = catalog

run abstractmethod 

run(start_date=None, end_date=None, params=None)

The main coroutine that runs the source extraction.

Source code in hyperion/sources/base.py 
51
52
53
54
55
56
57
58
@abc.abstractmethod
def run(
    self,
    start_date: datetime.date | None = None,
    end_date: datetime.date | None = None,
    params: SourceParamsType | None = None,
) -> Awaitable[Iterable[SourceAsset]] | AsyncIterator[SourceAsset]:
    """The main coroutine that runs the source extraction."""