Skip to content

Add overwrite option to save to folder #2156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alejoe91 merged 2 commits into from
Nov 3, 2023
Merged

Add overwrite option to save to folder #2156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
837b90e
add ovewrite option to save to folder
h-mayorquin Nov 2, 2023
ba908a5
fix names
h-mayorquin Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/spikeinterface/core/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ def save_to_memory(self, **kwargs) -> "BaseExtractor":
return cached

# TODO rename to saveto_binary_folder
def save_to_folder(self, name=None, folder=None, verbose=True, **save_kwargs):
def save_to_folder(self, name=None, folder=None, overwrite=False, verbose=True, **save_kwargs):
"""
Save extractor to folder.

Expand Down Expand Up @@ -819,6 +819,8 @@ def save_to_folder(self, name=None, folder=None, verbose=True, **save_kwargs):
folder: None str or Path
Name of the folder.
If "folder" is given, "name" must be None.
overwrite: bool, default: False
If True, the folder is removed if it already exists

Returns
-------
Expand All @@ -839,7 +841,12 @@ def save_to_folder(self, name=None, folder=None, verbose=True, **save_kwargs):
print(f"Use cache_folder={folder}")
else:
folder = Path(folder)
assert not folder.exists(), f"folder {folder} already exists, choose another name"
if overwrite and folder.is_dir():
import shutil

shutil.rmtree(folder)

assert not folder.exists(), f"folder {folder} already exists, choose another name or use overwrite=True"
folder.mkdir(parents=True, exist_ok=False)

# dump provenance
Expand Down