mirror of
https://github.com/OpenSPG/openspg.git
synced 2025-07-30 04:22:36 +00:00
68 lines
1.9 KiB
Python
68 lines
1.9 KiB
Python
from abc import ABC
|
|
from typing import Union, List, Dict
|
|
|
|
from pydantic import Field
|
|
|
|
from knext import rest
|
|
from knext.common.runnable import Input, Output
|
|
from knext.component.builder.base import SourceReader
|
|
|
|
|
|
class CsvSourceReader(SourceReader):
|
|
"""A source component that reading data from CSV file.
|
|
|
|
Args:
|
|
local_path: The local path of CSV file.
|
|
columns: The column names that need to be read from the CSV file.
|
|
start_row: The starting number of rows read from the CSV file.
|
|
If the CSV file includes a header, it needs to be greater than or equal to 2.
|
|
Examples:
|
|
source = SourceCsvComponent(
|
|
local_path="./builder/job/data/App.csv",
|
|
columns=["id", 'riskMark', 'useCert'],
|
|
start_row=2
|
|
)
|
|
"""
|
|
|
|
"""The local path of CSV file."""
|
|
local_path: str
|
|
"""The column names that need to be read from the CSV file."""
|
|
columns: List[str]
|
|
"""The starting number of rows read from the CSV file.
|
|
If the CSV file includes a header, it needs to be greater than or equal to 2."""
|
|
start_row: int = Field(ge=1)
|
|
|
|
@property
|
|
def input_types(self) -> Input:
|
|
return None
|
|
|
|
@property
|
|
def output_types(self) -> Output:
|
|
return Dict[str, str]
|
|
|
|
@property
|
|
def input_keys(self):
|
|
return None
|
|
|
|
@property
|
|
def output_keys(self):
|
|
return self.columns
|
|
|
|
def invoke(self, input: Input):
|
|
pass
|
|
|
|
def submit(self):
|
|
pass
|
|
|
|
def to_rest(self):
|
|
"""Transforms `SourceCsvComponent` to REST model `CsvSourceNodeConfig`."""
|
|
|
|
config = rest.CsvSourceNodeConfig(
|
|
start_row=self.start_row, url=self.local_path, columns=self.columns
|
|
)
|
|
return rest.Node(**super().to_dict(), node_config=config)
|
|
|
|
@classmethod
|
|
def from_rest(cls, node: rest.Node):
|
|
return cls()
|