Added kwarg: 'raise_missing_property' to 'NodePopulation.get' (#206)

Co-authored-by: Gianluca Ficarelli <26835404+GianlucaFicarelli@users.noreply.github.com>

CHANGELOG.rst

@@ -11,6 +11,7 @@ New Features
 Improvements
 ~~~~~~~~~~~~
 - Node set resolution is done by libsonata
+- Added kwarg: `raise_missing_property` to `NodePopulation.get`
 
 Breaking Changes
 ~~~~~~~~~~~~~~~~

bluepysnap/nodes/node_population.py

@@ -452,14 +452,16 @@ def ids(self, group=None, limit=None, sample=None, raise_missing_property=True):
         else:
             return np.unique(result)
 
-    def get(self, group=None, properties=None):
+    def get(self, group=None, properties=None, raise_missing_property=True):
         """Node properties as a pandas Series or DataFrame.
 
         Args:
             group (int/CircuitNodeId/CircuitNodeIds/sequence/str/mapping/None):
                 see :ref:`Group Concept`
             properties (list|str|None): If specified, return only the properties in the list.
                 Otherwise, return all the properties.
+            raise_missing_property (bool): when a property used for filtering ids is not present in
+                the population, raise an error if True, or return empty Series/DataFrame if False.
 
         Returns:
             value/pandas.Series/pandas.DataFrame:
@@ -525,9 +527,9 @@ def get(self, group=None, properties=None):
             if isinstance(group, (int, np.integer)):
                 self._check_id(group)
             elif isinstance(group, CircuitNodeId):
-                group = self.ids(group)[0]
+                group = self.ids(group, raise_missing_property=raise_missing_property)[0]
             else:
-                group = self.ids(group)
+                group = self.ids(group, raise_missing_property=raise_missing_property)
 
         result = self._get_data(properties=properties)
         result = result.loc[group] if group is not None else result

tests/test_node_population.py

@@ -339,6 +339,13 @@ def test_get(self):
         assert _call().shape == (3, 12)
         assert _call(0, Cell.MTYPE) == "L2_X"
         assert _call(CircuitNodeId("default", 0), Cell.MTYPE) == "L2_X"
+
+        # Unknown property filters
+        assert _call({"no-such-property": "no-value"}, raise_missing_property=False).empty
+        with pytest.raises(BluepySnapError) as e:
+            _call({"no-such-property": "no-value"})
+        assert "Unknown node properties" in e.value.args[0]
+
         assert _call(np.int32(0), Cell.MTYPE) == "L2_X"
         pdt.assert_frame_equal(
             _call([1, 2], properties=[Cell.X, Cell.MTYPE, Cell.HOLDING_CURRENT]),