create geneticalgorithm2.utils module

README.md

@@ -162,6 +162,7 @@ pip install geneticalgorithm2[full]
 - recreate the repository without excess heavy files materials 
 - host the [code documentation](https://pasaopasen.github.io/geneticalgorithm2/)
 - rename `geneticalgorithm2` class to `GeneticAlgorithm2`
+- substantial package architecture refactor
 
 ## 6.8.7 minor update
 

geneticalgorithm2/__init__.py

@@ -14,10 +14,10 @@
 
 from .initializer import Population_initializer
 
-from .cache import np_lru_cache
 from .callbacks import Callbacks, Actions, ActionConditions, MiddleCallbacks
 
-from .plotting_tools import plot_pop_scores, plot_several_lines
+from .utils.cache import np_lru_cache
+from .utils.plotting import plot_pop_scores, plot_several_lines
 
 
 

geneticalgorithm2/callbacks.py

@@ -8,12 +8,12 @@
 
 from OppOpPopInit import OppositionOperators, SampleInitializers
 
-from .aliases import TypeAlias, array1D, array2D, PathLike
-from .files import mkdir_of_file, mkdir
+from .utils.aliases import TypeAlias, array1D, array2D, PathLike
+from .utils.files import mkdir
+from .utils.funcs import union_to_matrix, fast_max
 
 from .classes import MiddleCallbackData, Generation
 
-from .utils import union_to_matrix, fast_max
 
 from .crossovers import CrossoverFunc
 from .selections import SelectionFunc
@@ -270,7 +270,7 @@ def PlotPopulationScores(
         plots population scores
         needs 2 functions like data->str for title and file name
         """
-        from .plotting_tools import plot_pop_scores
+        from .utils.plotting import plot_pop_scores
 
         use_save_as = (lambda data: None) if save_as_name_pattern is None else save_as_name_pattern
 

geneticalgorithm2/classes.py

@@ -7,14 +7,14 @@
 
 import numpy as np
 
-from .aliases import array1D, array2D, TypeAlias, PathLike
-from .files import mkdir_of_file
+from .utils.aliases import array1D, array2D, TypeAlias, PathLike
+from .utils.files import mkdir_of_file
+from .utils.funcs import can_be_prob, union_to_matrix
 
 from .crossovers import Crossover, CrossoverFunc
 from .mutations import Mutations, MutationIntFunc, MutationFloatFunc
 from .selections import Selection, SelectionFunc
 
-from .utils import can_be_prob, union_to_matrix
 
 
 class DictLikeGetSet:

geneticalgorithm2/crossovers.py

@@ -4,7 +4,7 @@
 import random
 import numpy as np
 
-from .aliases import TypeAlias, array1D
+from .utils.aliases import TypeAlias, array1D
 
 CrossoverFunc: TypeAlias = Callable[[array1D, array1D], Tuple[array1D, array1D]]
 

geneticalgorithm2/geneticalgorithm2.py

@@ -16,14 +16,14 @@
 
 #region INTERNAL IMPORTS
 
-from .aliases import array1D, array2D
+from .utils.aliases import array1D, array2D
 
 from .classes import AlgorithmParams, Generation, MiddleCallbackData, GAResult, GenerationConvertible
 
 from .initializer import Population_initializer
-from .plotting_tools import plot_pop_scores, plot_several_lines
+from .utils.plotting import plot_pop_scores, plot_several_lines
 
-from .utils import can_be_prob, is_numpy, is_current_gen_number, fast_min, random_indexes_pair
+from .utils.funcs import can_be_prob, is_numpy, is_current_gen_number, fast_min, random_indexes_pair
 
 from .callbacks import MiddleCallbackFunc, CallbackFunc
 

geneticalgorithm2/initializer.py

@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from .aliases import TypeAlias, array1D, array2D
+from .utils.aliases import TypeAlias, array1D, array2D
 
 
 LOCAL_OPT_STEPS: TypeAlias = Literal['before_select', 'after_select', 'never']

geneticalgorithm2/mutations.py

@@ -5,9 +5,9 @@
 import numpy as np
 
 
-from .utils import fast_min, fast_max
+from .utils.aliases import TypeAlias
+from .utils.funcs import fast_min, fast_max
 
-from .aliases import TypeAlias
 
 MutationFloatFunc: TypeAlias = Callable[[float, float, float], float]
 MutationIntFunc: TypeAlias = Callable[[int, int, int], int]

geneticalgorithm2/selections.py

@@ -5,7 +5,7 @@
 import random
 import numpy as np
 
-from .aliases import array1D, TypeAlias
+from .utils.aliases import array1D, TypeAlias
 
 SelectionFunc: TypeAlias = Callable[[array1D, int], array1D]
 

geneticalgorithm2/cache.py → geneticalgorithm2/utils/cache.py

@@ -7,7 +7,7 @@
 
 #from fastcache import clru_cache
 
-from .aliases import array1D
+from geneticalgorithm2.utils.aliases import array1D
 
 
 def np_lru_cache(*args, **kwargs):

geneticalgorithm2/files.py → geneticalgorithm2/utils/files.py

@@ -2,7 +2,7 @@
 
 from pathlib import Path
 
-from .aliases import PathLike
+from geneticalgorithm2.utils.aliases import PathLike
 
 
 def _mkdir(path: Path):

geneticalgorithm2/utils.py → geneticalgorithm2/utils/funcs.py

@@ -1,12 +1,10 @@
 
 from typing import Optional, Any, Tuple
 
-from pathlib import Path
-
 import random
 import numpy as np
 
-from .aliases import array1D, array2D
+from geneticalgorithm2.utils.aliases import array1D, array2D
 
 
 def fast_min(a, b):

geneticalgorithm2/plotting_tools.py → geneticalgorithm2/utils/plotting.py

@@ -3,7 +3,7 @@
 
 import numpy as np
 
-from .aliases import PathLike
+from geneticalgorithm2.utils.aliases import PathLike
 from .files import mkdir_of_file
 
 
@@ -51,6 +51,7 @@ def plot_several_lines(
 
     plt.show()
 
+
 def plot_pop_scores(scores: Sequence[float], title: str = 'Population scores', save_as: Optional[str] = None):
     """
     plots scores (numeric values) as sorted bars
@@ -76,8 +77,6 @@ def autolabel(rects):
                         xytext=(0, 3),  # 3 points vertical offset
                         textcoords="offset points",
                         ha='center', va='bottom', fontsize=14, fontweight='bold')
-
-
 
     cols = np.zeros(len(sc))
     cols[-1] = 1
@@ -96,7 +95,6 @@ def autolabel(rects):
     #ax.set_ylim([0, max(subdict.values())*1.2])
     #fig.suptitle(title, fontsize=15, fontweight='bold')
 
-
     fig.tight_layout()
 
     if save_as is not None: