File utils

Utilities for file name based operations.

get_directory_path(path)

Add '/' to the end of the path of a directory.

Parameters:

Name	Type	Description	Default
path	str	directory to be processed	required

Returns:

Type	Description
str	Directory path stripped and with '/' at the end.

Source code in mkdocs/lakehouse_engine/packages/utils/file_utils.py

def get_directory_path(path: str) -> str:
    """Add '/' to the end of the path of a directory.

    Args:
        path: directory to be processed

    Returns:
        Directory path stripped and with '/' at the end.
    """
    path = path.strip()
    return path if path[-1] == "/" else path + "/"

get_file_names_without_file_type(path, file_type, exclude_regex)

Function to retrieve list of file names in a folder.

This function filters by file type and removes the extension of the file name it returns.

Parameters:

Name	Type	Description	Default
path	str	path to the folder to list files	required
file_type	str	type of the file to include in list	required
exclude_regex	str	regex of file names to exclude	required

Returns:

Type	Description
list	A list of file names without file type.

Source code in mkdocs/lakehouse_engine/packages/utils/file_utils.py

def get_file_names_without_file_type(
    path: str, file_type: str, exclude_regex: str
) -> list:
    """Function to retrieve list of file names in a folder.

    This function filters by file type and removes the extension of the file name
    it returns.

    Args:
        path: path to the folder to list files
        file_type: type of the file to include in list
        exclude_regex: regex of file names to exclude

    Returns:
        A list of file names without file type.
    """
    file_list: List[str] = []

    for file in listdir(path):
        if not re.search(exclude_regex, file) and file.endswith(file_type):
            file_list.append(file.split(".")[0])

    return file_list