Базовый интерфейс

Bases: ABC

Base file filter interface.

Filters used by several onETL components, including [file-downloader][] and [file-mover][], to determine if a file should be handled or not.

All filters are stateless.

Added in 0.8.0

Source code in onetl/base/base_file_filter.py

class BaseFileFilter(ABC):
    """
    Base file filter interface.

    Filters used by several onETL components, including [file-downloader][] and [file-mover][],
    to determine if a file should be handled or not.

    All filters are stateless.

    !!! success "Added in 0.8.0"
    """

    @abstractmethod
    def match(self, path: PathProtocol) -> bool:
        """
        Returns `True` if path is matching the filter, `False` otherwise

        !!! success "Added in 0.8.0"

        Examples
        --------

        ```python
        >>> from onetl.impl import LocalPath
        >>> filter.match(LocalPath("/path/to/file.csv"))
        True
        >>> filter.match(LocalPath("/path/to/excluded.csv"))
        False
        >>> filter.match(LocalPath("/path/to/file.csv"))
        True
        ```
        """

match(path) abstractmethod

Returns True if path is matching the filter, False otherwise

Added in 0.8.0

Examples

>>> from onetl.impl import LocalPath
>>> filter.match(LocalPath("/path/to/file.csv"))
True
>>> filter.match(LocalPath("/path/to/excluded.csv"))
False
>>> filter.match(LocalPath("/path/to/file.csv"))
True

Source code in onetl/base/base_file_filter.py

@abstractmethod
def match(self, path: PathProtocol) -> bool:
    """
    Returns `True` if path is matching the filter, `False` otherwise

    !!! success "Added in 0.8.0"

    Examples
    --------

    ```python
    >>> from onetl.impl import LocalPath
    >>> filter.match(LocalPath("/path/to/file.csv"))
    True
    >>> filter.match(LocalPath("/path/to/excluded.csv"))
    False
    >>> filter.match(LocalPath("/path/to/file.csv"))
    True
    ```
    """