Python Recursively Remove Empty Directories

remove_empty_folders.py

#! /usr/bin/env python
"""
Module to remove empty folders recursively. Can be used as standalone script or be imported into existing script.
"""

import os
import argparse
import pathlib
import asyncio
import logging
from functools import lru_cache


def get_args():
    """get_args display CLI to user and gets options
    Returns:
        Namespace: object-
    """
    parser = argparse.ArgumentParser(
        description="Recursively removes empty directories."
    )
    parser.add_argument(
        "root_path",
        type=pathlib.Path,
        help="path to begin search from",
    )
    parser.add_argument(
        "-n",
        "--name",
        help=("remove root"),
    )

    return parser.parse_args()


@lru_cache
async def remove_empty_folders(_path, remove_root=True):
    """remove_empty_folders removes empty folders recursively

    Args:
        _path (Path): root path
        remove_root (bool, optional): True to remove the root path. Defaults to True.
    """
    if not os.path.isdir(_path):
        return

    # remove empty subfolders
    files = os.listdir(_path)
    if len(files):
        search = set(
            os.path.join(_path, _file)
            for _file in files
            if os.path.isdir(os.path.join(_path, _file))
        )
        await asyncio.gather(
            *(remove_empty_folders(item) for item in search), return_exceptions=True
        )

    # if folder empty, delete it
    files = os.listdir(_path)
    if len(files) == 0 and remove_root:
        print("Removing empty folder: {_path}")
        logging.info("Removing empty folder: %s", _path)
        # os.rmdir(_path)


async def main(root_path):
    """Main execution"""
    await remove_empty_folders(root_path, False)


if __name__ == "__main__":
    import timeit

    args = get_args()
    starttime = timeit.default_timer()
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main(args.root_path))
    logging.debug("The time difference is :%s", timeit.default_timer() - starttime)