style & utils type hints

Author: guerinclement

eurybia/style/style_utils.py

@@ -2,9 +2,10 @@
 
 import json
 import os
+from typing import Any
 
 
-def colors_loading():
+def colors_loading() -> dict:
     """colors_loading allows Eurybia to load a json file which contains different
     palettes of colors that can be used in the plot
 
@@ -21,7 +22,7 @@ def colors_loading():
     return colors_dic
 
 
-def select_palette(colors_dic, palette_name):
+def select_palette(colors_dic: dict[str, dict], palette_name: str) -> dict:
     """colors_loading allows Eurybia to load a json file which contains different
     palettes of colors that can be used in the plot
 
@@ -43,7 +44,7 @@ def select_palette(colors_dic, palette_name):
     return colors_dic[palette_name]
 
 
-def define_style(palette):
+def define_style(palette: dict[str, Any]) -> dict[str, Any]:
     """The define_style function is a function that uses a palette
     to define the different styles used in the different outputs
     of Eurybia
@@ -59,7 +60,7 @@ def define_style(palette):
         contains different style elements
 
     """
-    style_dict = dict()
+    style_dict: dict[str, Any] = dict()
     style_dict["dict_title"] = {
         "xanchor": "center",
         "yanchor": "middle",

eurybia/utils/io.py

@@ -1,9 +1,10 @@
 """IO module"""
 
 import pickle
+from typing import Any
 
 
-def load_yml(path):
+def load_yml(path: str) -> dict:
     """Loads a yml file
 
     Parameters
@@ -33,12 +34,12 @@ def load_yml(path):
 try:
     import yaml
 
-    _is_yaml_available = True
+    _is_yaml_available = True  # FIXME: never used
 except (ImportError, ModuleNotFoundError):
     _is_yaml_available = False
 
 
-def save_pickle(obj, path, protocol=pickle.HIGHEST_PROTOCOL):
+def save_pickle(obj, path: str, protocol: int = pickle.HIGHEST_PROTOCOL) -> None:
     """Save any python Object in pickle file
 
     Parameters
@@ -68,7 +69,7 @@ def save_pickle(obj, path, protocol=pickle.HIGHEST_PROTOCOL):
         pickle.dump(obj, file, protocol=protocol)
 
 
-def load_pickle(path):
+def load_pickle(path: str) -> Any:
     """Load any pickle file
 
     Parameters

eurybia/utils/statistical_tests.py

@@ -57,7 +57,7 @@ def chisq_test(obs_a: np.array, obs_b: np.array) -> dict:
     return output
 
 
-def prob_mass_fun(data, n, range):
+def prob_mass_fun(data: pd.Series, n: int, range: tuple[float, float]) -> tuple[np.ndarray, np.ndarray]:
     """Computing the probability mass function using NumPy’s histogram.
 
     Parameters
@@ -80,7 +80,7 @@ def prob_mass_fun(data, n, range):
     return e, p
 
 
-def compute_js_divergence(df_1, df_2, n_bins=30):
+def compute_js_divergence(df_1: pd.DataFrame, df_2: pd.DataFrame, n_bins: int = 30) -> float:
     """Computing the Jensen-Shannon divergence between 2 dataframe
 
     Parameters

eurybia/utils/utils.py

@@ -39,13 +39,13 @@ def base_100(series: pd.Series) -> pd.Series:
     return series / tot
 
 
-def get_project_root():
+def get_project_root() -> Path:
     """Returns project root absolute path."""
     current_path = Path(__file__)
     return current_path.parent.parent.resolve()
 
 
-def truncate_str(text, maxlen=40):
+def truncate_str(text: str, maxlen: int = 40) -> str:
     """Truncate a string
 
     Parameters
@@ -76,7 +76,7 @@ def truncate_str(text, maxlen=40):
     return text
 
 
-def round_to_k(x, k):
+def round_to_k(x: float, k: int) -> float | int:
     """Round float to k significant figure
 
     Parameters