From 7a50a106e333ed472dcb8fa6dfd7acc7e71d5efb Mon Sep 17 00:00:00 2001 From: iLLiCiTiT Date: Thu, 21 Oct 2021 15:05:20 +0200 Subject: [PATCH] added few docstrings --- .../tools/experimental_tools/tools_def.py | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/openpype/tools/experimental_tools/tools_def.py b/openpype/tools/experimental_tools/tools_def.py index 5dd92151ca..6ae4637039 100644 --- a/openpype/tools/experimental_tools/tools_def.py +++ b/openpype/tools/experimental_tools/tools_def.py @@ -8,6 +8,8 @@ LOCAL_EXPERIMENTAL_KEY = "experimental_tools" class ExperimentalTool: """Definition of experimental tool. + Definition is used in local settings and in experimental tools dialog. + Args: identifier (str): String identifier of tool (unique). label (str): Label shown in UI. @@ -91,11 +93,32 @@ class ExperimentalTools: ).format(tool.identifier)) tools_by_identifier[tool.identifier] = tool - self.tools_by_identifier = tools_by_identifier - self.tools = experimental_tools + self._tools_by_identifier = tools_by_identifier + self._tools = experimental_tools self._parent_widget = parent + @property + def tools(self): + """Tools in list. + + Returns: + list: Tools filtered by host name if filtering was enabled + on initialization. + """ + return self._tools + + @property + def tools_by_identifier(self): + """Tools by their identifier. + + Returns: + dict: Tools by identifier filtered by host name if filtering + was enabled on initialization. + """ + return self._tools_by_identifier + def refresh_availability(self): + """Reload local settings and check if any tool changed ability.""" local_settings = get_local_settings() experimental_settings = ( local_settings.get(LOCAL_EXPERIMENTAL_KEY)