-
Notifications
You must be signed in to change notification settings - Fork 5.7k
/
Copy pathfs.py
1703 lines (1286 loc) · 50.2 KB
/
fs.py
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
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) 2020 PaddlePaddle 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.
# type: ignore[abstract]
from __future__ import annotations
import abc
import functools
import multiprocessing
import os
import re
import shutil
import subprocess
import time
from typing import TYPE_CHECKING, Callable, Literal, TypedDict, TypeVar
# (TODO: GhostScreaming) It will be removed later.
from paddle.base import core
from .log_util import logger
if TYPE_CHECKING:
from typing_extensions import ParamSpec
_InputT = ParamSpec("_InputT")
_RetT = TypeVar("_RetT")
_HDFSClientConfig = TypedDict(
'_HDFSClientConfig', {'fs.default.name': str, 'hadoop.job.ugi': str}
)
class _FileInfo(TypedDict):
path: str
size: int
__all__ = []
class ExecuteError(Exception):
pass
class FSFileExistsError(Exception):
pass
class FSFileNotExistsError(Exception):
pass
class FSTimeOut(Exception):
pass
class FSShellCmdAborted(ExecuteError):
pass
class FS:
@abc.abstractmethod
def ls_dir(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def is_file(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def is_dir(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def is_exist(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def upload(self, local_path, fs_path):
raise NotImplementedError
@abc.abstractmethod
def download(self, fs_path, local_path):
raise NotImplementedError
@abc.abstractmethod
def mkdirs(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def delete(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def need_upload_download(self):
raise NotImplementedError
@abc.abstractmethod
def rename(self, fs_src_path, fs_dst_path):
raise NotImplementedError
@abc.abstractmethod
def mv(self, fs_src_path, fs_dst_path, overwrite=False, test_exists=False):
raise NotImplementedError
@abc.abstractmethod
def upload_dir(self, local_dir, dest_dir):
raise NotImplementedError
@abc.abstractmethod
def list_dirs(self, fs_path):
raise NotImplementedError
@abc.abstractmethod
def touch(self, fs_path, exist_ok=True):
raise NotImplementedError
@abc.abstractmethod
def cat(self, fs_path=None):
raise NotImplementedError
class LocalFS(FS):
"""
A tool of local file system.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> subdirs, files = client.ls_dir("./")
"""
def ls_dir(self, fs_path: str) -> tuple[list[str], list[str]]:
"""
List directories and files under `fs_path` .
Args:
fs_path(str): The local file path.
Returns:
Tuple: Return a 2-tuple, the first is a list of all its subdirectories,
and the second is a list of all its subfiles, e.g. ([subdirname1, subdirname1, ...], [filename1, filename2, ...]).
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> subdirs, files = client.ls_dir("./")
"""
if not self.is_exist(fs_path):
return [], []
dirs = []
files = []
for f in os.listdir(fs_path):
if os.path.isdir(fs_path + "/" + f):
dirs.append(f)
else:
files.append(f)
return dirs, files
def mkdirs(self, fs_path: str) -> None:
"""
Create a local directory.
Args:
fs_path(str): The local directory path.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.mkdirs("test_mkdirs")
>>> client.delete("test_mkdirs")
"""
assert not os.path.isfile(fs_path), f"{fs_path} is already a file"
os.makedirs(fs_path, exist_ok=True)
def rename(self, fs_src_path: str, fs_dst_path: str) -> None:
"""
Rename the file.
Args:
fs_src_path(str): The actual name of the file or directory
fs_dst_path(str): The new name of the file or directory.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.touch("test_rename_src")
>>> print(client.is_exist("test_rename_src"))
True
>>> client.rename("test_rename_src", "test_rename_dst")
>>> print(client.is_exist("test_rename_src"))
False
>>> print(client.is_exist("test_rename_dst"))
True
>>> client.delete("test_rename_dst")
"""
os.rename(fs_src_path, fs_dst_path)
def _rmr(self, fs_path):
shutil.rmtree(fs_path)
def _rm(self, fs_path):
os.remove(fs_path)
def delete(self, fs_path: str) -> None:
"""
Delete the local file path, whether it's a file or directory.
Args:
fs_path(str): The local file path.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.mkdirs("test_localFS_mkdirs")
>>> client.delete("test_localFS_mkdirs")
"""
if not self.is_exist(fs_path):
return
if os.path.isfile(fs_path):
return self._rm(fs_path)
return self._rmr(fs_path)
def need_upload_download(self) -> Literal[False]:
return False
def is_file(self, fs_path: str) -> bool:
"""
Whether the local file path is a file.
Args:
fs_path(str): The local file path.
Returns:
Bool: Return true if the path exists and it's a file, otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.touch("test_is_file")
>>> print(client.is_file("test_is_file"))
True
>>> client.delete("test_is_file")
"""
return os.path.isfile(fs_path)
def is_dir(self, fs_path: str) -> bool:
"""
Whether the local file path is a directory.
Args:
fs_path(str): The local file path.
Returns:
Bool: Return true if the path exists and it's a directory, otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.mkdirs("test_is_dir")
>>> print(client.is_dir("test_is_dir"))
True
>>> client.delete("test_is_dir")
"""
return os.path.isdir(fs_path)
def is_exist(self, fs_path: str) -> bool:
"""
Whether the local file path exists.
Args:
fs_path(str): The local file path.
Returns:
Bool: Whether it's a file or directory, return true if the path exists,
otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> local_fs = LocalFS()
>>> ret = local_fs.is_exist("test_is_exist")
"""
return os.path.exists(fs_path)
def touch(self, fs_path: str, exist_ok: bool = True) -> None:
"""
Create a local file.
Args:
fs_path(str): The local file path.
exist_ok(bool): When `fs_path` exists, if `exist_ok` is set false,
program will throw an Exception. Default is true.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.touch("test_touch")
>>> client.delete("test_touch")
"""
if self.is_exist(fs_path):
if exist_ok:
return
raise FSFileExistsError
with open(fs_path, 'a'):
pass
def mv(
self,
src_path: str,
dst_path: str,
overwrite: bool = False,
test_exists: bool = False,
) -> None:
"""
Move a local file or directory from `src_path` to `dst_path` .
Args:
src_path(str): Name of the file or directory, that's needed to be moved.
dst_path(str): Name of the file or directory to which to move to.
overwrite(bool): Whether to re-write `dst_path` if that exists. Default is False.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> client.touch("test_mv_src")
>>> client.mv("test_mv_src", "test_mv_dst")
>>> client.delete("test_mv_dst")
"""
if not self.is_exist(src_path):
raise FSFileNotExistsError
if overwrite and self.is_exist(dst_path):
self.delete(dst_path)
if self.is_exist(dst_path):
raise FSFileExistsError
return self.rename(src_path, dst_path)
def list_dirs(self, fs_path: str) -> list[str]:
"""
Only list directories under `fs_path` .
Args:
fs_path(str): The local file path.
Returns:
List: A list of all its subdirectories, e.g. [subdirname1, subdirname1, ...].
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import LocalFS
>>> client = LocalFS()
>>> subdirs = client.list_dirs("./")
"""
if not self.is_exist(fs_path):
return []
dirs = [
f for f in os.listdir(fs_path) if os.path.isdir(fs_path + "/" + f)
]
return dirs
def _handle_errors(
max_time_out: float | None = None,
) -> Callable[[Callable[_InputT, _RetT]], Callable[_InputT, _RetT]]:
def decorator(f: Callable[_InputT, _RetT]) -> Callable[_InputT, _RetT]:
@functools.wraps(f)
def handler(*args: _InputT.args, **kwargs: _InputT.kwargs) -> _RetT:
o = args[0]
time_out = max_time_out
if time_out is None:
time_out = float(o._time_out) / 1000.0
else:
time_out /= 1000.0
inter = float(o._sleep_inter) / 1000.0
start = time.time()
last_print_time = start
while True:
try:
return f(*args, **kwargs)
# important: only ExecuteError need to retry
except ExecuteError as e:
if time.time() - start >= time_out:
raise FSTimeOut(
f"args:{args} timeout:{time.time() - start}"
)
time.sleep(inter)
if time.time() - last_print_time > 30:
print(
f"hadoop operator timeout:args:{args} timeout:{time.time() - start}"
)
last_print_time = time.time()
return handler
return decorator
class HDFSClient(FS):
"""
A tool of HDFS.
Args:
hadoop_home(str): Hadoop home.
configs(dict): Hadoop config. It is a dictionary and needs to contain the
keys: "fs.default.name" and "hadoop.job.ugi".
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> client.ls_dir("hdfs:/test_hdfs_client")
([], [])
"""
pre_commands: list[str]
def __init__(
self,
hadoop_home: str,
configs: _HDFSClientConfig,
time_out: int = 5 * 60 * 1000, # ms
sleep_inter: int = 1000,
) -> None: # ms
self.pre_commands = []
hadoop_bin = f'{hadoop_home}/bin/hadoop'
self.pre_commands.append(hadoop_bin)
dfs = 'fs'
self.pre_commands.append(dfs)
if configs:
for k, v in configs.items():
config_command = f'-D{k}={v}'
self.pre_commands.append(config_command)
self._time_out = time_out
self._sleep_inter = sleep_inter
self._base_cmd = " ".join(self.pre_commands)
self._bd_err_re = re.compile(
r'\s?responseErrorMsg\s?\:.*, errorCode\:\s?[0-9]+, path\:'
)
def _run_cmd(self, cmd, redirect_stderr=False, retry_times=5):
exe_cmd = f"{self._base_cmd} -{cmd}"
ret = 0
output = None
retry_sleep_second = 3
for x in range(retry_times + 1):
ret, output = core.shell_execute_cmd(exe_cmd, 0, 0, redirect_stderr)
ret = int(ret)
if ret == 0:
break
time.sleep(retry_sleep_second)
if ret == 134:
raise FSShellCmdAborted(cmd)
return ret, output.splitlines()
def _run_safe_cmd(self, cmd, redirect_stderr=False, retry_times=5):
exe_cmd = [self._base_cmd, *cmd.split()]
ret = 0
output = ""
retry_sleep_second = 3
for x in range(retry_times + 1):
try:
process = subprocess.run(
exe_cmd,
check=True,
stdout=subprocess.PIPE,
stderr=(
subprocess.STDOUT
if redirect_stderr
else subprocess.PIPE
),
text=True,
)
output = process.stdout
break
except subprocess.CalledProcessError as e:
ret = e.returncode
output = e.output
time.sleep(retry_sleep_second)
except Exception as e:
break
if ret == 134:
raise FSShellCmdAborted(cmd)
@_handle_errors()
def list_dirs(self, fs_path: str) -> list[str]:
"""
Only list directories under `fs_path` .
Args:
fs_path(str): The HDFS file path.
Returns:
List: A list of all its subdirectories, e.g. [subdirname1, subdirname1, ...].
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> subdirs = client.list_dirs("hdfs:/test_hdfs_client")
"""
if not self.is_exist(fs_path):
return []
dirs, files = self._ls_dir(fs_path)
return dirs
@_handle_errors()
def ls_dir(self, fs_path: str) -> tuple[list[str], list[str]]:
"""
List directories and files under `fs_path` .
Args:
fs_path(str): The HDFS file path.
Returns:
Tuple: Return a 2-tuple, the first element is the list of all its subdirectories,
and the second one is the list of all its subfiles, e.g. ([subdirname1, subdirname1, ...], [filename1, filename2, ...]).
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> subdirs, files = client.ls_dir("hdfs:/test_hdfs_client")
"""
if not self.is_exist(fs_path):
return [], []
return self._ls_dir(fs_path)
def _ls_dir(self, fs_path):
cmd = f"ls {fs_path}"
ret, lines = self._run_cmd(cmd)
if ret != 0:
raise ExecuteError(cmd)
dirs = []
files = []
for line in lines:
arr = line.split()
if len(arr) != 8:
continue
p = os.path.basename(arr[7])
if arr[0][0] == 'd':
dirs.append(p)
else:
files.append(p)
return dirs, files
def _test_match(self, lines):
for l in lines:
m = self._bd_err_re.match(l)
if m is not None:
return m
return None
@_handle_errors()
def is_dir(self, fs_path: str) -> bool:
"""
Whether the remote HDFS path is a directory.
Args:
fs_path(str): The HDFS file path.
Returns:
Bool: Return true if the path exists and it's a directory, otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> ret = client.is_file("hdfs:/test_hdfs_client")
"""
if not self.is_exist(fs_path):
return False
return self._is_dir(fs_path)
def _is_dir(self, fs_path):
cmd = f"test -d {fs_path}"
ret, lines = self._run_cmd(cmd, redirect_stderr=True, retry_times=1)
if ret:
# other error
if self._test_match(lines):
print('raise exception: ')
print('\n'.join(lines))
raise ExecuteError(cmd)
return False
return True
def is_file(self, fs_path: str) -> bool:
"""
Whether the remote HDFS path is a file.
Args:
fs_path(str): The HDFS file path.
Returns:
Bool: Return true if the path exists and it's a file, otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> ret = client.is_file("hdfs:/test_hdfs_client")
"""
if not self.is_exist(fs_path):
return False
return not self._is_dir(fs_path)
@_handle_errors()
def is_exist(self, fs_path: str) -> bool:
"""
Whether the remote HDFS path exists.
Args:
fs_path(str): The hdfs file path.
Returns:
Bool: Whether it's is file or directory, return true if the path exists,
otherwise return false.
Examples:
.. code-block:: python
>>> # doctest: +REQUIRES(env:DISTRIBUTED)
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> ret = client.is_exist("hdfs:/test_hdfs_client")
"""
cmd = f"test -e {fs_path} "
ret, out = self._run_cmd(cmd, redirect_stderr=True, retry_times=1)
if ret != 0:
return False
return True
def upload_dir(
self, local_dir: str, dest_dir: str, overwrite: bool = False
) -> None:
"""
upload dir to hdfs
Args:
local_dir(str): local dir
dest_dir(str): hdfs dest dir
overwrite(bool): is overwrite
Returns:
return code
"""
local_dir = local_dir.rstrip("/")
dest_dir = dest_dir.rstrip("/")
local_basename = os.path.basename(local_dir)
if self.is_exist(dest_dir + "/" + local_basename) and overwrite:
self.delete(dest_dir + "/" + local_basename)
if not self.is_exist(dest_dir):
self.mkdirs(dest_dir)
self._try_upload(local_dir, dest_dir)
# can't retry
def upload(
self,
local_path: str,
fs_path: str,
multi_processes: int = 5,
overwrite: bool = False,
) -> None:
"""
Upload the local path to remote HDFS.
Args:
local_path(str): The local path.
fs_path(str): The HDFS path.
multi_processes(int|1): the upload data process at the same time, default=5
overwrite(bool|False): will overwrite file on HDFS or not
Examples:
.. code-block:: python
>>> # doctest: +SKIP('depend on external file')
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> client.upload("test_hdfs_client", "hdfs:/test_hdfs_client")
"""
def __subprocess_upload(hdfs_path_single, datas):
for data in datas:
self._try_upload(data, hdfs_path_single)
def get_local_files(path):
"""
get local files
Args:
path(str): local path
Returns:
list of local files
"""
rlist = []
if not os.path.exists(path):
return rlist
if os.path.isdir(path):
for file in os.listdir(path):
t = os.path.join(path, file)
rlist.append(t)
else:
rlist.append(path)
return rlist
local = LocalFS()
if not local.is_exist(local_path):
raise FSFileNotExistsError(f"{local_path} not exists")
all_files = get_local_files(local_path)
if not all_files:
print("there are nothing need to upload, function exit")
return
if self.is_exist(fs_path) and overwrite:
self.delete(fs_path)
self.mkdirs(fs_path)
procs = []
for i in range(multi_processes):
process_datas = self._split_files(all_files, i, multi_processes)
p = multiprocessing.Process(
target=__subprocess_upload, args=(fs_path, process_datas)
)
procs.append(p)
p.start()
# complete the processes
for proc in procs:
proc.join()
@_handle_errors()
def _try_upload(self, local_path, fs_path):
cmd = f"put {local_path} {fs_path}"
ret = 0
try:
ret, _ = self._run_cmd(cmd)
if ret != 0:
raise ExecuteError(cmd)
except Exception as e:
self.delete(fs_path)
raise e
# can't retry
def download(
self,
fs_path: str,
local_path: str,
multi_processes: int = 5,
overwrite: bool = False,
) -> None:
"""
Download remote HDFS path to the local.
Args:
fs_path(str): The HDFS path.
local_path(str): The local path.
multi_processes(int|1): the download data process at the same time, default=1
overwrite(bool): is overwrite
Examples:
.. code-block:: python
>>> # doctest: +SKIP('depend on external file')
>>> from paddle.distributed.fleet.utils import HDFSClient
>>> hadoop_home = "/home/client/hadoop-client/hadoop/"
>>> configs = {
... "fs.default.name": "hdfs://xxx.hadoop.com:54310",
... "hadoop.job.ugi": "hello,hello123"
... }
>>> client = HDFSClient(hadoop_home, configs)
>>> client.download("hdfs:/test_hdfs_client", "./")
"""
def __subprocess_download(local_path, datas):
"""
download file from HDFS
Args:
local_path(str): the local file path
datas(str): the hdfs file path list
"""
for data in datas:
self._try_download(data, local_path)
if not self.is_exist(fs_path):
raise FSFileNotExistsError(f"{fs_path} not exits")
# download file
if self.is_file(fs_path):
return self._try_download(fs_path, local_path)
# download dir
dirs, all_filenames = self.ls_dir(fs_path)
all_files = [fs_path + "/" + i for i in all_filenames]
all_files.extend([fs_path + "/" + i for i in dirs])
procs = []
for i in range(multi_processes):
process_datas = self._split_files(all_files, i, multi_processes)
p = multiprocessing.Process(
target=__subprocess_download, args=(local_path, process_datas)
)
procs.append(p)
p.start()
# complete the processes
for proc in procs:
proc.join()
@_handle_errors()
def _try_download(self, fs_path, local_path):
cmd = f"get {fs_path} {local_path}"
ret = 0
try:
ret, _ = self._run_cmd(cmd)
if ret != 0:
raise ExecuteError(cmd)
except Exception as e:
local_fs = LocalFS()
local_fs.delete(local_path)
raise e
@_handle_errors()
def mkdirs(self, fs_path: str) -> None:
"""
Create a remote HDFS directory.
Args:
fs_path(str): The HDFS directory path.
Examples:
.. code-block:: python
>>> # doctest: +SKIP('depend on external file')
>>> from paddle.distributed.fleet.utils import HDFSClient