Add Categories.PRINT and Categories.SAVE

Categories.PRINT replaces the now-deprecated Categories.ENABLED, printing a log entry but not saving it. Categories.SAVE indicates an entry should be saved to the log file but not printed. Categories.ENABLED can still be used but will be removed in later versions. This commit also updates an out-of-date docstring for the Logger class.

Author: MollyMaclachlan

smooth_logger/Logger.py

@@ -15,19 +15,24 @@ class Logger:
     """
     Class for controlling the entirety of logging. The logging works on a scope-based system where
     (almost) every message has a defined scope, and the scopes are each associated with a specific
-    category between 0 and 2 inclusive. The meanings of the categories are as follows:
+    category defined by the smooth_logger.enums.Categories class. The categories' meanings are as
+    follows:
 
-    0: disabled, do not print to console or save to log file
-    1: enabled, print to console but do not save to log file
-    2: maximum, print to console and save to log file
+    Categories.DISABLED: do not print to console or save to log file
+    Categories.PRINT: print to console but do not save to log file
+    Categories.SAVE:  save to log file but do not print to console
+    Categories.MAXIMUM: print to console and save to log file
+
+    Note that the old Categories.ENABLED category is deprecated and its functionality has been
+    replaced with Categories.PRINT. It will be removed in a later version.
     """
     def __init__(self,
                  program_name: str,
                  config_path: str = None,
                  debug: int = Categories.DISABLED,
                  error: int = Categories.MAXIMUM,
                  fatal: int = Categories.MAXIMUM,
-                 info: int = Categories.ENABLED,
+                 info: int = Categories.PRINT,
                  warning: int = Categories.MAXIMUM) -> None:
         self.bar: ProgressBar = ProgressBar()
         self.is_empty: bool = True
@@ -110,7 +115,10 @@ def __display_log_entry(self,
         :param is_bar: whether the progress bar is active
         :param print_to_console: whether the message should be printed to the console
         """
-        if scope is None or (self._scopes[scope] != Categories.DISABLED and print_to_console):
+        if scope is None or (
+                self._scopes[scope] in [Categories.MAXIMUM, Categories.PRINT, Categories.ENABLED]
+                and print_to_console
+        ):
             print(entry.rendered)
         if is_bar:
             print(self.bar.state, end="\r", flush=True)
@@ -283,7 +291,7 @@ def new(self,
             output: bool = (
                 False
                 if scope is None else
-                self._scopes[scope] == Categories.MAXIMUM
+                self._scopes[scope] in [Categories.MAXIMUM, Categories.SAVE]
             )
             is_bar: bool = (self.bar is not None) and self.bar.opened
 

smooth_logger/enums.py

@@ -2,5 +2,8 @@
 
 class Categories(Enum):
     DISABLED = 0  # do not print to console or save to log file
-    ENABLED = 1   # print to console but do not save to log file
-    MAXIMUM = 2   # print to console and save to log file
+    PRINT    = 1  # print to console but do not save to log file
+    SAVE     = 2  # save to log file but do not print to console
+    MAXIMUM  = 3  # print to console and save to log file
+
+    ENABLED  = 4  # DEPRECATED: print to console but do not save to log file