Remove top-level directory from extracted files if it has only single child

[dkrako]

Description of the problem

Some datasets have a top-level directory in the archive that has just a single node in it.
This is unnecessary and creates much longer filepaths than needed.

Description of a solution

Instead it would be nice to remove top-level directories by default if they only have a single node.

Example:
after extracting the archive archive.zip into the directory archive we get the following filestructure:

archive/mydata/
archive/mydata/1.csv
archive/mydata/2.csv
archive/mydata/3.csv
archive/mydata/4.csv
archive/mydata/5.csv

This feature would then instead create the following structure:

archive/
archive/1.csv
archive/2.csv
archive/3.csv
archive/4.csv
archive/5.csv

But in case of

archive/mydata/
archive/mydata/1.csv
archive/mydata/2.csv
archive/mydata/3.csv
archive/mydata/4.csv
archive/mydata/5.csv
archive/README.md

The structure would have to be left untouched.

Minimum acceptance criteria

• remove top-level directories by default in Dataset.extract() and utils.archives.extract()
• add an optional parameter to these methods (for example remove_top_level: bool = True)
• tests in tests/utils/archives_test.py

[dkrako]

I have just checked how utils.archives.extract() is currently tested in tests/utils/archives_test.py.

I think it would be best to just adjust fixture_archive such that it always creates one top-level directory with a single child.

The current tests just check if the function executes without errors but doesn't check for the extracted files:

pymovements/tests/utils/archives_test.py

Lines 189 to 209 in 279d886

	@pytest.mark.parametrize(
	'recursive',
	[
	pytest.param(False, id='recursive_false'),
	pytest.param(True, id='recursive_true'),
	],
	)
	@pytest.mark.parametrize(
	'remove_finished',
	[
	pytest.param(False, id='remove_finished_false'),
	pytest.param(True, id='remove_finished_true'),
	],
	)
	def test_extract_archive_destination_path_None(recursive, remove_finished, archive):
	extract_archive(
	source_path=archive,
	destination_path=None,
	recursive=recursive,
	remove_finished=remove_finished,
	)

If you have the capacity, it would be nice to check the extracted file structure for the existing cases too.
It should be sufficient to just check if the respective directory has the expected set of files.