Source code for dioptra.sdk.utilities.paths.clear_dir

# This Software (Dioptra) is being made available as a public service by the
# National Institute of Standards and Technology (NIST), an Agency of the United
# States Department of Commerce. This software was developed in part by employees of
# NIST and in part by NIST contractors. Copyright in portions of this software that
# were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
# to Title 17 United States Code Section 105, works of NIST employees are not
# subject to copyright protection in the United States. However, NIST may hold
# international copyright in software created by its employees and domestic
# copyright (or licensing rights) in portions of software that were assigned or
# licensed to NIST. To the extent that NIST holds copyright in this software, it is
# being made available under the Creative Commons Attribution 4.0 International
# license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
# of the software developed or licensed by NIST.
#
# ACCESS THE FULL CC BY 4.0 LICENSE HERE:
# https://creativecommons.org/licenses/by/4.0/legalcode
import shutil
from pathlib import Path
from typing import Union


def clear_directory(dir_: Union[str, Path]):
    """
    Remove all subdirectories and files from the given directory.

    Args:
        dir_: A string or Path object referring to a directory
    """

    if isinstance(dir_, str):
        dir_ = Path(dir_)

    if dir_.is_dir():
        # Perhaps better to not modify the directory while you are iterating
        # over its entries?
        entries = list(dir_.iterdir())

        for entry in entries:
            if entry.is_dir():
                shutil.rmtree(entry)
            else:
                entry.unlink()