Skip to content

Improve assertion error message of SortingAnalyzer job kwargs #4178

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
merged 7 commits into from
Oct 29, 2025
Merged

Improve assertion error message of SortingAnalyzer job kwargs #4178

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e3840f
Improve assertion error message of SortingAnalyzer job kwargs
MGAMZ Oct 21, 2025
836fb3f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 21, 2025
979808a
Accept the copilot suggestion for better output
MGAMZ Oct 21, 2025
820cbc7
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 21, 2025
6cfed62
Improve error message for compute_several_extensions
MGAMZ Oct 29, 2025
d7b88dd
Merge branch 'main' into MGAMZ-Improve_job_kwarg_violation_hint
MGAMZ Oct 29, 2025
2132fa9
A missing fix
MGAMZ Oct 29, 2025
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
10 changes: 8 additions & 2 deletions src/spikeinterface/core/sortinganalyzer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1634,11 +1634,17 @@ def compute(self, input, save=True, extension_params=None, verbose=False, **kwar
return self.compute_one_extension(extension_name=input, save=save, verbose=verbose, **kwargs)
elif isinstance(input, dict):
params_, job_kwargs = split_job_kwargs(kwargs)
assert len(params_) == 0, "Too many arguments for SortingAnalyzer.compute_several_extensions()"
assert len(params_) == 0, (
"Too many arguments for SortingAnalyzer.compute_several_extensions(), "
f"please remove the arguments {set(params_)} from the compute function."
)
self.compute_several_extensions(extensions=input, save=save, verbose=verbose, **job_kwargs)
elif isinstance(input, list):
params_, job_kwargs = split_job_kwargs(kwargs)
assert len(params_) == 0, "Too many arguments for SortingAnalyzer.compute_several_extensions()"
assert len(params_) == 0, (
"Too many arguments for SortingAnalyzer.compute_several_extensions(), "
f"please remove the arguments {set(params_)} from the compute function."
)
extensions = {k: {} for k in input}
if extension_params is not None:
for ext_name, ext_params in extension_params.items():
Expand Down