Multiselection of folders in sources tab

[SAMAD101]

Description

In the source, multiple folders cant be selected, due to some limitations in QFileDialog .
Fixes #1869

Motivation and Context

It would be more convenient if one can select multiple directories in one go, not having to open add folder dialog window multiple time, saving previous time and clicks.

How Has This Been Tested?

By running them in my system. No actual tests edited so far.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have read the CONTRIBUTING guide.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

I provide my contribution under the terms of the license of this repository and I affirm the Developer Certificate of Origin.

[real-yfprojects]

If it doesn't get to complicated go ahead!

[SAMAD101]

Committed the changes, multiselection and addition of directories to sources is working now.

[SAMAD101]

This needs some changes to the tests, will commit them soon.

[SAMAD101]

So apparently, some tests are failing due to the changes I've made to the source_add.
I'm not quite getting how this work:
src/vorta/tests/unit/test_source.py (line 40-41

mocker.patch('os.access', return_value=False)
 tab.source_add(want_folder=True)

We are getting a TypeError: 'MockFileDialog' object is not iterable'
So can you explain a bit how these tests work? @real-yfprojects

[real-yfprojects]

Why do you change that? Using the non-blocking open with a slot is probably better then using exec.

[SAMAD101]

Why do you change that? Using the non-blocking open with a slot is probably better then using exec.

For some reason that way was not working out, the directories (if selected multiple) were not getting added to the sources.

[real-yfprojects]

So can you explain a bit how these tests work?

Have a look at pytest fixtures.
The failing tests use the source_env fixture which monkeypatches (that is replaces) the choose_file_dialog method with a different implementation which is needed for the tests to work without user interaction.

vorta/tests/integration/conftest.py

Lines 183 to 201 in 5b36fab

	@pytest.fixture
	def choose_file_dialog(tmpdir):
	class MockFileDialog:
	def __init__(self, *args, **kwargs):
	self.directory = kwargs.get('directory', None)
	self.subdirectory = kwargs.get('subdirectory', None)
	def open(self, func):
	func()
	def selectedFiles(self):
	if self.subdirectory:
	return [str(tmpdir.join(self.subdirectory))]
	elif self.directory:
	return [str(self.directory)]
	else:
	return [str(tmpdir)]
	return MockFileDialog

This mocking function still returns a dialog while the code expects a list of selected files resulting in the exception.

[SAMAD101]

@real-yfprojects now I understand how this tests, when the tab.source_add is called inside test_source_add_remove and also in other tests, choose_file_dialog 's mocking fixture is used instead of the real one. So, if I change the returning value of that fixture to simply a list of directories, which are now used by the receive function.
But for some reason this way is not working, Now its showing

>       paths = choose_file_dialog(self, msg, want_folder=want_folder)
E       TypeError: 'list' object is not callable

I'm quite lost in what I could be still missing atm.

[real-yfprojects]

So, if I change the returning value of that fixture to simply a list of directories

Before you change the fixture returned a function, now its a list. The return value of the fixture is available in tests using the fixture through the choose_file_dialog parameter. Before this parameter consequently contained a function that was then called. Now it contains a list. However you still try to call like the function that it contained before, raising an error.

[SAMAD101]

So, if I change the returning value of that fixture to simply a list of directories

Before you change the fixture returned a function, now its a list. The return value of the fixture is available in tests using the fixture through the choose_file_dialog parameter. Before this parameter consequently contained a function that was then called. Now it contains a list. However you still try to call like the function that it contained before, raising an error.

Thank you for the assistance @real-yfprojects

Finally done, multiselection working and tests pass now.
Here's a video:

untitled.mp4

[sayem314]

PR #1938 provides a more detailed implementation that accounts for different types of file dialog views (QListView and QTreeView).

[SAMAD101]

PR #1938 provides a more detailed implementation that accounts for different types of file dialog views (QListView and QTreeView).

Just checked it out, it does account for two different types of view.
But is that needed for this issue?
I've used the NativeDialog one, which is already in use for the purpose. Just by using a QTreeView, we can do this pretty easily in just 3 lines of code.

[m3nu]

This works to select multiple files.

For the folder dialog I get this error.

Of course having just one dialog for files and folders including multiple files and folders would be even better.

[SAMAD101]

fixed this in this little commit.
However, the intended feature of this PR is not working anymore, perhaps due to some update to PyQT.
The QFileDialog doesn't seem to have any child of QTreeView or QListView.
I'll try to find a workaround.