Skip to content

clear_data_home

yohou.datasets.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

get_data_home : Return the path of the data directory.

Source Code

View on GitHub

Source code in src/yohou/datasets/_fetchers.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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)