Query Module

datajoint_file_validator.query.Query dataclass

Bases: ABC

An object representing a query against a snapshot.

Source code in datajoint_file_validator/query.py

@dataclass(frozen=True)
class Query(ABC):
    """An object representing a query against a snapshot."""

    @abstractmethod
    def filter(self, snapshot: Snapshot) -> Snapshot:
        """Filter a Snapshot based on this query. Virtual method."""
        pass

    def __and__(self, other: "Query") -> "Query":
        """Combine two queries with an AND operator."""
        return CompositeQuery([self, other])

filter(snapshot) abstractmethod

Filter a Snapshot based on this query. Virtual method.

Source code in datajoint_file_validator/query.py

@abstractmethod
def filter(self, snapshot: Snapshot) -> Snapshot:
    """Filter a Snapshot based on this query. Virtual method."""
    pass

datajoint_file_validator.query.GlobQuery dataclass

Bases: Query

A query that filters based on path. Includes support for glob wildcards.

Source code in datajoint_file_validator/query.py

@dataclass(frozen=True)
class GlobQuery(Query):
    """A query that filters based on path. Includes support for glob wildcards."""

    path: str = config.default_query

    def filter(self, snapshot: Snapshot) -> Snapshot:
        """Filter a Snapshot based on this query."""
        return list(self._filter_generator(snapshot))

    def _filter_generator(self, snapshot: Snapshot) -> Generator:
        """Filter a Snapshot based on this query. Returns a generator."""
        return find_matching_files(snapshot, self.path)

filter(snapshot)

Filter a Snapshot based on this query.

Source code in datajoint_file_validator/query.py

def filter(self, snapshot: Snapshot) -> Snapshot:
    """Filter a Snapshot based on this query."""
    return list(self._filter_generator(snapshot))