Specifying dependencies of a custom extension in the .s4ext file

koeglfryderyk · January 23, 2022, 4:21pm

I’m making a custom extension that contains the SimpleMarkupsWidget. Does this mean that my extension depends on the Markups module and I have to specify this as a dependency in the .s4ext file in my pull request?

jamesobutler · January 23, 2022, 5:14pm

The .s4ext is describing build dependencies of the extension, but more specifically the other extensions that it depends upon. @jcfr and @lassoan can confirm, but this comment in the .s4ext should probably be clarified to list the dependent extension names rather than the name of dependent modules.

github.com

Slicer/Slicer/blob/11a0ed812e1d96c8945eff987d602093d003b9e3/Utilities/Templates/Extensions/extension_description.s4ext.in#L12-L15

      
        
            # list dependencies
            # - These should be names of other modules that have .s4ext files
            # - The dependencies will be built first
            depends ${MY_EXTENSION_DEPENDS}

Your extension contains modules and for a given module you will want to specify dependent modules in the same type section as shown below. This makes sure certain modules are loaded first during startup so your module can appropriately import various things it might need during initialization. As in this linked example, the Segment Editor module depends on the Segmentations module and Subject Hierarchy module. In your case, your module would depend on the Markups module.

github.com

Slicer/Slicer/blob/11a0ed812e1d96c8945eff987d602093d003b9e3/Modules/Scripted/SegmentEditor/SegmentEditor.py#L16

      
        
            
            
#
            # SegmentEditor
            #
            class SegmentEditor(ScriptedLoadableModule):
              def __init__(self, parent):
                ScriptedLoadableModule.__init__(self, parent)
                import string
                self.parent.title = "Segment Editor"
                self.parent.categories = ["", "Segmentation"]
                self.parent.dependencies = ["Segmentations", "SubjectHierarchy"]
                self.parent.contributors = ["Csaba Pinter (Queen's University), Andras Lasso (Queen's University)"]
                self.parent.helpText = """
            This module allows editing segmentation objects by directly drawing and using segmentaiton tools on the contained segments.
            Representations other than the labelmap one (which is used for editing) are automatically updated real-time,
            so for example the closed surface can be visualized as edited in the 3D view.
            """
                self.parent.helpText += parent.defaultDocumentationLink
                self.parent.acknowledgementText = """
            This work is part of SparKit project, funded by Cancer Care Ontario (CCO)'s ACRU program
            and Ontario Consortium for Adaptive Interventions in Radiation Oncology (OCAIRO).

Topic		Replies	Views
Extension dependency not found Development	4	449	February 21, 2019
.s4ext File gerenation problem Development extensions-manager , python	1	525	September 17, 2020
Loadable custom markups : how to install the packaged extension Development	1	283	May 2, 2022
Poll: How do you (re)generate s4ext file for Slicer ExtensionsIndex? Development extensions-manager	3	682	May 25, 2017
Extension dependencies in custom apps Development build	7	407	May 24, 2022

Specifying dependencies of a custom extension in the .s4ext file

Related topics