feat(utils)!: move get_next_hex_color to separate utils module

BREAKING CHANGE: `pynml.get_next_hex_color` -> `utils.plot.get_next_hex_color`

Author: sanjayankur31

pyneuroml/analysis/__init__.py

@@ -7,6 +7,7 @@
 from pyneuroml import pynml
 from pyneuroml.lems.LEMSSimulation import LEMSSimulation
 from pyneuroml.lems import generate_lems_file_for_neuroml
+from pyneuroml.utils.plot import get_next_hex_color
 import neuroml as nml
 from pyelectro.analysis import max_min
 from pyelectro.analysis import mean_spike_frequency
@@ -240,7 +241,7 @@ def generate_current_vs_frequency_curve(
     for i in range(number_cells):
         ref = "v_cell%i" % i
         quantity = "%s[%i]/v" % (pop.id, i)
-        ls.add_line_to_display(disp0, ref, quantity, "1mV", pynml.get_next_hex_color())
+        ls.add_line_to_display(disp0, ref, quantity, "1mV", get_next_hex_color())
         ls.add_column_to_output_file(of0, ref, quantity)
 
     lems_file_name = ls.save_to_file()

pyneuroml/lems/LEMSSimulation.py

@@ -13,7 +13,7 @@
 from neuroml import __version__ as libnml_ver
 from pyneuroml.pynml import read_neuroml2_file
 from pyneuroml.pynml import read_lems_file
-from pyneuroml.pynml import get_next_hex_color
+from pyneuroml.utils.plot import get_next_hex_color
 
 logger = logging.getLogger(__name__)
 

pyneuroml/lems/__init__.py

@@ -4,7 +4,8 @@
 import shutil
 import os
 import logging
-from pyneuroml.pynml import read_neuroml2_file, get_next_hex_color
+from pyneuroml.pynml import read_neuroml2_file
+from pyneuroml.utils.plot import get_next_hex_color
 import random
 import neuroml
 

pyneuroml/plot/PlotMorphology.py

@@ -19,10 +19,10 @@
 from matplotlib_scalebar.scalebar import ScaleBar
 import plotly.graph_objects as go
 
-from pyneuroml.pynml import read_neuroml2_file, get_next_hex_color
+from pyneuroml.pynml import read_neuroml2_file
 from pyneuroml.utils.cli import build_namespace
 from pyneuroml.utils import extract_position_info
-from pyneuroml.utils.plot import add_text_to_2D_plot
+from pyneuroml.utils.plot import add_text_to_2D_plot, get_next_hex_color
 from neuroml import (SegmentGroup, Cell)
 from neuroml.neuro_lex_ids import neuro_lex_ids
 

pyneuroml/pynml.py

@@ -1929,22 +1929,6 @@ def reload_saved_data(
         return traces
 
 
-def get_next_hex_color(my_random: typing.Optional[random.Random] = None) -> str:
-    """Get a new randomly generated HEX colour code.
-
-    You may pass a random.Random instance that you may be used. Otherwise the
-    default Python random generator will be used.
-
-    :param my_random: a random.Random object
-    :type my_random: random.Random
-    :returns: HEX colour code
-    """
-    if my_random is not None:
-        return "#%06x" % my_random.randint(0, 0xFFFFFF)
-    else:
-        return "#%06x" % random.randint(0, 0xFFFFFF)
-
-
 def confirm_file_exists(filename: str) -> None:
     """Check if a file exists, exit if it does not.
 

pyneuroml/utils/plot.py

@@ -9,6 +9,8 @@
 
 from matplotlib.axes import Axes
 import numpy
+import typing
+import random
 
 
 def add_text_to_2D_plot(ax: Axes, xv, yv, color, text: str):
@@ -36,3 +38,19 @@ def add_text_to_2D_plot(ax: Axes, xv, yv, color, text: str):
     ax.text((xv[0] + xv[1]) / 2, (yv[0] + yv[1]) / 2, text, color=color,
             horizontalalignment="center", verticalalignment="bottom",
             rotation_mode="default", rotation=angle)
+
+
+def get_next_hex_color(my_random: typing.Optional[random.Random] = None) -> str:
+    """Get a new randomly generated HEX colour code.
+
+    You may pass a random.Random instance that you may be used. Otherwise the
+    default Python random generator will be used.
+
+    :param my_random: a random.Random object
+    :type my_random: random.Random
+    :returns: HEX colour code
+    """
+    if my_random is not None:
+        return "#%06x" % my_random.randint(0, 0xFFFFFF)
+    else:
+        return "#%06x" % random.randint(0, 0xFFFFFF)