be more specific about typing information

* add Optional where needed (even if it was implicit thru = None)
* fix JailConfig type hints: we were pointing to the wrong thing
* Logger now has types
* error: take *Any* value, it's an error after all

Author: igalic

iocage/lib/Config/Jail/BaseConfig.py

@@ -279,31 +279,43 @@ def _set_basejail(self, value, **kwargs):
     def _get_clonejail(self) -> bool:
         return iocage.lib.helpers.parse_bool(self.data["clonejail"])
 
-    def _set_clonejail(self, value, **kwargs):
+    def _set_clonejail(
+            self,
+            value: str,
+            **kwargs) -> typing.Optional[str]:
         self.data["clonejail"] = self.stringify(value)
 
-    def _get_defaultrouter(self):
+    def _get_defaultrouter(self) -> typing.Optional[str]:
         value = self.data['defaultrouter']
         return value if (value != "none" and value is not None) else None
 
-    def _set_defaultrouter(self, value, **kwargs):
+    def _set_defaultrouter(
+            self,
+            value: typing.Optional[str],
+            **kwargs) -> None:
         if value is None:
             value = 'none'
         self.data['defaultrouter'] = value
 
-    def _get_defaultrouter6(self):
+    def _get_defaultrouter6(self) -> typing.Optional[str]:
         value = self.data['defaultrouter6']
         return value if (value != "none" and value is not None) else None
 
-    def _set_defaultrouter6(self, value, **kwargs):
+    def _set_defaultrouter6(
+            self,
+            value: typing.Optional[str],
+            **kwargs) -> None:
         if value is None:
             value = 'none'
         self.data['defaultrouter6'] = value
 
     def _get_vnet(self):
         return iocage.lib.helpers.parse_user_input(self.data["vnet"])
 
-    def _set_vnet(self, value, **kwargs):
+    def _set_vnet(
+            self,
+            value: str,
+            **kwargs) -> None:
         self.data["vnet"] = iocage.lib.helpers.to_string(
             value,
             true="on",

iocage/lib/Config/Jail/Properties/Addresses.py

@@ -32,7 +32,9 @@ class AddressSet(set):
 
     def __init__(
         self,
-        config: typing.Optional['iocage.lib.JailConfig.JailConfig']=None,
+        config: typing.Optional[
+            iocage.lib.Config.Jail.JailConfig.JailConfig
+        ]=None,
         property_name: str="ip4_address"
     ) -> None:
 

iocage/lib/Config/Jail/Properties/Interfaces.py

@@ -25,16 +25,18 @@
 
 import iocage.lib.helpers
 
-_ConfigType = 'iocage.lib.Config.Jail.JailConfig.JailConfig'
+_ConfigType = iocage.lib.Config.Jail.JailConfig.JailConfig
 
 
 class BridgeSet(set):
 
-    config: 'iocage.lib.JailConfig.JailConfig'
+    config: iocage.lib.Config.Jail.JailConfig.JailConfig
 
     def __init__(
         self,
-        config: typing.Optional['iocage.lib.JailConfig.JailConfig']=None
+        config: typing.Optional[
+            iocage.lib.Config.Jail.JailConfig.JailConfig
+        ]=None
     ) -> None:
 
         if config is not None:
@@ -58,12 +60,14 @@ def __notify(self) -> None:
 
 class InterfaceProp(dict):
 
-    config: 'iocage.lib.Config.Jail.JailConfig.JailConfig'
+    config: iocage.lib.Config.Jail.JailConfig.JailConfig
     property_name: str = "interfaces"
 
     def __init__(
         self,
-        config: typing.Optional['iocage.lib.JailConfig.JailConfig']=None,
+        config: typing.Optional[
+            iocage.lib.Config.Jail.JailConfig.JailConfig
+        ]=None,
         **kwargs
     ) -> None:
 

iocage/lib/Logger.py

@@ -23,11 +23,10 @@
 # POSSIBILITY OF SUCH DAMAGE.
 import os
 import sys
+import typing
 
 import iocage.lib.errors
 
-from typing import List
-
 
 class LogEntry:
 
@@ -102,42 +101,45 @@ class Logger:
 
     INDENT_PREFIX = "  "
 
-    PRINT_HISTORY: List[str] = []
+    PRINT_HISTORY: typing.List[str] = []
 
-    def __init__(self, print_level=None, log_directory="/var/log/iocage"):
+    def __init__(
+            self,
+            print_level: typing.Optional[str]=None,
+            log_directory: str="/var/log/iocage"
+    ) -> None:
         self._print_level = print_level
         self._set_log_directory(log_directory)
 
     @property
-    def default_print_level(self):
+    def default_print_level(self) -> str:
         return "info"
 
     @property
-    def print_level(self):
+    def print_level(self) -> str:
         if self._print_level is None:
             return self.default_print_level
         else:
             return self._print_level
 
     @print_level.setter
-    def print_level(self, value):
+    def print_level(self, value: str) -> None:
         self._print_level = value
 
-    def _set_log_directory(self, log_directory):
+    def _set_log_directory(self, log_directory: str) -> None:
         self.log_directory = os.path.abspath(log_directory)
         if not os.path.isdir(log_directory):
             self._create_log_directory()
         self.log(f"Log directory set to '{log_directory}'", level="spam")
 
-    def log(self, *args, **kwargs):
-
-        args = list(args)
+    def log(self, *args, **kwargs) -> LogEntry:
+        log_args = list(args)
 
-        if ("message" not in kwargs) and (len(args) > 0):
-            kwargs["message"] = args.pop(0)
+        if ("message" not in kwargs) and (len(log_args) > 0):
+            kwargs["message"] = log_args.pop(0)
 
-        if ("level" not in kwargs) and (len(args) > 0):
-            kwargs["level"] = args.pop(0)
+        if ("level" not in kwargs) and (len(log_args) > 0):
+            kwargs["level"] = log_args.pop(0)
 
         if "level" not in kwargs:
             kwargs["level"] = "info"
@@ -146,32 +148,32 @@ def log(self, *args, **kwargs):
 
         if self._should_print_log_entry(log_entry):
             self._print_log_entry(log_entry)
-            self.PRINT_HISTORY.append(log_entry)
+            self.PRINT_HISTORY.append(log_entry.message)
 
         return log_entry
 
-    def verbose(self, message, indent=0, **kwargs):
+    def verbose(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         return self.log(message, level="verbose", indent=indent, **kwargs)
 
-    def error(self, message, indent=0, **kwargs):
+    def error(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         return self.log(message, level="error", indent=indent, **kwargs)
 
-    def warn(self, message, indent=0, **kwargs):
+    def warn(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         return self.log(message, level="warn", indent=indent, **kwargs)
 
-    def debug(self, message, indent=0, **kwargs):
+    def debug(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         return self.log(message, level="debug", indent=indent, **kwargs)
 
-    def spam(self, message, indent=0, **kwargs):
+    def spam(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         return self.log(message, level="spam", indent=indent, **kwargs)
 
-    def screen(self, message, indent=0, **kwargs):
+    def screen(self, message: str, indent: int=0, **kwargs) -> LogEntry:
         """
         Screen never gets printed to log files
         """
         return self.log(message, level="screen", indent=indent, **kwargs)
 
-    def redraw(self, log_entry):
+    def redraw(self, log_entry: LogEntry) -> None:
 
         if log_entry not in self.PRINT_HISTORY:
             raise iocage.lib.errors.CannotRedrawLine(
@@ -182,12 +184,12 @@ def redraw(self, log_entry):
             raise iocage.lib.errors.CannotRedrawLine(
                 reason=(
                     "Log level 'screen' is required to redraw, "
-                    f"but got '{self.level}'"
+                    f"but got '{log_entry.level}'"
                 )
             )
 
         # calculate the delta of messages printed since
-        i = self.PRINT_HISTORY.index(log_entry)
+        i = self.PRINT_HISTORY.index(log_entry.message)
         n = len(self.PRINT_HISTORY)
         delta = sum(map(lambda i: len(self.PRINT_HISTORY[i]), range(i, n)))
 

iocage/lib/errors.py

@@ -300,7 +300,7 @@ class UnmountFailed(IocageException):
 
     def __init__(
         self,
-        mountpoint: iocage.lib.Types.AbsolutePath,
+        mountpoint: typing.Any,
         *args,
         **kwargs
     ) -> None: