Merge pull request #2032 from OpenC3/py_help

Fix python help()

Author: jmthomas

openc3/python/openc3/utilities/logger.py

@@ -1,4 +1,4 @@
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -64,6 +64,10 @@ def __getattribute__(cls, func):
         if func in INSTANCE_ATTRS:
             return getattr(cls.instance(), func)
 
+        # Handle dunder methods to support help() and other introspection
+        if func.startswith("__") and func.endswith("__"):
+            return super().__getattribute__(func)
+
         def method(*args, **kw_args):
             return getattr(cls.instance(), func)(*args, **kw_args)
 

openc3/python/openc3/utilities/store_implementation.py

@@ -1,4 +1,4 @@
-# Copyright 2024 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -72,6 +72,10 @@ def __getattribute__(cls, func):
         if func == "instance" or func == "instance_mutex" or func == "my_instance":
             return super().__getattribute__(func)
 
+        # Handle dunder methods to support help() and other introspection
+        if func.startswith("__") and func.endswith("__"):
+            return super().__getattribute__(func)
+
         def method(*args, **kw_args):
             return getattr(cls.instance(), func)(*args, **kw_args)
 

openc3/python/test/utilities/test_logger.py

@@ -1,4 +1,4 @@
-# Copyright 2024 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -89,3 +89,6 @@ def test_error_prints_if_level_is_error_or_higher(self):
 
     def test_fatal_only_prints_if_level_is_fatal(self):
         self.verify_output(Logger.FATAL, "fatal")
+
+    def test_help(self):
+        help(Logger) # NOSONAR

openc3/python/test/utilities/test_store_implementation.py

@@ -0,0 +1,23 @@
+# Copyright 2025 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+import unittest
+from openc3.utilities.store_implementation import Store
+
+
+class TestStoreImplementation(unittest.TestCase):
+    def test_help(self):
+        help(Store) # NOSONAR