Skip to content

list_files

List all files in a directory and its subdirectories.

Parameters:

Name Type Description Default
root_dir Path

The directory containing the files.

 required
extension str

The extension the files should have.

 ''

Returns:

Name Type Description
files list[str]

A list with absolute paths to the files.
Source code in src/library_analyzer/utils/_files.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def list_files(root_dir: Path, extension: str = "") -> list[str]:
    """
    List all files in a directory and its subdirectories.

    Parameters
    ----------
    root_dir: Path
        The directory containing the files.
    extension: str
        The extension the files should have.

    Returns
    -------
    files: list[str]
        A list with absolute paths to the files.
    """
    result: list[str] = []

    for root, _, files in os.walk(root_dir):
        for filename in files:
            if filename.endswith(extension):
                result.append(str(Path(root) / filename))

    return result