Add support for registering scripted IOOptionsWidget

[jcfr]

No description provided.

[lassoan]

Thank you, this looks great, just added a few comments inline.

[lassoan]

I know that we do this all the time, but now that you are working on this and you are so knowledgable about Python integration, I would ask: is it possible to do this better? The main limitation of this is that if an uncaught exception is raised in the reimplemented method then it is silently ignored and it is assumed that the method is just not overridden.

[jcfr]

There is way to address this and simplify across Slicer, will do so in a follow-up PR.

[jamesobutler]

I have rebased this PR to help with testing. Note that former commits in this PR were already integrated through PR:

• Misc scripted module fixes #6993

Commits listed below:

• 18346ff
• 5540c8c
• fafcc74
• e386f98
• be954d7
• 99eb780

[jcfr]

@jamesobutler This is now ready for review & testing.

[jamesobutler]

@jcfr A few merge conflicts here with various recent integrations.

[jamesobutler]

@jcfr Thanks for moving this work forward 🙏🏻 . Using this example I was able to see the progress you made to have options for a scripted file reader:

[jamesobutler]

Trying this update in my custom scripted file reader, it appears that the properties dictionary isn't updated with these new custom entries. It is only has fileName and fileType. Oddly reviewing self.parent.properties at the end of this method was revealing that the new entry wasn't added and therefore not used in the FileReader's load method which then uses properties as an input argument.

[jcfr]

it appears that the properties dictionary isn't updated

Thanks for testing 🙏 I also observed this. I have an idea of the issue and will follow up.

[jcfr]

@jamesobutler What we are still missing is the ability to implement examineFileInfoList from Python.

Specialization may allow to:

• preprocess the list of files
• define new properties (the method updateGui is called automatically after examineFileInfoList allowing the widget to update itself based on the new properties)

For example:

Slicer/Modules/Loadable/Volumes/qSlicerVolumesReader.cxx

Lines 219 to 253 in 516716c

	bool qSlicerVolumesReader::examineFileInfoList(QFileInfoList &fileInfoList, QFileInfo &archetypeFileInfo, qSlicerIO::IOProperties &ioProperties)const
	{
	//
	// Check each file to see if it's recognized as part of a series. If so,
	// keep it as the archetype and remove all the others from the list
	//
	foreach(QFileInfo fileInfo, fileInfoList)
	{
	itk::ArchetypeSeriesFileNames::Pointer seriesNames = itk::ArchetypeSeriesFileNames::New();
	std::vector<std::string> candidateFiles;
	seriesNames->SetArchetype(fileInfo.absoluteFilePath().toStdString());
	candidateFiles = seriesNames->GetFileNames();
	if (candidateFiles.size() > 1)
	{
	archetypeFileInfo = fileInfo;
	QMutableListIterator<QFileInfo> fileInfoIterator(fileInfoList);
	while (fileInfoIterator.hasNext())
	{
	const QString &path = fileInfoIterator.next().absoluteFilePath();
	if (path == archetypeFileInfo.absoluteFilePath())
	{
	continue;
	}
	if (std::find(candidateFiles.begin(), candidateFiles.end(), path.toStdString()) != candidateFiles.end())
	{
	fileInfoIterator.remove();
	}
	}
	ioProperties["singleFile"] = false;
	return true;
	}
	}
	return false;
	}