From 7e7cc015d35d86cde4aabaa0cf123e1f57a4496b Mon Sep 17 00:00:00 2001
From: "Ankur Sinha (Ankur Sinha Gmail)" <sanjay.ankur@gmail.com>
Date: Wed, 11 Sep 2024 16:49:15 +0100
Subject: [PATCH] feat(nml): allow clearing of cached property

This should be rarely required, but it's good functionality to have.

As a note, a cached_property is stored as a class property/attribute, so
"clearing the cache" simply requires one to remove the property from the
class instances `__dict__`.
---
 neuroml/nml/helper_methods.py | 17 ++++++++++++++++-
 neuroml/nml/nml.py            | 21 +++++++++++++++++++--
 2 files changed, 35 insertions(+), 3 deletions(-)

diff --git a/neuroml/nml/helper_methods.py b/neuroml/nml/helper_methods.py
index f3f3db1..0c23a0e 100644
--- a/neuroml/nml/helper_methods.py
+++ b/neuroml/nml/helper_methods.py
@@ -1031,11 +1031,26 @@ def get_segment_volume(self, segment_id: str) -> float:
 
             return temp_seg.volume
 
-    def get_segment_ids_vs_segments(self) -> typing.Dict[str, Segment]:
+    def get_segment_ids_vs_segments(self, cached: bool = True) -> typing.Dict[str, Segment]:
         """Get a dictionary of segment IDs and the segments in the cell.
 
+        :param cached: whether the cached value should be used.
+
+            Unless the cell morphology has been modified since the last call to
+            this method or the last usage of `self.segment_ids_vs_segments`,
+            the cached value is up to date and should be used. If, the
+            morphology has changed, set `cached=False` to clear the cached
+            value and return an updated value.
+        :type cached: bool
+
         :return: dictionary with segment ID as key, and segment as value
         """
+        if cached is False:
+            try:
+                del self.__dict__['segment_ids_vs_segments']
+            except KeyError:
+                pass
+
         return self.segment_ids_vs_segments
 
     @cached_property
diff --git a/neuroml/nml/nml.py b/neuroml/nml/nml.py
index 29514e3..3cb2d7d 100644
--- a/neuroml/nml/nml.py
+++ b/neuroml/nml/nml.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 #
-# Generated Wed Sep 11 16:30:43 2024 by generateDS.py version 2.44.1.
+# Generated Wed Sep 11 16:48:39 2024 by generateDS.py version 2.44.1.
 # Python 3.11.9 (main, Aug 23 2024, 00:00:00) [GCC 14.2.1 20240801 (Red Hat 14.2.1-1)]
 #
 # Command line options:
@@ -48560,11 +48560,28 @@ def get_segment_volume(self, segment_id: str) -> float:
 
             return temp_seg.volume
 
-    def get_segment_ids_vs_segments(self) -> typing.Dict[str, Segment]:
+    def get_segment_ids_vs_segments(
+        self, cached: bool = True
+    ) -> typing.Dict[str, Segment]:
         """Get a dictionary of segment IDs and the segments in the cell.
 
+        :param cached: whether the cached value should be used.
+
+            Unless the cell morphology has been modified since the last call to
+            this method or the last usage of `self.segment_ids_vs_segments`,
+            the cached value is up to date and should be used. If, the
+            morphology has changed, set `cached=False` to clear the cached
+            value and return an updated value.
+        :type cached: bool
+
         :return: dictionary with segment ID as key, and segment as value
         """
+        if cached is False:
+            try:
+                del self.__dict__["segment_ids_vs_segments"]
+            except KeyError:
+                pass
+
         return self.segment_ids_vs_segments
 
     @cached_property