Module: reader

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from abc import ABC
from abc import abstractmethod
from dataclasses import dataclass
from cl.runtime.file.reader_key import ReaderKey
from cl.runtime.records.record_mixin import RecordMixin


@dataclass(slots=True, kw_only=True)
class Reader(ReaderKey, RecordMixin[ReaderKey], ABC):
    """Read records from the specified files or directories and save them to the current context."""

    def get_key(self) -> ReaderKey:
        return ReaderKey(loader_id=self.loader_id)

    @abstractmethod
    def read(self) -> None:
        """Read records from the specified files or directories and save them to the current context."""

Classes

class Reader (*, loader_id: str = None)

Read records from the specified files or directories and save them to the current context.

Expand source code

@dataclass(slots=True, kw_only=True)
class Reader(ReaderKey, RecordMixin[ReaderKey], ABC):
    """Read records from the specified files or directories and save them to the current context."""

    def get_key(self) -> ReaderKey:
        return ReaderKey(loader_id=self.loader_id)

    @abstractmethod
    def read(self) -> None:
        """Read records from the specified files or directories and save them to the current context."""

Ancestors

ReaderKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Subclasses

CsvFileReader

Static methods

def get_key_type() -> Type: Inherited from: ReaderKey.get_key_type

Return key type even when called from a record.

Fields

var loader_id -> str: Inherited from: ReaderKey.loader_id

Unique loader identifier.

Methods

def get_key(self) -> ReaderKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.
def read(self) -> None: Read records from the specified files or directories and save them to the current context.