Refactor/tests compliance

BlocksScreen/BlocksScreen.py

@@ -22,16 +22,15 @@
 RESET = "\033[0m"
 
 
-def setup_working_dir(): ...
-
-
 def setup_app_loggers():
-    ql = logger.create_logger(name="logs/BlocksScreen.log", level=logging.DEBUG)
+    """Setup logger"""
+    _ = logger.create_logger(name="logs/BlocksScreen.log", level=logging.DEBUG)
     _logger = logging.getLogger(name="logs/BlocksScreen.log")
     _logger.info("============ BlocksScreen Initializing ============")
 
 
 def show_splash(window: typing.Optional[QtWidgets.QWidget] = None):
+    """Show splash screen on app initialization"""
     logo = QtGui.QPixmap("BlocksScreen/BlocksScreen/lib/ui/resources/logoblocks.png")
     splash = QtWidgets.QSplashScreen(pixmap=logo)
     splash.setGeometry(QtCore.QRect(0, 0, 400, 200))

BlocksScreen/configfile.py

@@ -47,10 +47,14 @@
 
 
 class Sentinel(enum.Enum):
+    """Sentinel value to signify missing condition, absence of value"""
+
     MISSING = object
 
 
 class ConfigError(Exception):
+    """Exception raised when Configfile errors exist"""
+
     def __init__(self, msg) -> None:
         super().__init__(msg)
         self.msg = msg
@@ -59,24 +63,10 @@ def __init__(self, msg) -> None:
 class BlocksScreenConfig:
     config = configparser.ConfigParser(
         allow_no_value=True,
-        # interpolation=configparser.ExtendedInterpolation(),
-        # delimiters=(":"),
-        # inline_comment_prefixes=("#"),
-        # comment_prefixes=("#", "#~#"),
-        # empty_lines_in_values=True,
     )
-
     update_pending: bool = False
-
     _instance = None
 
-    # def __new__(
-    #     cls, *args, **kwargs
-    # ) -> BlocksScreenConfig:  # Singleton pattern
-    #     if not cls._instance:
-    #         cls._instance = super(BlocksScreenConfig, cls).__new__(cls)
-    #     return cls._instance
-
     def __init__(
         self, configfile: typing.Union[str, pathlib.Path], section: str
     ) -> None:
@@ -93,24 +83,41 @@ def __contains__(self, key):
         return key in self.config
 
     def sections(self) -> typing.List[str]:
+        """Returns list of all sections"""
         return self.config.sections()
 
     def get_section(
         self, section: str, fallback: typing.Optional[T] = None
     ) -> BlocksScreenConfig:
+        """Get configfile section"""
         if not self.config.has_section(section):
-            raise configparser.NoSectionError(
-                f"No section with name: {section}"
-            )
+            raise configparser.NoSectionError(f"No section with name: {section}")
         return BlocksScreenConfig(self.configfile, section)
 
     def get_options(self) -> list:
+        """Get section options"""
         return self.config.options(self.section)
 
     def has_section(self, section: str) -> bool:
+        """Check if config file has a section
+
+        Args:
+            section (str): section name
+
+        Returns:
+            bool: true if section exists, false otherwise
+        """
         return bool(self.config.has_section(section))
 
     def has_option(self, option: str) -> bool:
+        """Check if section has a option
+
+        Args:
+            option (str): option name
+
+        Returns:
+            bool: true if section exists, false otherwise
+        """
         return bool(self.config.has_option(self.section, option))
 
     def get(
@@ -119,26 +126,50 @@ def get(
         parser: type = str,
         default: typing.Union[Sentinel, str, T] = Sentinel.MISSING,
     ) -> typing.Union[Sentinel, str]:
+        """Get option value
+
+        Args:
+            option (str): option name
+            parser (type, optional): bool, float, int. Defaults to str.
+            default (typing.Union[Sentinel, str, T], optional): Default value for specified option. Defaults to Sentinel.MISSING.
+
+        Returns:
+            typing.Union[Sentinel, str]: Requested option. Defaults to the specified default value
+        """
         return parser(
-            self.config.get(
-                section=self.section, option=option, fallback=default
-            )
+            self.config.get(section=self.section, option=option, fallback=default)
         )
 
     def getint(
         self,
         option: str,
         default: typing.Union[Sentinel, int] = Sentinel.MISSING,
     ) -> typing.Union[Sentinel, int]:
-        return self.config.getint(
-            section=self.section, option=option, fallback=default
-        )
+        """Get option value
+
+        Args:
+            option (str): option name
+            default (typing.Union[Sentinel, int], optional): Default value for specified option. Defaults to Sentinel.MISSING.
+
+        Returns:
+            typing.Union[Sentinel, int]: Requested option.
+        """
+        return self.config.getint(section=self.section, option=option, fallback=default)
 
     def getfloat(
         self,
         option: str,
         default: typing.Union[Sentinel, float] = Sentinel.MISSING,
     ) -> typing.Union[Sentinel, float]:
+        """Get the value for the specified option
+
+        Args:
+            option (str): option name
+            default (typing.Union[Sentinel, float], optional): Default value for specified option. Defaults to Sentinel.MISSING.
+
+        Returns:
+            typing.Union[Sentinel, float]: _description_
+        """
         return self.config.getfloat(
             section=self.section, option=option, fallback=default
         )
@@ -148,6 +179,15 @@ def getboolean(
         option: str,
         default: typing.Union[Sentinel, bool] = Sentinel.MISSING,
     ) -> typing.Union[Sentinel, bool]:
+        """Get option value
+
+        Args:
+            option (str): option name
+            default (typing.Union[Sentinel, bool], optional): Default value for specified option. Defaults to Sentinel.MISSING.
+
+        Returns:
+            typing.Union[Sentinel, bool]: _description_
+        """
         return self.config.getboolean(
             section=self.section, option=option, fallback=default
         )
@@ -156,9 +196,7 @@ def _find_section_index(self, section: str) -> int:
         try:
             return self.raw_config.index("[" + section + "]")
         except ValueError as e:
-            raise configparser.Error(
-                f'Section "{section}" does not exist: {e}'
-            )
+            raise configparser.Error(f'Section "{section}" does not exist: {e}')
 
     def _find_section_limits(self, section: str) -> typing.Tuple:
         try:
@@ -189,6 +227,14 @@ def _find_option_index(
             )
 
     def add_section(self, section: str) -> None:
+        """Add a section to configuration file
+
+        Args:
+            section (str): section name
+
+        Raises:
+            configparser.DuplicateSectionError: Exception thrown when section is duplicated
+        """
         try:
             with self.file_lock:
                 sec_string = f"[{section}]"
@@ -209,16 +255,21 @@ def add_section(self, section: str) -> None:
         except configparser.DuplicateSectionError as e:
             logging.error(f'Section "{section}" already exists. {e}')
         except configparser.Error as e:
-            logging.error(
-                f'Unable to add "{section}" section to configuration: {e}'
-            )
+            logging.error(f'Unable to add "{section}" section to configuration: {e}')
 
     def add_option(
         self,
         section: str,
         option: str,
         value: typing.Union[str, None] = None,
     ) -> None:
+        """Add option with a value to a section
+
+        Args:
+            section (str): section name
+            option (str): option name
+            value (typing.Union[str, None], optional): value for the specified option. Defaults to None.
+        """
         try:
             with self.file_lock:
                 section_start, section_end = self._find_section_limits(section)
@@ -239,13 +290,12 @@ def add_option(
             )
 
     def save_configuration(self) -> None:
+        """Save teh configuration to file"""
         try:
             if not self.update_pending:
                 return
             with self.file_lock:
-                self.configfile.write_text(
-                    "\n".join(self.raw_config), encoding="utf-8"
-                )
+                self.configfile.write_text("\n".join(self.raw_config), encoding="utf-8")
                 sio = io.StringIO()
                 sio.writelines(self.raw_config)
                 self.config.write(sio)
@@ -257,13 +307,8 @@ def save_configuration(self) -> None:
         finally:
             self.update_pending = False
 
-    def _do_save(self, data) -> bool:
-        try:
-            return True
-        except Exception as e:
-            return False
-
     def load_config(self):
+        """Load configuration file"""
         try:
             self.raw_config.clear()
             self.config.clear()  # Reset configparser
@@ -330,20 +375,17 @@ def _parse_file(self) -> typing.Tuple[typing.List[str], typing.Dict]:
 
 
 def get_configparser() -> BlocksScreenConfig:
+    """Loads configuration from file and returns that configuration"""
     wanted_target = os.path.join(DEFAULT_CONFIGFILE_PATH, "BlocksScreen.cfg")
     fallback = os.path.join(WORKING_DIR, "BlocksScreen.cfg")
     configfile = (
         wanted_target
         if check_file_on_path(DEFAULT_CONFIGFILE_PATH, "BlocksScreen.cfg")
         else fallback
     )
-    try:
-        config_object = BlocksScreenConfig(
-            configfile=configfile, section="server"
-        )
-        config_object.load_config()
-        if not config_object.has_section("server"):
-            raise ConfigError("Section [server] is missing from configuration")
-    except ConfigError:
+    config_object = BlocksScreenConfig(configfile=configfile, section="server")
+    config_object.load_config()
+    if not config_object.has_section("server"):
         logging.error("Error loading configuration file for the application.")
+        raise ConfigError("Section [server] is missing from configuration")
     return BlocksScreenConfig(configfile=configfile, section="server")