Skip to content

clear_data_home

yohou.datasets._fetchers.clear_data_home(data_home=None)

Delete all the content of the data home cache.

Parameters

Name Type Description Default
data_home str, PathLike, or None

The path to the data directory. If None, the default path is ~/yohou_data.

 None

See Also

Source Code

View on GitHub

Show/Hide source 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def clear_data_home(data_home: str | os.PathLike | None = None) -> None:
    """Delete all the content of the data home cache.

    Parameters
    ----------
    data_home : str, PathLike, or None
        The path to the data directory. If ``None``, the default path
        is ``~/yohou_data``.

    See Also
    --------
    - [`get_data_home`][yohou.datasets._fetchers.get_data_home] : Return the path of the data directory.

    """
    data_home = get_data_home(data_home)
    shutil.rmtree(data_home)