188 - Save point

Author: antaenc

pyproject.toml

@@ -42,7 +42,8 @@ disable = [
     "line-too-long",
     "too-many-branches",
     "too-many-instance-attributes",
-    "too-many-locals"
+    "too-many-locals",
+    "too-many-statements"
 ]
 good-names = [
     "template-python"

sz_tools/sz_command

@@ -45,15 +45,14 @@ _WrappedFunc = TypeVar("_WrappedFunc", bound=Callable[..., Any])
 
 MODULE_NAME = pathlib.Path(__file__).stem
 
-# Per command settings
-PER_CMD_SETTINGS = ["json", "jsonl", "color", "colour", "nocolor", "nocolour", "debug", "timer", "page"]
+PER_CMD_SETTINGS = ["json", "jsonl", "color", "colour", "nocolor", "nocolour", "debug", "timer", "scroll"]
 
 DEFAULT_CONFIG = {
     "format_json": True,
     "color_output": True,
     "timer": False,
     "theme": "TERMINAL",
-    "page_output": False,
+    "scroll_output": False,
     "debug_sdk_call": False,
     "debug_sz_engine": False,
     "history_file": True,
@@ -71,7 +70,7 @@ SETTINGS_TO_CONFIG_MAP = {
     "debug": ["debug_sdk_call", True],
     "debug_sdk": ["debug_sdk_call", True],
     "timer": ["timer", True],
-    "page": ["page_output", True],
+    "scroll": ["scroll_output", True],
 }
 
 # Don't overwrite last command if we still need to use it
@@ -99,7 +98,7 @@ CONFIG_SETTINGS: Dict[str, Dict[str, Any]] = {
         "values": [c.lower() for c in Colors.AVAILABLE_THEMES],
         "description": "Set color scheme to use",
     },
-    "page_output": {
+    "scroll_output": {
         "values": ["off", "on"],
         "description": "Use a pager for content larger than the terminal",
     },
@@ -126,7 +125,7 @@ CONFIG_SETTINGS: Dict[str, Dict[str, Any]] = {
 
 def do_methods_decorator(do_method: _WrappedFunc) -> _WrappedFunc:
     @functools.wraps(do_method)
-    def wrapper(self, *args, **kwargs) -> Any:
+    def wrapper(self, *args: Any, **kwargs: Any) -> Any:
         # Remove do_ from wrapped method
         sdk_method_name = do_method.__name__[3:]
 
@@ -582,7 +581,7 @@ class SzCmdShell(cmd.Cmd):
         formatted_response: str = print_response(
             response,
             self.per_cmd_config["format_json"],  # type: ignore[arg-type]
-            self.per_cmd_config["page_output"],  # type: ignore[arg-type]
+            self.per_cmd_config["scroll_output"],  # type: ignore[arg-type]
             self.per_cmd_config["color_output"],  # type: ignore[arg-type]
             color=color,
         )
@@ -781,7 +780,7 @@ class SzCmdShell(cmd.Cmd):
                 - nocolor / nocolour
                 - debug
                 - timer
-                - page
+                - scroll
 
             {colorize_str('- Examples:', 'dim')}
                 - get_entity_by_entity_id 1001 jsonl
@@ -845,21 +844,21 @@ class SzCmdShell(cmd.Cmd):
         Notes:
             - Retrieve the active configuration identifier with get_active_config_id
 
-            - Retrieve a list of configurations and identifiers with get_configs"""
+            - Retrieve a list of configurations and identifiers with get_config_registry"""
 
         sz_config = self.sz_configmgr.create_config_from_config_id(kwargs["parsed_args"].config_id)
         response = sz_config.export()
         self.last_response = self.output_response(response)
 
     @do_methods_decorator
-    def do_get_configs(self) -> None:
+    def do_get_config_registry(self) -> None:
         """
-        Get a list of current configurations
+        Get details of current registered configurations
 
         Syntax:
-            get_configs"""
+            get_config_registry"""
 
-        response = self.sz_configmgr.get_configs()
+        response = self.sz_configmgr.get_config_registry()
         self.last_response = self.output_response(response)
 
     @do_methods_decorator
@@ -889,7 +888,7 @@ class SzCmdShell(cmd.Cmd):
             new_default_config_id = Configuration identifier
 
         Notes:
-            - Retrieve a list of configurations and identifiers with get_configs"""
+            - Retrieve a list of configurations and identifiers with get_config_registry"""
 
         self.sz_configmgr.replace_default_config_id(
             kwargs["parsed_args"].current_default_config_id,
@@ -2297,7 +2296,7 @@ class SzCmdShell(cmd.Cmd):
         return kwargs["cmd_settings"]
 
     @cmd_settings_decorator
-    def complete_get_configs(self, text: str, line: str, begidx: int, endidx: int, **kwargs) -> List[str]:
+    def complete_get_config_registry(self, text: str, line: str, begidx: int, endidx: int, **kwargs) -> List[str]:
         return kwargs["cmd_settings"]
 
     @cmd_settings_decorator

sz_tools/sz_configtool

@@ -754,7 +754,7 @@ class SzCfgShell(cmd.Cmd):
         except SzError as err:
             colorize_msg(err, "error")
 
-    def do_getConfigList(self, arg):
+    def do_getConfigRegistry(self, arg):
         """
         Returns the list of all known configurations
 
@@ -763,7 +763,7 @@ class SzCfgShell(cmd.Cmd):
         """
         arg = self.check_arg_for_output_format("record", arg)
         try:
-            config_list = self.sz_configmgr.get_configs()
+            config_list = self.sz_configmgr.get_config_registry()
             self.print_json_record(json.loads(config_list)["CONFIGS"])
         except SzError as err:
             colorize_msg(err, "error")

sz_tools/sz_file_loader

@@ -608,7 +608,7 @@ def startup_info(
     try:
         lic_info = _json_loads(product.get_license())
         ver_info = _json_loads(product.get_version())
-        config_list = _json_loads(configmgr.get_configs())
+        config_list = _json_loads(configmgr.get_config_registry())
         active_cfg_id = engine.get_active_config_id()
         ds_info = _json_loads(diag.get_datastore_info())
     except SzError as err: