add type annotations for when mypy feels confused

use 'forward references' of types that haven't been properly imported yet
Including IocageEvent - which is referenced from from itself!

Author: igalic

libiocage/__init__.py

@@ -21,10 +21,10 @@
 # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
+from libiocage.lib import errors, events
+from libiocage.lib.Host import Host
 from libiocage.lib.Jail import Jail
 from libiocage.lib.Jails import Jails
+from libiocage.lib.Logger import Logger
 from libiocage.lib.Release import Release
 from libiocage.lib.Releases import Releases
-from libiocage.lib.Host import Host
-from libiocage.lib.Logger import Logger
-from libiocage.lib import errors

libiocage/cli/__init__.py

@@ -35,7 +35,7 @@
 
 logger = Logger()
 
-click.core._verify_python3_env = lambda: None
+click.core._verify_python3_env = lambda: None  # type: ignore
 user_locale = os.environ.get("LANG", "en_US.UTF-8")
 locale.setlocale(locale.LC_ALL, user_locale)
 
@@ -148,8 +148,7 @@ def get_command(self, ctx, name):
 
 @click.option("--log-level", "-d", default=None)
 @click.command(cls=IOCageCLI)
-@click.version_option(version="0.2.11 08/29/2017", prog_name="ioc",
-                      message="%(version)s")
+@click.version_option(version="0.2.11 08/29/2017", prog_name="ioc")
 @click.pass_context
 def cli(ctx, log_level):
     """A jail manager."""

libiocage/lib/Host.py

@@ -91,4 +91,4 @@ def processor(self):
 
 class Host(HostGenerator):
 
-    class_distribution = libiocage.lib.Distribution.DistributionGenerator
+    _class_distribution = libiocage.lib.Distribution.DistributionGenerator

libiocage/lib/Jail.py

@@ -84,9 +84,6 @@ class JailGenerator:
             release (stored in `zpool/iocage/base/<RELEASE>)
     """
 
-    _class_host = libiocage.lib.Host.HostGenerator
-    _class_storage = libiocage.lib.Storage.Storage
-
     def __init__(self, data={}, zfs=None, host=None, logger=None, new=False):
         """
         Initializes a Jail
@@ -124,7 +121,7 @@ def __init__(self, data={}, zfs=None, host=None, logger=None, new=False):
 
         self.networks = []
 
-        self.storage = self._class_storage(
+        self.storage = libiocage.lib.Storage.Storage(
             auto_create=True,
             safe_mode=False,
             jail=self,

libiocage/lib/JailFilter.py

@@ -21,10 +21,11 @@
 # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-from typing import List, Union, Iterable
 import re
-import libiocage.lib.Jail
+from typing import Iterable, List, Union
+
 import libiocage.lib.errors
+import libiocage.lib.Jail
 
 
 def match_filter(value: str, filter_string: str):
@@ -54,7 +55,7 @@ def __init__(self, key, values=list()):
 
         list.__init__(self, data)
 
-    def matches_jail(self, jail: libiocage.lib.Jail.JailGenerator) -> bool:
+    def matches_jail(self, jail: 'libiocage.lib.Jail.JailGenerator') -> bool:
         return self.matches(jail.getstring(self.key))
 
     def matches(self, value: str) -> bool:
@@ -83,7 +84,7 @@ def _filter_string_has_globs(self, filter_string: str) -> bool:
         return False
 
     def _split_filter_values(self, user_input: str) -> List[str]:
-        values = []
+        values: List[str] = []
         escaped_comma_blocks = map(
             lambda block: block.split(","),
             user_input.split("\\,")
@@ -124,9 +125,9 @@ class Terms(list):
     This can be interpreted as logical AND
     """
 
-    def __init__(self, terms: Iterable[Union[Term, str]]=None):
+    def __init__(self, terms: Iterable[Union[Term, str]]=None) -> None:
 
-        data = []
+        data: List[Union[Term, str]] = []
 
         if terms is not None:
 
@@ -138,7 +139,7 @@ def __init__(self, terms: Iterable[Union[Term, str]]=None):
 
         list.__init__(self, data)
 
-    def match_jail(self, jail: libiocage.lib.Jail.JailGenerator) -> bool:
+    def match_jail(self, jail: 'libiocage.lib.Jail.JailGenerator') -> bool:
         """
         Returns True if all Terms match the jail
         """

libiocage/lib/Jails.py

@@ -98,7 +98,7 @@ def jail_datasets(self) -> list:
     def _load_jail_from_dataset(
         self,
         dataset: libzfs.ZFSDataset
-    ) -> Generator[libiocage.lib.Jail.JailGenerator, None, None]:
+    ) -> Generator['libiocage.lib.Jail.JailGenerator', None, None]:
 
         return self._create_jail({
             "name": self._get_name_from_jail_dataset(dataset)

libiocage/lib/Logger.py

@@ -26,6 +26,8 @@
 
 import libiocage.lib.errors
 
+from typing import List
+
 
 class LogEntry:
 
@@ -100,7 +102,7 @@ class Logger:
 
     INDENT_PREFIX = "  "
 
-    PRINT_HISTORY = []
+    PRINT_HISTORY: List[str] = []
 
     def __init__(self, print_level=None, log_directory="/var/log/iocage"):
         self._print_level = print_level

libiocage/lib/errors.py

@@ -412,7 +412,13 @@ def __init__(self, *args, **kwargs):
 
 class MissingFeature(IocageException, NotImplementedError):
 
-    def __init__(self, feature_name: str, plural: bool=False, *args, **kwargs):
+    def __init__(
+            self,
+            feature_name: str,
+            plural: bool=False,
+            *args,
+            **kwargs
+    ) -> None:
         message = (
             f"Missing Feature: '{feature_name}' "
             "are" if plural is True else "is"

libiocage/lib/events.py

@@ -22,6 +22,8 @@
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 from timeit import default_timer as timer
+from typing import List
+
 import libiocage.lib.errors
 
 EVENT_STATUS = (
@@ -38,7 +40,7 @@ class IocageEvent:
     Base class for all other iocage events
     """
 
-    HISTORY = []
+    HISTORY: List['IocageEvent'] = []
 
     PENDING_COUNT = 0