Mod: Rename function to weakly private.

Labbeti · Oct 14, 2023 · 4394360 · 4394360
1 parent 523a2bf
commit 4394360
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/src/aac_metrics/download.py b/src/aac_metrics/download.py
@@ -21,7 +21,7 @@
     FNAME_SPICE_JAR,
     check_spice_install,
 )
-from aac_metrics.utils.cmdline import str_to_bool, setup_logging
+from aac_metrics.utils.cmdline import _str_to_bool, _setup_logging
 from aac_metrics.utils.paths import (
     _get_cache_path,
     _get_tmp_path,
@@ -334,31 +334,31 @@ def _get_main_download_args() -> Namespace:
     )
     parser.add_argument(
         "--clean_archives",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=True,
         help="If True, remove all archives files. defaults to True.",
     )
     parser.add_argument(
         "--ptb_tokenizer",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=True,
         help="Download PTBTokenizer Java source code.",
     )
     parser.add_argument(
         "--meteor",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=True,
         help="Download METEOR Java source code.",
     )
     parser.add_argument(
         "--spice",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=True,
         help="Download SPICE Java source code.",
     )
     parser.add_argument(
         "--fense",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=True,
         help="Download FENSE models.",
     )
@@ -370,7 +370,7 @@ def _get_main_download_args() -> Namespace:
 
 def _main_download() -> None:
     args = _get_main_download_args()
-    setup_logging(aac_metrics.__package__, args.verbose)
+    _setup_logging(aac_metrics.__package__, args.verbose)
 
     download_metrics(
         cache_path=args.cache_path,

diff --git a/src/aac_metrics/eval.py b/src/aac_metrics/eval.py
@@ -18,7 +18,7 @@
     METRICS_SETS,
 )
 from aac_metrics.utils.checks import check_metric_inputs, check_java_path
-from aac_metrics.utils.cmdline import str_to_bool, str_to_opt_str, setup_logging
+from aac_metrics.utils.cmdline import _str_to_bool, _str_to_opt_str, _setup_logging
 from aac_metrics.utils.paths import (
     get_default_cache_path,
     get_default_java_path,
@@ -163,7 +163,7 @@ def _get_main_evaluate_args() -> Namespace:
     parser.add_argument(
         "--strict",
         "-s",
-        type=str_to_bool,
+        type=_str_to_bool,
         default=False,
         help="If True, assume that all columns must be in CSV file. defaults to False.",
     )
@@ -212,14 +212,14 @@ def _get_main_evaluate_args() -> Namespace:
     parser.add_argument(
         "--corpus_out",
         "-co",
-        type=str_to_opt_str,
+        type=_str_to_opt_str,
         default=None,
         help="Output YAML path containing corpus scores. defaults to None.",
     )
     parser.add_argument(
         "--sentences_out",
         "-so",
-        type=str_to_opt_str,
+        type=_str_to_opt_str,
         default=None,
         help="Output CSV path containing sentences scores. defaults to None.",
     )
@@ -230,7 +230,7 @@ def _get_main_evaluate_args() -> Namespace:
 
 def _main_eval() -> None:
     args = _get_main_evaluate_args()
-    setup_logging(aac_metrics.__package__, args.verbose)
+    _setup_logging(aac_metrics.__package__, args.verbose)
 
     if not check_java_path(args.java_path):
         raise RuntimeError(f"Invalid Java executable. ({args.java_path})")

diff --git a/src/aac_metrics/utils/cmdline.py b/src/aac_metrics/utils/cmdline.py
@@ -11,7 +11,7 @@
 _FALSE_VALUES = ("false", "0", "f", "no", "n")
 
 
-def str_to_bool(s: str) -> bool:
+def _str_to_bool(s: str) -> bool:
     s = str(s).strip().lower()
     if s in _TRUE_VALUES:
         return True
@@ -23,15 +23,15 @@ def str_to_bool(s: str) -> bool:
         )
 
 
-def str_to_opt_str(s: str) -> Optional[str]:
+def _str_to_opt_str(s: str) -> Optional[str]:
     s = str(s)
     if s.lower() == "none":
         return None
     else:
         return s
 
 
-def setup_logging(pkg_name: str, verbose: int) -> None:
+def _setup_logging(pkg_name: str, verbose: int) -> None:
     format_ = "[%(asctime)s][%(name)s][%(levelname)s] - %(message)s"
     handler = logging.StreamHandler(sys.stdout)
     handler.setFormatter(logging.Formatter(format_))