Fix const and property name

Author: benjeffery

python/CHANGELOG.rst

@@ -4,7 +4,7 @@
 
 **Features**
 
-- Add ``TreeSequence.individual_nodes`` attribute to return the nodes
+- Add ``TreeSequence.individuals_nodes`` attribute to return the nodes
   associated with each individual as a numpy array.
   (:user:`benjeffery`, :pr:`3153`)
 

python/_tskitmodule.c

@@ -8731,23 +8731,20 @@ TreeSequence_get_individuals_nodes(TreeSequence *self)
     PyObject *ret = NULL;
     PyArrayObject *ret_array = NULL;
     npy_intp dims[2];
-    tsk_size_t num_individuals;
     tsk_size_t ploidy;
     tsk_size_t max_ploidy = 0;
     tsk_id_t *node_mem;
     tsk_size_t j;
-    const tsk_id_t **individual_nodes;
-    const tsk_size_t *individual_nodes_length;
+    const tsk_size_t num_individuals
+        = tsk_treeseq_get_num_individuals(self->tree_sequence);
+    tsk_id_t *const *individual_nodes = self->tree_sequence->individual_nodes;
+    const tsk_size_t *individual_nodes_length
+        = self->tree_sequence->individual_nodes_length;
 
     if (TreeSequence_check_state(self) != 0) {
         goto out;
     }
 
-    num_individuals = tsk_treeseq_get_num_individuals(self->tree_sequence);
-
-    individual_nodes = self->tree_sequence->individual_nodes;
-    individual_nodes_length = self->tree_sequence->individual_nodes_length;
-
     for (tsk_id_t i = 0; i < (tsk_id_t) num_individuals; i++) {
         ploidy = individual_nodes_length[i];
         if (ploidy > max_ploidy) {

python/tests/test_highlevel.py

@@ -5493,8 +5493,8 @@ def test_error_if_no_schema(self, table_name):
             getattr(ts, f"{table_name}_metadata")
 
 
-class TestIndividualNodes:
-    def test_basic_individual_nodes(self, tmp_path):
+class TestIndividualsNodes:
+    def test_basic_individuals_nodes(self, tmp_path):
         # Create a basic tree sequence with two individuals
         tables = tskit.TableCollection(sequence_length=100)
         tables.individuals.add_row(flags=0, location=(0, 0), metadata=b"")
@@ -5505,7 +5505,7 @@ def test_basic_individual_nodes(self, tmp_path):
         tables.nodes.add_row(flags=tskit.NODE_IS_SAMPLE, time=0, individual=1)
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
         assert result.shape == (2, 2)
         assert_array_equal(result, [[0, 1], [2, 3]])
 
@@ -5529,7 +5529,7 @@ def test_variable_ploidy(self, tmp_path):
 
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
 
         assert result.shape == (3, 3)
 
@@ -5543,7 +5543,7 @@ def test_no_individuals(self):
         tables.nodes.add_row(flags=tskit.NODE_IS_SAMPLE, time=0)
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
         expected = np.array([], dtype=np.int32).reshape(0, 0)
         assert result.shape == (0, 0)
         assert_array_equal(result, expected)
@@ -5555,7 +5555,7 @@ def test_no_nodes_with_individuals(self):
         tables.nodes.add_row(flags=tskit.NODE_IS_SAMPLE, time=0)
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
         expected = np.array([[]])
         assert result.shape == (1, 0)
         assert_array_equal(result, expected)
@@ -5568,7 +5568,7 @@ def test_individual_with_no_nodes(self):
         tables.nodes.add_row(flags=tskit.NODE_IS_SAMPLE, time=0, individual=0)
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
         expected = np.array([[0], [-1]])
         assert result.shape == (2, 1)
         assert_array_equal(result, expected)
@@ -5580,7 +5580,7 @@ def test_mixed_sample_status(self):
         tables.nodes.add_row(flags=0, time=0, individual=0)
         ts = tables.tree_sequence()
 
-        result = ts.individual_nodes
+        result = ts.individuals_nodes
         expected = np.array([[0, 1]])
         assert result.shape == (1, 2)
         assert_array_equal(result, expected)

python/tskit/trees.py

@@ -5816,7 +5816,7 @@ def individuals_metadata(self):
         )
 
     @property
-    def individual_nodes(self):
+    def individuals_nodes(self):
         """
         Return an array of node IDs for each individual in the tree sequence.