{{ message }}
Repository navigation
Expand file tree
/
Copy pathfiles.py
More file actions
619 lines (519 loc) · 17.5 KB
/
Copy pathfiles.py
File metadata and controls
619 lines (519 loc) · 17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
#!/usr/bin/env python
# -*- coding:utf-8 -*-
# Copyright (c) 2020
# @Author : GitOPEN
# @Email : gitopen@gmail.com
# @Date : 2020-10-29 13:38:36
# @Description : 有关文件操作的相关工具函数
__version__ = "1.06.06"
import asyncio
import json
import os
import pickle
import shutil
import time
from pathlib import Path
from typing import Callable, Dict, Iterable, List, Optional, Sequence, Union
import pandas as pd
from pandas import DataFrame
from gitopenlib.utils import basics as gb
from gitopenlib.utils import files as gf
def get_disk_space(path="/"):
"""获取磁盘空间信息。
Args:
path: str: 磁盘路径，默认为根目录`/`。
Returns:
tuple: 返回一个包含总空间、已用空间和可用空间的元组，单位为GB。
(total_gb, used_gb, free_gb)
"""
total, used, free = shutil.disk_usage(path) # 返回字节为单位的元组
total_gb = total / (1024**3) # 转换为GB
used_gb = used / (1024**3)
free_gb = free / (1024**3)
return total_gb, used_gb, free_gb
def df_to_xlsx_pkl(
df: DataFrame,
save_path: str,
index: bool = False,
index_name: Union[str, Sequence] = None,
backup: bool = True,
):
"""把 DataFrame 保存为 xlsx 文件和 pkl 文件。"""
if save_path.endswith(".xlsx"):
xlsx_path = save_path
pkl_path = save_path.replace(".xlsx", ".pkl")
elif save_path.endswith(".pkl"):
xlsx_path = save_path.replace(".pkl", ".xlsx")
pkl_path = save_path
else:
raise Exception("The save_path must end with `.xlsx` or `.pkl`.")
parent_dir = Path(xlsx_path).parent
if not parent_dir.exists():
gf.new_dirs(str(parent_dir))
if backup:
gf.if_path_exist_then_backup(xlsx_path)
gf.if_path_exist_then_backup(pkl_path)
if index:
df.to_excel(xlsx_path, index=True, index_label=index_name)
else:
df.to_excel(xlsx_path, index=False)
df.to_pickle(pkl_path)
def df_to_json(
df: DataFrame,
path: str,
encoding="utf-8",
force_ascii=False,
):
"""把 DataFrame 保存为 json 文件。
Args:
df:
DataFrame数据。
path:
保存路径。
orient:
保存格式，参考 `pandas.DataFrame.to_json` 的参数说明。
"""
if_path_exist_then_backup(path)
with open(path, "w+", encoding=encoding) as f:
df.to_json(f, force_ascii=force_ascii)
def df_from_json(
path: str,
encoding="utf-8",
) -> DataFrame:
"""将json数据读取为 `pandas.DataFrame` 。"""
return pd.read_json(path, encoding=encoding)
def save_df(
df: DataFrame,
path: str,
format: str = "xlsx|json",
encoding="utf-8-sig",
backup: bool = True,
) -> None:
"""把 pandas 的 Dataframe 保存为 xlsx(csv) 、json 文件。
注：该方法使用pickle在3.7和3.8两个版本中存在兼容问题，请注意这一点。
Args:
df:
`DataFrame`数据。
path:
文件路径，给出一个文件路径即可。
format:
可选格式包括`xlsx|json`、`csv|json`、`json`、`xlsx`、`csv`；默认为`xlsx|json`。
encoding:
`xlsx(csv)`的编码格式，`utf-8-sig`方便windows系统打开它时不乱码；`json`的编码格式为`utf-8`。
backup:
`True`表示文件存在时进行备份(推荐)，`False`表示不备份。
"""
path = path.replace(".xlsx", "").replace(".csv", "").replace(".json", "")
path = path + ".{}"
def to_file(ft):
file_path = path.format(ft)
if backup:
if_path_exist_then_backup(file_path)
if ft == "xlsx":
df.to_excel(file_path)
if ft == "csv":
df.to_csv(file_path, encoding=encoding)
if ft == "json":
df_to_json(df, file_path)
fts = format.split("|")
for ft in fts:
to_file(ft)
def save_pkl(obj, path: str, backup: bool = True):
"""序列化对象并保存到磁盘。
Args:
object:
序列化对象。
path:
目标路径。
backup:
`True`表示文件存在时进行备份(推荐)，`False`表示不备份。
Returns:
bool: 保存成功，返回 True，保存失败，返回 False，抛出异常。
"""
if backup:
if_path_exist_then_backup(path)
file = open(path, mode="wb")
pickle.dump(obj, file)
file.close()
def read_pkl(path: str):
"""从磁盘读取序列化对象。"""
return pickle.load(open(path, "rb"))
def check_path(pathes: Union[str, List[str]]):
"""检查路径是否存在，不存在则创建。创建时会自动创建父目录。"""
if isinstance(pathes, str):
pathes = [pathes]
for path in pathes:
path = Path(path)
if not path.exists():
path.mkdir(parents=True, exist_ok=True)
def if_path_exist_then_backup(pathes: Union[str, List[str]]) -> bool:
"""检查路径是否存在，如路径存在，则备份。
Args:
pathes:
路径，可以是单个字符串或者字符串的列表。
Returns:
bool: 如果有文件被备份了，则为True，否则为False。
"""
if isinstance(pathes, str):
pathes = [pathes]
has_backup_files = False
for path in pathes:
path = Path(path)
if path.exists():
new_suffix = ".{}{}".format(
str(time.strftime("%Y%m%d_%H%M%S", time.localtime())),
path.suffix,
)
path.rename(path.with_suffix(new_suffix))
has_backup_files = True
return has_backup_files
def new_dirs(dir_paths: Union[str, List[str]]) -> List[str]:
"""初始化文件夹，检验文件夹的存在状态，并返回准备好的文件夹路径。
如果`dir_paths`为`str`类型，则返回值为单个路径；
如果为`list`类型，则返回值为列表。
Args:
dir_paths:
字符串类型的全路径，可以为单个路径，也可以放入列表中，批量创建。
Returns:
参见函数说明。
"""
if isinstance(dir_paths, str):
dir_paths = [dir_paths]
for dir in dir_paths:
dir_path = Path(dir)
dir_path.mkdir(parents=True, exist_ok=True)
if isinstance(dir_paths, list) and len(dir_paths) == 1:
dir_paths = dir_paths[0]
return dir_paths
def get_paths_from_dir(
dirs: Union[str, List[str]],
types: Optional[Union[str, List[str]]] = None,
recusive: bool = False,
) -> List[str]:
"""从指定目录下获取所有指定扩展名文件的路径。
Args:
dirs:
文件夹路径（绝对路径），单个用str表示，多个用list。
types:
指定文件的扩展名，单个用str表示，多个用list，默认为None，表示所有类型文件。
recusive:
默认为False，不递归子文件夹。
Returns:
List[str]:
文件路径字符串列表。
"""
if isinstance(dirs, str):
dirs = [dirs]
if types is not None:
if isinstance(types, str):
types = [types]
rule = "**/*." if recusive else "*."
else:
rule = "**/*" if recusive else "*"
types = [""]
result = []
for d in dirs:
path = Path(d).resolve()
for t in types:
res = path.glob(rule + t)
result.extend(list(res))
return [str(item) for item in result]
def file_writer(
lines: Union[str, Iterable[str]],
dir_path: Union[str, Path] = None,
file_name: str = None,
file_path: str = None,
separator: str = "\n",
encoding: str = "utf-8",
backup: bool = True,
) -> None:
"""向文件中写内容。
Parameters
----------
lines: Union[str, Iterable[str]]
可以是单个字符串或者字符串的列表。
dir_path: Union[str, Path]
文件目录的绝对路径。
file_name: str
文件名称，有默认值。
file_path: str
文件绝对路径，包括目录和文件名。
默认为None，由dir_path，file_name指定；如果不为None，则以这个为准。
separator: str
每一行末尾的分隔符，有默认值。
encoding: str
文件的编码格式，默认为utf-8。
backup: bool
如果为True，先备份，再写入文件；
如果为False，不备份，覆盖存在的文件。
如果为None，若文件存在，则不执行写入；若文件不存在，则会创建并写入文件。
"""
if file_path is not None:
tmp = file_path.split(os.path.sep)
dir_path = os.path.sep.join(tmp[:-1])
file_name = tmp[-1]
dir_path: Path = Path(dir_path) if isinstance(dir_path, str) else dir_path
if not dir_path.exists():
print(
"## Warning: The dir path you submit is not exist, "
+ "it will be created automatically."
)
dir_path.mkdir(parents=True, exist_ok=True)
file_path = dir_path / file_name
if backup is None:
if file_path.exists():
print(
"# Warning: The file you submit is already exist. So nothing will be done."
)
return
if backup:
if file_path.exists():
new_suffix = ".{}{}".format(
str(time.strftime("%Y%m%d_%H%M%S", time.localtime())),
file_path.suffix,
)
file_path.rename(file_path.with_suffix(new_suffix))
if isinstance(lines, str):
lines = [lines]
mode = "w+"
with open(file_path, mode=mode, encoding=encoding) as file:
for line in lines:
if separator != "":
file.write(f"{line}{separator}")
else:
file.write(line)
def read_txt_by_page(
file_path: str,
parse_func: Callable[[list], None],
page_size: int = 100,
encoding: str = "utf-8",
) -> None:
"""从文本文件中分页读取内容。
Args:
file_path:
文件路径。
parse_func:
每一页数据处理函数，必须定义。
page_size:
每一页数据量。
encoding:
文本文件的编码格式。
"""
with open(file=file_path, encoding=encoding, mode="r") as file:
data = list()
curr_page_id = 0
start_time = time.time()
total_time = 0.0
print("## read_txt_by_page is starting parse the data...")
for line in file:
data.append(line.strip())
if len(data) == page_size:
parse_func(data)
data.clear()
end_time = time.time()
cost_time = float(end_time - start_time)
total_time += cost_time
start_time = end_time
print(f"## -{curr_page_id}- page parsed done...{[cost_time]}s")
curr_page_id += 1
if len(data) > 0:
parse_func(data)
end_time = time.time()
cost_time = float(end_time - start_time)
total_time += cost_time
start_time = end_time
print(f"## -{curr_page_id}- page parsed done...{[cost_time]}s")
curr_page_id += 1
print(f"## All done. Total pages: {curr_page_id}. Elapsed time: {total_time}s")
def read_txt_by_page_asyncio(
file_path: str,
parse_func: Callable[[list], None],
page_size: int = 100,
encoding: str = "utf-8",
open_async: bool = False,
slave_num: int = 4,
) -> None:
"""从文本文件中分页读取内容，具备异步io处理功能。
Args:
file_path:
文件路径。
parse_func:
每一页数据处理函数，必须定义。
page_size:
每一页数据量。
encoding:
文本文件的编码格式。
open_async:
是否开启异步io处理数据，默认不开启。
slave_num:
执行任务的协程数目，默认为4。
"""
async def parse_(loop, chunk):
def run_func():
return parse_func(chunk)
await loop.run_in_executor(None, run_func)
with open(file=file_path, encoding=encoding, mode="r") as file:
data = list()
curr_page_id = 0
start_time = time.time()
total_time = 0.0
print("## read_txt_by_page is starting parse the data...")
for line in file:
data.append(line.strip())
if len(data) == page_size:
if open_async:
loop = asyncio.get_event_loop()
chunks = gb.chunks(data, slave_num)
loop.run_until_complete(
asyncio.gather(*[parse_(loop, chunk) for chunk in chunks])
)
chunks.clear()
else:
parse_func(data)
data.clear()
end_time = time.time()
cost_time = float(end_time - start_time)
total_time += cost_time
start_time = end_time
print(f"## -{curr_page_id}- page parsed done...{[cost_time]}s")
curr_page_id += 1
if len(data) > 0:
if open_async:
loop = asyncio.get_event_loop()
chunks = gb.chunks(data, slave_num)
loop.run_until_complete(
asyncio.gather(*[parse_(loop, chunk) for chunk in chunks])
)
chunks.clear()
else:
parse_func(data)
end_time = time.time()
cost_time = float(end_time - start_time)
total_time += cost_time
start_time = end_time
print(f"## -{curr_page_id}- page parsed done...{[cost_time]}s")
curr_page_id += 1
print(f"## All done.Total pages: {curr_page_id}.Cost time: {total_time}s")
def read_content(
file_path: Union[str, Path],
encoding: str = "utf-8",
) -> List[str]:
"""从文本文件中读取内容，将内容转换为list，list的元素为每行的字符串。
Args:
file_path:
文件路径。
encoding:
文件的编码方式。
Returns:
List[str]:
每行字符串组成的list。
"""
if isinstance(file_path, str):
file_path = Path(file_path)
lines = file_path.read_text(encoding=encoding).split("\n")
result = gb.remove_0_str([line.strip() for line in lines])
return result
def read_content1(
file_path: str,
encoding: str = "utf-8",
) -> List[str]:
"""从文本文件中读取内容，将内容转换为list，list的元素为每行的字符串。
当且仅当`read_content`函数报错时，例如`0xfa`错误时，再使用这个函数。\n
原因是这个函数比`read_content`函数更加稳定，但是更慢。
Parameters
----------
file_path : str
文件路径。
encoding : str
文件的编码方式。
Returns
-------
List[str] :
每行字符串组成的list。
"""
lines = []
with open(file_path, "rb") as file:
for line in file:
line = line.decode(encoding, "ignore").strip()
lines.append(line)
return lines
def read_contents(
file_pathes: List,
encoding: str = "utf-8",
) -> List[str]:
"""从[多个]文本文件中读取内容，将[所有]内容转换为list，list的元素为每行的字符串。
Args:
file_pathes:
文件路径列表。
encoding:
文件的编码方式。
Returns:
List[str]:
每行字符串组成的list。
"""
result = []
for path in file_pathes:
result.extend(read_content(path, encoding))
return result
def read_jsons(
file_path: Union[str, Path, List],
encoding: str = "utf-8",
) -> List[Dict]:
"""从存放json的文本文件中读取内容，并转化为dict组成的list。
Parameters
----------
file_path : str, Path or List
文件路径,可以是str或者Path,也可以是list,每个元素为str或者Path.
encoding : str
文件的编码方式。
Returns
-------
List[Dict]:
dict组成的list
"""
def get_lines(path):
if isinstance(path, str):
path = Path(path)
lines = []
with open(path, "r", encoding=encoding) as file:
for line in file:
line = line.strip()
if line:
lines.append(json.loads(line))
return lines
if not isinstance(file_path, List):
file_path = [file_path]
result = []
for path in file_path:
result.extend(get_lines(path))
return result
def read_jsons1(
file_path: Union[str, Path, List],
encoding: str = "utf-8",
) -> List[Dict]:
"""从存放json的文本文件中读取内容，并转化为dict组成的list。
Parameters
----------
file_path : str, Path or List
文件路径,可以是str或者Path,也可以是list,每个元素为str或者Path.
encoding : str
文件的编码方式。
Returns
-------
List[Dict]:
dict组成的list
"""
def get_lines(path):
lines = []
with open(path, "rb") as file:
for line in file:
line = line.decode(encoding, "ignore").strip()
if line:
lines.append(json.loads(line))
return lines
if not isinstance(file_path, List):
file_path = [file_path]
result = []
for path in file_path:
result.extend(get_lines(path))
return result
You can’t perform that action at this time.