utility function to recursively detect file names by pattern

file_matcher.py

import re
from typing import List
from pathlib import Path


def match_files(root: Path, pattern, exclude_items: List[str]) -> List[Path]:
	"""
	utility function to recursively detect file names by pattern.

	>>> match_files(Path.cwd(), re.compile('.*?\.py'), ['__pycache__'])

	:param root: initial dir from where files are recursively discovered
	:param pattern: compiled regex pattern to which file name should be matched
	:param exclude_items: list of file / dir names to be excluded
	:return: list of files detected
	"""

	files = list()

	for item in root.iterdir():
		if item.name in exclude_items:
			continue
		elif item.is_file() and pattern.match(item.name):
			files.append(item)
		elif item.is_dir():
			files.extend(match_files(item, pattern, exclude_items))

	return files