Add docstring
Browse files- src/pandas_utility.py +48 -7
src/pandas_utility.py
CHANGED
@@ -5,10 +5,23 @@ import ast
|
|
5 |
from abc import ABC, abstractmethod
|
6 |
from typing import List, Any
|
7 |
|
8 |
-
def read_csv_df(read_path: str, header=0) -> pd.DataFrame:
|
9 |
"""
|
10 |
-
|
11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
"""
|
13 |
df = pd.read_csv(read_path, header=header)
|
14 |
|
@@ -18,7 +31,23 @@ def read_csv_df(read_path: str, header=0) -> pd.DataFrame:
|
|
18 |
|
19 |
return df
|
20 |
|
21 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
22 |
# 数値に、インデックスで最初の文字を指定するとエラーになる
|
23 |
is_str = isinstance(value, str)
|
24 |
|
@@ -31,11 +60,23 @@ def check_lst_col(value: str):
|
|
31 |
|
32 |
return is_lst_col
|
33 |
|
34 |
-
|
35 |
-
def save_csv_df(df, file_name: str, save_dir: str) -> None:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
36 |
df.to_csv(f'{save_dir}/{file_name}.csv', index=False)
|
37 |
|
38 |
-
|
39 |
class CustomError(Exception, ABC):
|
40 |
"""
|
41 |
カスタムエラーの基底クラス
|
|
|
5 |
from abc import ABC, abstractmethod
|
6 |
from typing import List, Any
|
7 |
|
8 |
+
def read_csv_df(read_path: str, header: int = 0) -> pd.DataFrame:
|
9 |
"""
|
10 |
+
csv形式のデータフレームの読み込み
|
11 |
+
|
12 |
+
文字列として読み込まれたリストの復元も行う
|
13 |
+
|
14 |
+
Parameters
|
15 |
+
----------
|
16 |
+
read_path : str
|
17 |
+
データフレームが保存されているパス
|
18 |
+
header : int, optional
|
19 |
+
ヘッダーとする行の指定, by default 0
|
20 |
+
|
21 |
+
Returns
|
22 |
+
-------
|
23 |
+
pd.DataFrame
|
24 |
+
データフレーム
|
25 |
"""
|
26 |
df = pd.read_csv(read_path, header=header)
|
27 |
|
|
|
31 |
|
32 |
return df
|
33 |
|
34 |
+
|
35 |
+
def check_lst_col(value: str) -> bool:
|
36 |
+
"""
|
37 |
+
リストの列の確認
|
38 |
+
|
39 |
+
元の値がリストだった列の確認
|
40 |
+
|
41 |
+
Parameters
|
42 |
+
----------
|
43 |
+
value : str
|
44 |
+
その列の代表の値
|
45 |
+
|
46 |
+
Returns
|
47 |
+
-------
|
48 |
+
bool
|
49 |
+
その列の値がリストならTrue、リストでなければFalse
|
50 |
+
"""
|
51 |
# 数値に、インデックスで最初の文字を指定するとエラーになる
|
52 |
is_str = isinstance(value, str)
|
53 |
|
|
|
60 |
|
61 |
return is_lst_col
|
62 |
|
63 |
+
|
64 |
+
def save_csv_df(df: pd.DataFrame, file_name: str, save_dir: str) -> None:
|
65 |
+
"""
|
66 |
+
csv形式でのデータフレームの保存
|
67 |
+
|
68 |
+
Parameters
|
69 |
+
----------
|
70 |
+
df : pd.DataFrame
|
71 |
+
保存するデータフレーム
|
72 |
+
file_name : str
|
73 |
+
保存するデータフレームのファイル名
|
74 |
+
save_dir : str
|
75 |
+
データフレームの保存先ディレクトリ
|
76 |
+
"""
|
77 |
df.to_csv(f'{save_dir}/{file_name}.csv', index=False)
|
78 |
|
79 |
+
|
80 |
class CustomError(Exception, ABC):
|
81 |
"""
|
82 |
カスタムエラーの基底クラス
|