Merge pull request #1597 from romanroibu/fix-plugin-custom-naming

Fix plugin custom naming

Author: papr

pupil_src/shared_modules/blink_detection.py

@@ -47,6 +47,10 @@ class Blink_Detection(Analysis_Plugin_Base):
     icon_chr = chr(0xE81A)
     icon_font = "pupil_icons"
 
+    @classmethod
+    def parse_pretty_class_name(cls) -> str:
+        return "Blink Detector"
+
     def __init__(
         self,
         g_pool,

pupil_src/shared_modules/eye_movement/eye_movement_detector_base.py

@@ -14,3 +14,7 @@
 class Eye_Movement_Detector_Base(Analysis_Plugin_Base):
     icon_chr = chr(0xEC03)
     icon_font = "pupil_icons"
+    @classmethod
+
+    def parse_pretty_class_name(cls) -> str:
+        return "Eye Movement Detector"

pupil_src/shared_modules/fixation_detector.py

@@ -53,6 +53,10 @@ class Fixation_Detector_Base(Analysis_Plugin_Base):
     icon_chr = chr(0xEC03)
     icon_font = "pupil_icons"
 
+    @classmethod
+    def parse_pretty_class_name(cls) -> str:
+        return "Fixation Detector"
+
 
 def fixation_from_data(dispersion, method, base_data, timestamps=None):
     norm_pos = np.mean([gp["norm_pos"] for gp in base_data], axis=0).tolist()

pupil_src/shared_modules/head_pose_tracker/base_head_pose_tracker.py

@@ -0,0 +1,23 @@
+"""
+(*)~---------------------------------------------------------------------------
+Pupil - eye tracking platform
+Copyright (C) 2012-2019 Pupil Labs
+
+Distributed under the terms of the GNU
+Lesser General Public License (LGPL v3.0).
+See COPYING and COPYING.LESSER for license details.
+---------------------------------------------------------------------------~(*)
+"""
+
+from observable import Observable
+from plugin import Plugin
+
+
+class Head_Pose_Tracker_Base(Plugin, Observable):
+
+    icon_chr = chr(0xEC07)
+    icon_font = "pupil_icons"
+
+    @classmethod
+    def parse_pretty_class_name(cls) -> str:
+        return "Head Pose Tracker"

pupil_src/shared_modules/head_pose_tracker/offline_head_pose_tracker.py

@@ -14,21 +14,18 @@
 import csv_utils
 import player_methods as pm
 from head_pose_tracker import ui as plugin_ui, controller, storage
-from observable import Observable
-from plugin import Plugin
 from plugin_timeline import PluginTimeline
 from tasklib.manager import PluginTaskManager
 
+from .base_head_pose_tracker import Head_Pose_Tracker_Base
 
-class Offline_Head_Pose_Tracker(Plugin, Observable):
+
+class Offline_Head_Pose_Tracker(Head_Pose_Tracker_Base):
     """
     This plugin tracks the pose of the scene camera based on fiducial markers in the
     environment.
     """
 
-    icon_chr = chr(0xEC07)
-    icon_font = "pupil_icons"
-
     def __init__(self, g_pool):
         super().__init__(g_pool)
 

pupil_src/shared_modules/head_pose_tracker/online_head_pose_tracker.py

@@ -10,21 +10,17 @@
 """
 
 from head_pose_tracker import ui as plugin_ui, controller, storage
-
-from observable import Observable
-from plugin import Plugin
 from tasklib.manager import PluginTaskManager
 
+from .base_head_pose_tracker import Head_Pose_Tracker_Base
+
 
-class Online_Head_Pose_Tracker(Plugin, Observable):
+class Online_Head_Pose_Tracker(Head_Pose_Tracker_Base):
     """
     This plugin tracks the pose of the scene camera based on fiducial markers in the
     environment.
     """
 
-    icon_chr = chr(0xEC07)
-    icon_font = "pupil_icons"
-
     def __init__(
         self,
         g_pool,

pupil_src/shared_modules/plugin.py

@@ -240,7 +240,11 @@ def base_class_name(self):
 
     @property
     def pretty_class_name(self):
-        return self.class_name.replace("_", " ")
+        return self.__class__.parse_pretty_class_name()
+
+    @classmethod
+    def parse_pretty_class_name(cls) -> str:
+        return cls.__name__.replace("_", " ")
 
     def add_menu(self):
         """

pupil_src/shared_modules/plugin_manager.py

@@ -60,7 +60,7 @@ def getter():
 
             return ui.Switch(
                 p.__name__,
-                label=p.__name__.replace("_", " "),
+                label=p.parse_pretty_class_name(),
                 setter=setter,
                 getter=getter,
             )

pupil_src/shared_modules/surface_tracker/surface_tracker.py

@@ -38,6 +38,10 @@ class Surface_Tracker(Plugin, metaclass=ABCMeta):
     icon_chr = chr(0xEC07)
     icon_font = "pupil_icons"
 
+    @classmethod
+    def parse_pretty_class_name(cls) -> str:
+        return "Surface Tracker"
+
     def __init__(
         self,
         g_pool,