mindstudio-probe 1.0.1__py3-none-any.whl → 1.0.4__py3-none-any.whl

msprobe/pytorch/parse_tool/lib/utils.py

@@ -1,367 +1,316 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-# Copyright (C) 2022-2024. Huawei Technologies Co., Ltd. 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.
-"""
-import logging
-import os
-import io
-import re
-import sys
-import subprocess
-import hashlib
-import csv
-import time
-import numpy as np
-from collections import namedtuple
-from msprobe.pytorch.parse_tool.lib.config import Const
-from msprobe.pytorch.parse_tool.lib.file_desc import DumpDecodeFileDesc, FileDesc
-from msprobe.pytorch.parse_tool.lib.parse_exception import ParseException
-from msprobe.core.common.file_check import change_mode, check_other_user_writable,\
-    check_path_executable, check_path_owner_consistent
-from msprobe.core.common.const import FileCheckConst
-from msprobe.core.common.file_check import FileOpen
-from msprobe.core.common.utils import check_file_or_directory_path
-from msprobe.pytorch.common.log import logger
-
-
-try:
-    from rich.traceback import install
-    from rich.panel import Panel
-    from rich.table import Table
-    from rich import print as rich_print
-    from rich.columns import Columns
-
-    install()
-except ImportError as err:
-    install = None
-    Panel = None
-    Table = None
-    Columns = None
-    rich_print = None
-    logger.warning(
-        "Failed to import rich, Some features may not be available. Please run 'pip install rich' to fix it.")
-
-
-class Util:
-    def __init__(self):
-        self.ms_accu_cmp = None
-        logging.basicConfig(
-            level=Const.LOG_LEVEL,
-            format="%(asctime)s (%(process)d) -[%(levelname)s]%(message)s",
-            datefmt="%Y-%m-%d %H:%M:%S"
-        )
-        self.log = logging.getLogger()
-        self.python = sys.executable
-
-    @staticmethod
-    def print(content):
-        rich_print(content)
-
-    @staticmethod
-    def path_strip(path):
-        return path.strip("'").strip('"')
-
-    @staticmethod
-    def check_executable_file(path):
-        check_path_owner_consistent(path)
-        check_other_user_writable(path)
-        check_path_executable(path)
-
-    @staticmethod
-    def get_subdir_count(self, directory):
-        subdir_count = 0
-        for _, dirs, _ in os.walk(directory):
-            subdir_count += len(dirs)
-            break
-        return subdir_count
-
-    @staticmethod
-    def get_subfiles_count(self, directory):
-        file_count = 0
-        for _, _, files in os.walk(directory):
-            file_count += len(files)
-        return file_count
-
-    @staticmethod
-    def get_sorted_subdirectories_names(self, directory):
-        subdirectories = []
-        for item in os.listdir(directory):
-            item_path = os.path.join(directory, item)
-            if os.path.isdir(item_path):
-                subdirectories.append(item)
-        return sorted(subdirectories)
-
-    @staticmethod
-    def get_sorted_files_names(self, directory):
-        files = []
-        for item in os.listdir(directory):
-            item_path = os.path.join(directory, item)
-            if os.path.isfile(item_path):
-                files.append(item)
-        return sorted(files)
-
-    @staticmethod
-    def check_npy_files_valid_in_dir(self, dir_path):
-        for file_name in os.listdir(dir_path):
-            file_path = os.path.join(dir_path, file_name)
-            check_file_or_directory_path(file_path)
-            _, file_extension = os.path.splitext(file_path)
-            if not file_extension == '.npy':
-                return False
-        return True
-
-    @staticmethod
-    def get_md5_for_numpy(self, obj):
-        np_bytes = obj.tobytes()
-        md5_hash = hashlib.md5(np_bytes)
-        return md5_hash.hexdigest()
-
-    @staticmethod
-    def write_csv(self, data, filepath):
-        need_change_mode = False
-        if not os.path.exists(filepath):
-            need_change_mode = True
-        with FileOpen(filepath, 'a') as f:
-            writer = csv.writer(f)
-            writer.writerows(data)
-        if need_change_mode:
-            change_mode(filepath, FileCheckConst.DATA_FILE_AUTHORITY)
-
-    @staticmethod
-    def deal_with_dir_or_file_inconsistency(self, output_path):
-        if os.path.exists(output_path):
-            os.remove(output_path)
-        raise ParseException("Inconsistent directory structure or file.")
-
-    @staticmethod
-    def deal_with_value_if_has_zero(self, data):
-        if data.dtype in Const.FLOAT_TYPE:
-            zero_mask = (data == 0)
-            # 给0的地方加上eps防止除0
-            data[zero_mask] += np.finfo(data.dtype).eps
-        else:
-            # int type + float eps 会报错，所以这里要强转
-            data = data.astype(float)
-            zero_mask = (data == 0)
-            data[zero_mask] += np.finfo(float).eps
-        return data
-    
-    @staticmethod
-    def dir_contains_only(self, path, endfix):
-        for _, _, files in os.walk(path):
-            for file in files:
-                if not file.endswith(endfix):
-                    return False
-        return True
-    
-    @staticmethod
-    def localtime_str(self):
-        return time.strftime("%Y%m%d%H%M%S", time.localtime())
-    
-    @staticmethod
-    def change_filemode_safe(self, path):
-        change_mode(path, FileCheckConst.DATA_FILE_AUTHORITY)
-
-    @staticmethod
-    def _gen_npu_dump_convert_file_info(name, match, dir_path):
-        return DumpDecodeFileDesc(name, dir_path, int(match.groups()[-4]), op_name=match.group(2),
-                                  op_type=match.group(1), task_id=int(match.group(3)), anchor_type=match.groups()[-3],
-                                  anchor_idx=int(match.groups()[-2]))
-
-    @staticmethod
-    def _gen_numpy_file_info(name, math, dir_path):
-        return FileDesc(name, dir_path)
-
-    def execute_command(self, cmd):
-        if not cmd:
-            self.log.error("Commond is None")
-            return -1
-        self.log.debug("[RUN CMD]: %s", cmd)
-        cmd = cmd.split(" ")
-        complete_process = subprocess.run(cmd, shell=False)
-        return complete_process.returncode
-
-    def print_panel(self, content, title='', fit=True):
-        if not Panel:
-            self.print(content)
-            return
-        if fit:
-            self.print(Panel.fit(content, title=title))
-        else:
-            self.print(Panel(content, title=title))
-
-    def check_msaccucmp(self, target_file):
-        if os.path.split(target_file)[-1] != Const.MS_ACCU_CMP_FILE_NAME:
-            self.log.error(
-                "Check msaccucmp failed in dir %s. This is not a correct msaccucmp file" % target_file)
-            raise ParseException(ParseException.PARSE_MSACCUCMP_ERROR)
-        result = subprocess.run(
-            [self.python, target_file, "--help"], stdout=subprocess.PIPE)
-        if result.returncode == 0:
-            self.log.info("Check [%s] success.", target_file)
-        else:
-            self.log.error("Check msaccucmp failed in dir %s" % target_file)
-            self.log.error("Please specify a valid msaccucmp.py path or install the cann package")
-            raise ParseException(ParseException.PARSE_MSACCUCMP_ERROR)
-        return target_file
-
-    def create_dir(self, path):
-        path = self.path_strip(path)
-        if os.path.exists(path):
-            return
-        self.check_path_name(path)
-        try:
-            os.makedirs(path, mode=FileCheckConst.DATA_DIR_AUTHORITY)
-        except OSError as e:
-            self.log.error("Failed to create %s.", path)
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR) from e
-
-    def gen_npy_info_txt(self, source_data):
-        (shape, dtype, max_data, min_data, mean) = \
-            self.npy_info(source_data)
-        return \
-                '[Shape: %s] [Dtype: %s] [Max: %s] [Min: %s] [Mean: %s]' % (shape, dtype, max_data, min_data, mean)
-
-    def save_npy_to_txt(self, data, dst_file='', align=0):
-        if os.path.exists(dst_file):
-            self.log.info("Dst file %s exists, will not save new one.", dst_file)
-            return
-        shape = data.shape
-        data = data.flatten()
-        if align == 0:
-            align = 1 if len(shape) == 0 else shape[-1]
-        elif data.size % align != 0:
-            pad_array = np.zeros((align - data.size % align,))
-            data = np.append(data, pad_array)
-        np.savetxt(dst_file, data.reshape((-1, align)), delimiter=' ', fmt='%g')
-        change_mode(dst_file, FileCheckConst.DATA_FILE_AUTHORITY)
-
-    def list_convert_files(self, path, external_pattern=""):
-        return self.list_file_with_pattern(
-            path, Const.OFFLINE_DUMP_CONVERT_PATTERN, external_pattern, self._gen_npu_dump_convert_file_info
-        )
-
-    def list_numpy_files(self, path, extern_pattern=''):
-        return self.list_file_with_pattern(path, Const.NUMPY_PATTERN, extern_pattern,
-                                            self._gen_numpy_file_info)
-
-    def create_columns(self, content):
-        if not Columns:
-            self.log.error("No module named rich, please install it")
-            raise ParseException(ParseException.PARSE_NO_MODULE_ERROR)
-        return Columns(content)
-
-    def create_table(self, title, columns):
-        if not Table:
-            self.log.error("No module named rich, please install it and restart parse tool")
-            raise ParseException(ParseException.PARSE_NO_MODULE_ERROR)
-        table = Table(title=title)
-        for column_name in columns:
-            table.add_column(column_name, overflow='fold')
-        return table
-
-    def check_path_valid(self, path):
-        path = self.path_strip(path)
-        if not path or not os.path.exists(path):
-            self.log.error("The path %s does not exist." % path)
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        if os.path.islink(path):
-            self.log.error('The file path {} is a soft link.'.format(path))
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        if len(os.path.realpath(path)) > Const.DIRECTORY_LENGTH or len(os.path.basename(path)) > \
-                Const.FILE_NAME_LENGTH:
-            self.log.error('The file path length exceeds limit.')
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        if not re.match(Const.FILE_PATTERN, os.path.realpath(path)):
-            self.log.error('The file path {} contains special characters.'.format(path))
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        if os.path.isfile(path):
-            file_size = os.path.getsize(path)
-            if path.endswith(Const.PKL_SUFFIX) and file_size > Const.ONE_GB:
-                self.log.error('The file {} size is greater than 1GB.'.format(path))
-                raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-            if path.endswith(Const.NPY_SUFFIX) and file_size > Const.TEN_GB:
-                self.log.error('The file {} size is greater than 10GB.'.format(path))
-                raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        return True
-
-    def check_files_in_path(self, path):
-        if os.path.isdir(path) and len(os.listdir(path)) == 0:
-            self.log.error("No files in %s." % path)
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-
-    def npy_info(self, source_data):
-        if isinstance(source_data, np.ndarray):
-            data = source_data
-        else:
-            self.log.error("Invalid data, data is not ndarray")
-            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
-        if data.dtype == 'object':
-            self.log.error("Invalid data, data is object.")
-            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
-        if np.size(data) == 0:
-            self.log.error("Invalid data, data is empty")
-            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
-        npu_info_result = namedtuple('npu_info_result', ['shape', 'dtype', 'max', 'min', 'mean'])
-        res = npu_info_result(data.shape, data.dtype, data.max(), data.min(), data.mean())
-        return res
-
-    def list_file_with_pattern(self, path, pattern, extern_pattern, gen_info_func):
-        self.check_path_valid(path)
-        file_list = {}
-        re_pattern = re.compile(pattern)
-        for dir_path, _, file_names in os.walk(path, followlinks=True):
-            for name in file_names:
-                match = re_pattern.match(name)
-                if not match:
-                    continue
-                if extern_pattern != '' and not re.match(extern_pattern, name):
-                    continue
-                file_list[name] = gen_info_func(name, match, dir_path)
-        return file_list
-
-    def check_path_format(self, path, suffix):
-        if os.path.isfile(path):
-            if not path.endswith(suffix):
-                self.log.error("%s is not a %s file." % (path, suffix))
-                raise ParseException(ParseException.PARSE_INVALID_FILE_FORMAT_ERROR)
-        elif os.path.isdir(path):
-            self.log.error("Please specify a single file path")
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        else:
-            self.log.error("The file path %s is invalid" % path)
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-
-    def check_path_name(self, path):
-        if len(os.path.realpath(path)) > Const.DIRECTORY_LENGTH or len(os.path.basename(path)) > \
-                Const.FILE_NAME_LENGTH:
-            self.log.error('The file path length exceeds limit.')
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-        if not re.match(Const.FILE_PATTERN, os.path.realpath(path)):
-            self.log.error('The file path {} contains special characters.'.format(path))
-            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
-
-    def check_str_param(self, param):
-        if len(param) > Const.FILE_NAME_LENGTH:
-            self.log.error('The parameter length exceeds limit')
-            raise ParseException(ParseException.PARSE_INVALID_PARAM_ERROR)
-        if not re.match(Const.FILE_PATTERN, param):
-            self.log.error('The parameter {} contains special characters.'.format(param))
-            raise ParseException(ParseException.PARSE_INVALID_PARAM_ERROR)
-
-    def is_subdir_count_equal(self, dir1, dir2):
-        dir1_count = self.get_subdir_count(dir1)
-        dir2_count = self.get_subdir_count(dir2)
-        return dir1_count == dir2_count
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+# Copyright (C) 2022-2024. Huawei Technologies Co., Ltd. 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.
+"""
+import os
+import re
+import sys
+import subprocess
+import hashlib
+import time
+import numpy as np
+from collections import namedtuple
+from msprobe.pytorch.parse_tool.lib.config import Const
+from msprobe.pytorch.parse_tool.lib.file_desc import DumpDecodeFileDesc, FileDesc
+from msprobe.pytorch.parse_tool.lib.parse_exception import ParseException
+from msprobe.core.common.file_utils import change_mode, check_other_user_writable,\
+    check_path_executable, check_path_owner_consistent
+from msprobe.core.common.const import FileCheckConst
+from msprobe.core.common.file_utils import FileChecker, check_file_or_directory_path, remove_path
+from msprobe.pytorch.common.log import logger
+
+
+try:
+    from rich.traceback import install
+    from rich.panel import Panel
+    from rich.table import Table
+    from rich import print as rich_print
+    from rich.columns import Columns
+
+    install()
+except ImportError as err:
+    install = None
+    Panel = None
+    Table = None
+    Columns = None
+    rich_print = None
+    logger.warning(
+        "Failed to import rich, Some features may not be available. Please run 'pip install rich' to fix it.")
+
+
+class Util:
+    def __init__(self):
+        self.ms_accu_cmp = None
+        self.log = logger
+        self.python = sys.executable
+
+    @staticmethod
+    def print(content):
+        rich_print(content)
+
+    @staticmethod
+    def path_strip(path):
+        return path.strip("'").strip('"')
+
+    @staticmethod
+    def check_executable_file(path):
+        check_path_owner_consistent(path)
+        check_other_user_writable(path)
+        check_path_executable(path)
+
+    @staticmethod
+    def get_subdir_count(self, directory):
+        subdir_count = 0
+        path_checker = FileChecker(directory)
+        path_checker.common_check()
+        for _, dirs, _ in os.walk(directory):
+            subdir_count += len(dirs)
+            break
+        return subdir_count
+
+    @staticmethod
+    def get_subfiles_count(self, directory):
+        file_count = 0
+        for root, _, files in os.walk(directory, topdown=True):
+            path_checker = FileChecker(root)
+            path_checker.common_check()
+            file_count += len(files)
+            path_depth = root.count(os.sep)
+            if path_depth <= Const.MAX_TRAVERSAL_DEPTH:
+                yield root, _, files
+            else:
+                _[:] = []
+        return file_count
+
+    @staticmethod
+    def get_sorted_subdirectories_names(self, directory):
+        subdirectories = []
+        for item in os.listdir(directory):
+            item_path = os.path.join(directory, item)
+            if os.path.isdir(item_path):
+                subdirectories.append(item)
+        return sorted(subdirectories)
+
+    @staticmethod
+    def get_sorted_files_names(self, directory):
+        files = []
+        for item in os.listdir(directory):
+            item_path = os.path.join(directory, item)
+            if os.path.isfile(item_path):
+                files.append(item)
+        return sorted(files)
+
+    @staticmethod
+    def check_npy_files_valid_in_dir(self, dir_path):
+        for file_name in os.listdir(dir_path):
+            file_path = os.path.join(dir_path, file_name)
+            check_file_or_directory_path(file_path)
+            _, file_extension = os.path.splitext(file_path)
+            if not file_extension == '.npy':
+                return False
+        return True
+
+    @staticmethod
+    def get_md5_for_numpy(self, obj):
+        np_bytes = obj.tobytes()
+        md5_hash = hashlib.md5(np_bytes)
+        return md5_hash.hexdigest()
+
+    @staticmethod
+    def deal_with_dir_or_file_inconsistency(self, output_path):
+        remove_path(output_path)
+        raise ParseException("Inconsistent directory structure or file.")
+
+    @staticmethod
+    def deal_with_value_if_has_zero(self, data):
+        if data.dtype in Const.FLOAT_TYPE:
+            zero_mask = (data == 0)
+            # 给0的地方加上eps防止除0
+            data[zero_mask] += np.finfo(data.dtype).eps
+        else:
+            # int type + float eps 会报错，所以这里要强转
+            data = data.astype(float)
+            zero_mask = (data == 0)
+            data[zero_mask] += np.finfo(float).eps
+        return data
+    
+    @staticmethod
+    def dir_contains_only(self, path, endfix):
+        for root, _, files in os.walk(path, topdown=True):
+            path_checker = FileChecker(root)
+            path_checker.common_check()
+            for file in files:
+                if not file.endswith(endfix):
+                    return False
+            path_depth = root.count(os.sep)
+            if path_depth <= Const.MAX_TRAVERSAL_DEPTH:
+                yield root, _, files
+            else:
+                _[:] = []
+        return True
+    
+    @staticmethod
+    def localtime_str(self):
+        return time.strftime("%Y%m%d%H%M%S", time.localtime())
+    
+    @staticmethod
+    def change_filemode_safe(self, path):
+        change_mode(path, FileCheckConst.DATA_FILE_AUTHORITY)
+
+    @staticmethod
+    def _gen_npu_dump_convert_file_info(name, match, dir_path):
+        return DumpDecodeFileDesc(name, dir_path, int(match.groups()[-4]), op_name=match.group(2),
+                                  op_type=match.group(1), task_id=int(match.group(3)), anchor_type=match.groups()[-3],
+                                  anchor_idx=int(match.groups()[-2]))
+
+    @staticmethod
+    def _gen_numpy_file_info(name, math, dir_path):
+        return FileDesc(name, dir_path)
+
+    def execute_command(self, cmd):
+        if not cmd:
+            self.log.error("Commond is None")
+            return -1
+        self.log.info("[RUN CMD]: %s", cmd)
+        cmd = cmd.split(" ")
+        complete_process = subprocess.run(cmd, shell=False)
+        return complete_process.returncode
+
+    def print_panel(self, content, title='', fit=True):
+        if not Panel:
+            self.print(content)
+            return
+        if fit:
+            self.print(Panel.fit(content, title=title))
+        else:
+            self.print(Panel(content, title=title))
+
+    def check_msaccucmp(self, target_file):
+        if os.path.split(target_file)[-1] != Const.MS_ACCU_CMP_FILE_NAME:
+            self.log.error(
+                "Check msaccucmp failed in dir %s. This is not a correct msaccucmp file" % target_file)
+            raise ParseException(ParseException.PARSE_MSACCUCMP_ERROR)
+        result = subprocess.run(
+            [self.python, target_file, "--help"], stdout=subprocess.PIPE, shell=False)
+        if result.returncode == 0:
+            self.log.info("Check [%s] success.", target_file)
+        else:
+            self.log.error("Check msaccucmp failed in dir %s" % target_file)
+            self.log.error("Please specify a valid msaccucmp.py path or install the cann package")
+            raise ParseException(ParseException.PARSE_MSACCUCMP_ERROR)
+        return target_file
+
+    def gen_npy_info_txt(self, source_data):
+        (shape, dtype, max_data, min_data, mean) = \
+            self.npy_info(source_data)
+        return \
+                '[Shape: %s] [Dtype: %s] [Max: %s] [Min: %s] [Mean: %s]' % (shape, dtype, max_data, min_data, mean)
+
+    def list_convert_files(self, path, external_pattern=""):
+        return self.list_file_with_pattern(
+            path, Const.OFFLINE_DUMP_CONVERT_PATTERN, external_pattern, self._gen_npu_dump_convert_file_info
+        )
+
+    def list_numpy_files(self, path, extern_pattern=''):
+        return self.list_file_with_pattern(path, Const.NUMPY_PATTERN, extern_pattern,
+                                            self._gen_numpy_file_info)
+
+    def create_columns(self, content):
+        if not Columns:
+            self.log.error("No module named rich, please install it")
+            raise ParseException(ParseException.PARSE_NO_MODULE_ERROR)
+        return Columns(content)
+
+    def create_table(self, title, columns):
+        if not Table:
+            self.log.error("No module named rich, please install it and restart parse tool")
+            raise ParseException(ParseException.PARSE_NO_MODULE_ERROR)
+        table = Table(title=title)
+        for column_name in columns:
+            table.add_column(column_name, overflow='fold')
+        return table
+
+    def check_path_valid(self, path):
+        path = self.path_strip(path)
+        path_checker = FileChecker(path)
+        path_checker.common_check()
+        return True
+
+    def check_files_in_path(self, path):
+        if os.path.isdir(path) and len(os.listdir(path)) == 0:
+            self.log.error("No files in %s." % path)
+            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
+
+    def npy_info(self, source_data):
+        if isinstance(source_data, np.ndarray):
+            data = source_data
+        else:
+            self.log.error("Invalid data, data is not ndarray")
+            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
+        if data.dtype == 'object':
+            self.log.error("Invalid data, data is object.")
+            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
+        if np.size(data) == 0:
+            self.log.error("Invalid data, data is empty")
+            raise ParseException(ParseException.PARSE_INVALID_DATA_ERROR)
+        npu_info_result = namedtuple('npu_info_result', ['shape', 'dtype', 'max', 'min', 'mean'])
+        res = npu_info_result(data.shape, data.dtype, data.max(), data.min(), data.mean())
+        return res
+
+    def list_file_with_pattern(self, path, pattern, extern_pattern, gen_info_func):
+        self.check_path_valid(path)
+        file_list = {}
+        re_pattern = re.compile(pattern)
+        for dir_path, _, file_names in os.walk(path, topdown=True):
+            path_checker = FileChecker(dir)
+            path_checker.common_check()
+            for name in file_names:
+                match = re_pattern.match(name)
+                if not match:
+                    continue
+                if extern_pattern != '' and re_pattern.match(extern_pattern) and not re.match(extern_pattern, name):
+                    continue
+                file_list[name] = gen_info_func(name, match, dir_path)
+            path_depth = dir_path.count(os.sep)
+            if path_depth <= Const.MAX_TRAVERSAL_DEPTH:
+                yield dir_path, _, file_names
+            else:
+                _[:] = []
+        return file_list
+
+    def check_file_path_format(self, path, suffix):
+        if os.path.isfile(path):
+            if not path.endswith(suffix):
+                self.log.error("%s is not a %s file." % (path, suffix))
+                raise ParseException(ParseException.PARSE_INVALID_FILE_FORMAT_ERROR)
+        elif os.path.isdir(path):
+            self.log.error("Please specify a single file path")
+            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
+        else:
+            self.log.error("The file path %s is invalid" % path)
+            raise ParseException(ParseException.PARSE_INVALID_PATH_ERROR)
+
+    def check_str_param(self, param):
+        if len(param) > Const.FILE_NAME_LENGTH:
+            self.log.error('The parameter length exceeds limit')
+            raise ParseException(ParseException.PARSE_INVALID_PARAM_ERROR)
+        if not re.match(Const.FILE_PATTERN, param):
+            self.log.error('The parameter {} contains special characters.'.format(param))
+            raise ParseException(ParseException.PARSE_INVALID_PARAM_ERROR)
+
+    def is_subdir_count_equal(self, dir1, dir2):
+        dir1_count = self.get_subdir_count(dir1)
+        dir2_count = self.get_subdir_count(dir2)
+        return dir1_count == dir2_count