Merge pull request #208 from NeuralEnsemble/feat-list-params

Feat: add method to list parameters of a component object

Author: sanjayankur31

neuroml/nml/generatedssupersuper.py

@@ -468,6 +468,30 @@ def info(self, show_contents=False, return_format="string"):
             print(info_str)
             return info_str
 
+    def get_parameters(self):
+        """Get parameters for this component
+
+        This returns a subset of the results of the `info()` method, limiting
+        the results to the parameters only.
+
+        .. versionadded:: 0.6.6
+
+        :returns: dictionary with parameter names as keys, and parameter values
+            as values
+        :rtype: dict[str, str]
+
+        """
+        info = self.info(show_contents="all", return_format="dict")
+        parameters = {}
+        for member, memberinfo in info.items():
+            if (
+                memberinfo["type"].startswith("Nml2Quantity_")
+                or memberinfo["type"] == "NmlId"
+            ):
+                parameters[member] = memberinfo["members"]
+
+        return parameters
+
     def validate(self, recursive=False):
         """Validate the component.
 

neuroml/test/test_nml.py

@@ -870,6 +870,21 @@ def test_adding_any(self):
         print(annotation_text)
         self.assertEqual("<Annotation>some_string</Annotation>", annotation_text)
 
+    def test_parameter_listing(self):
+        """Test listing component parameters"""
+        params = {
+            "id": "test_cell",
+            "thresh": "10mV",
+            "leak_reversal": "10mV",
+            "reset": "0mV",
+            "C": "10 F",
+            "leak_conductance": "10 nS",
+        }
+        cell = component_factory("IafCell", **params)  # type: neuroml.Cell
+        received_parameters = cell.get_parameters()
+        self.assertDictEqual(params, received_parameters)
+        print(received_parameters)
+
 
 if __name__ == "__main__":
     ta = TestNML()