Add name to Formatters. Relates to #195.

aussig · Apr 10, 2024 · c1fca25 · c1fca25
1 parent cacbc1c
commit c1fca25
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/bgstally/formatters/base.py b/bgstally/formatters/base.py
@@ -1,6 +1,7 @@
 from bgstally.activity import Activity
 from bgstally.constants import DiscordActivity
 from bgstally.state import State
+from bgstally.utils import _
 
 
 class FormatterInterface:
@@ -16,6 +17,15 @@ def __init__(self, state: State):
         self.state: State = state
 
 
+    def get_name(self) -> str:
+        """Get the name of this formatter
+
+        Returns:
+            str: The name of this formatter for choosing in the UI
+        """
+        pass
+
+
     def generate_text(self, activity: Activity, activity_mode: DiscordActivity, discord: bool = False, system_names: list = None, lang: str = None) -> str:
         """Generate formatted text for a given instance of Activity
 

diff --git a/bgstally/formatters/default.py b/bgstally/formatters/default.py
@@ -21,6 +21,15 @@ def __init__(self, state: State):
         super(DefaultFormatter, self).__init__(state)
 
 
+    def get_name(self) -> str:
+        """Get the name of this formatter for presenting in the UI
+
+        Returns:
+            str: The name
+        """
+        return _("Default") # LANG: Name of default output formatter
+
+
     def generate_text(self, activity: Activity, activity_mode: DiscordActivity, discord: bool = False, system_names: list = None, lang: str = None) -> str:
         """Generate formatted text for a given instance of Activity