# Copyright 2019-2025 The ASReview Authors. All Rights Reserved.
#
# 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.
__all__ = ["CSVReader"]
import pandas as pd
from asreview.data.base import BaseReader
from asreview.data.record import Record
[docs]
class CSVReader(BaseReader):
"""CVS file reader."""
read_format = [".csv", ".tab", ".tsv"]
write_format = [".csv", ".tsv", ".xlsx"]
mime_types = {
"text/csv": [".csv"],
"text/tab-separated-values": [".tsv", ".tab"],
"text/plain": [".csv", ".tsv", ".tab"],
}
[docs]
@classmethod
def read_data(cls, fp):
"""Import dataset.
Parameters
----------
fp: str, pathlib.Path
File path to the CSV file.
Returns
-------
list:
List with entries.
"""
for encoding in ["utf-8", "ISO-8859-1"]:
try:
return pd.read_csv(fp, sep=None, encoding=encoding, engine="python")
except UnicodeDecodeError:
# if unicode error, go to next encoding
continue
raise UnicodeDecodeError("The encoding of the file is not supported.")
[docs]
class CSVWriter:
"""CSV file writer."""
name = "csv"
label = "CSV (UTF-8)"
write_format = ".csv"
[docs]
@classmethod
def write_data(cls, df, fp, sep=","):
"""Export dataset.
Parameters
----------
df: pandas.Dataframe
Dataframe of all available record data.
fp: str, NoneType
Filepath or None for buffer.
sep: str
Seperator of the file.
Returns
-------
CSV file
Dataframe of all available record data.
"""
return df.to_csv(fp, sep=sep, index=True, date_format="%Y-%m-%d %H:%M:%S")
[docs]
class ExcelReader(BaseReader):
"""Excel file reader."""
read_format = [".xlsx"]
write_format = [".csv", ".tsv", ".xlsx"]
mime_types = {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": [".xlsx"],
}
[docs]
@classmethod
def read_data(cls, fp):
"""Import dataset.
Parameters
----------
fp: str, pathlib.Path
File path to the Excel file (.xlsx).
Returns
-------
list:
List with entries.
"""
try:
dfs = pd.read_excel(fp, sheet_name=None)
except UnicodeDecodeError:
dfs = pd.read_excel(fp, sheet_name=None, encoding="ISO-8859-1")
best_sheet = None
sheet_obj_val = -1
wanted_columns = Record.get_columns()
for col_names in cls.__alternative_column_names__.values():
wanted_columns.extend(col_names)
for sheet_name in dfs:
col_names = set([col.lower() for col in list(dfs[sheet_name])])
obj_val = len(col_names & set(wanted_columns))
if obj_val > sheet_obj_val:
sheet_obj_val = obj_val
best_sheet = sheet_name
return dfs[best_sheet]
[docs]
class ExcelWriter:
"""Excel file writer."""
name = "xlsx"
label = "Excel"
write_format = ".xlsx"
[docs]
@classmethod
def write_data(cls, df, fp):
"""Export dataset.
Parameters
----------
df: pandas.Dataframe
Dataframe of all available record data.
fp: str, NoneType
Filepath or None for buffer.
Returns
-------
Excel file
Dataframe of all available record data.
"""
return df.to_excel(fp, index=True, engine="openpyxl")
[docs]
class TSVWriter:
"""TSV file writer."""
name = "tsv"
label = "TSV (UTF-8)"
write_format = ".tsv"
[docs]
@classmethod
def write_data(cls, df, fp, sep="\t"):
"""Export dataset.
Parameters
----------
df: pandas.Dataframe
Dataframe of all available record data.
fp: str, NoneType
Filepath or None for buffer.
sep: str
Seperator of the file.
Returns
-------
TSV file
Dataframe of all available record data.
"""
return df.to_csv(fp, sep=sep, index=True, date_format="%Y-%m-%d %H:%M:%S")
