Clean up code around create_sorting_analyzer and create/load_* functions in sortinganalyzer.py

[ecobost]

This PR does not functionally change much. It is mainly for code refactoring and to improve legibility.

The only two functional changes are:

• fix small bug when calling save_to_zarr("test.zarr") would add an extra .zarr to the filename (

  spikeinterface/src/spikeinterface/core/base.py

  Line 1087 in 39dfac4

  zarr_path = cache_folder / f"{name}.zarr"

  )
• when return_scaled and return_in_uV are provided, prioritize return_in_uV. Currently, it prefers return_scaled over return_in_uV

Code quality improvements:

• type hinting
• Collect code into logical blocks (e..g, everything that has to do wit main indices together); add comment headers (e.g., Saving main indices) and reorder this blocks (e.g., expected stuff like sorting should be saved and loaded before any of the optional things like sparsity)
• Make create_binary_folder parallel create_zarr (you can now see how they are both doing exactly the same).
• Make load_binary_folder parallel load_zarr.
• Preserve the same order of operations when loading and saving. If sorting was saved first, then load first and so on.
• Tighten code when possible

[zm711]

A few initial comments.

[zm711]

why this change? is_dir() verifies existence and that it is a folder? So it's more specific.

[ecobost]

In here particularly, we don't actually care about it being a directory because we are gonna delete it anyway (whether a fle or directory); but actually we use exists everywhere so I'll change the ones where isdir/isfile will be more appropiate

[alejoe91]

Well I think we try to use is_dir/is_file when possible, which I believe is better because more explicit, so I would revert

Suggested change

	if folder.exists():
	if folder.is_dir():

[ecobost]

i did revert/change exists()-> is_dir/is_filewhen needed on the next commit below. But exists() makes more sense here, if someone says save it at /xxx/yyy and overwrite=True, then whatever is in /xxx/yyy (dir or file) will be overwritten

[alejoe91]

Thanks @ecobost

Much cleaner :) I have a few suggestions/comments. Could you tackle them? Then this is good to go for me!

[alejoe91]

Suggested change

	recording.dump(recording_provenance_file, relative_to=folder)
	elif recording.check_serializability("pickle"):
	recording.dump(folder / "recording.pickle", relative_to=folder)
	recording.dump(recording_provenance_file.with_suffix(".pickle"), relative_to=folder)
	recording.dump(folder / "recording.json", relative_to=folder)
	elif recording.check_serializability("pickle"):
	recording.dump(folder / "recording.pickle", relative_to=folder)

I think the previous version was cleaner. I don't see the point in defining the json path and change the suffix for pickle

[ecobost]

the idea was to signal the .json as the default output file; I could change it to
recording_provenance_file = folder / "recording" and then add the suffix at the dump line if you prefer

[alejoe91]

Well I think we try to use is_dir/is_file when possible, which I believe is better because more explicit, so I would revert

Suggested change

	if folder.exists():
	if folder.is_dir():

[ecobost]

@alejoe91 Couple of comments still open. Let me know when this version is ok to fix merge issues (don't wanna pollute current version)