remove various optional attributes and fix user defined defaults

Author: gronke

.travis.yml

@@ -7,4 +7,4 @@ env:
 install:
   - pip3 install flake8-mutable flake8-builtins flake8-mypy
 script:
-  - flake8 --exclude=__init__.py --ignore=E203,W391
+  - flake8 --exclude=".*" --exclude=__init__.py --ignore=E203,W391

.travis/mypy-stubs/libzfs.pyi

@@ -3,7 +3,7 @@
 # NOTE: This dynamically typed stub was automatically generated by stubgen.
 
 from datetime import date
-from typing import Any
+from typing import Any, List, Dict, Optional
 
 DatasetType = ... # type: Any
 DiffFileType = ... # type: Any
@@ -54,21 +54,21 @@ class ZFS:
     datasets = ... # type: Any
     errno = ... # type: Any
     errstr = ... # type: Any
-    pools = ... # type: Any
+    pools: List[ZFSPool] = ...
     snapshots = ... # type: Any
     __pyx_vtable__ = ... # type: Any
-    def __init__(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs) -> None: ...
     def create(self, *args, **kwargs): ...
     def describe_resume_token(self, *args, **kwargs): ...
-    def destroy(self, *args, **kwargs): ...
+    def destroy(self, name: str) -> None: ...
     def export_pool(self, *args, **kwargs): ...
     def find_import(self, *args, **kwargs): ...
     def generate_history_opts(self, *args, **kwargs): ...
     def get(self, *args, **kwargs): ...
-    def get_dataset(self, *args, **kwargs): ...
-    def get_dataset_by_path(self, *args, **kwargs): ...
+    def get_dataset(self, name: str) -> ZFSDataset: ...
+    def get_dataset_by_path(self, *args, **kwargs) -> ZFSDataset: ...
     def get_object(self, *args, **kwargs): ...
-    def get_snapshot(self, *args, **kwargs): ...
+    def get_snapshot(self, name: str) -> ZFSSnapshot: ...
     def history_vdevs_list(self, *args, **kwargs): ...
     def import_pool(self, *args, **kwargs): ...
     def receive(self, *args, **kwargs): ...
@@ -88,23 +88,28 @@ class ZFSBookmark(ZFSObject):
 
 class ZFSDataset(ZFSObject):
     bookmarks = ... # type: Any
-    children = ... # type: Any
+    children: List[ZFSDataset] = ...
     children_recursive = ... # type: Any
     dependents = ... # type: Any
-    mountpoint = ... # type: Any
-    snapshots = ... # type: Any
+    mountpoint: str = ...
+    snapshots: List[ZFSSnapshot]= ...
     snapshots_recursive = ... # type: Any
     __pyx_vtable__ = ... # type: Any
     def __init__(self, *args, **kwargs): ...
     def destroy_snapshot(self, *args, **kwargs): ...
     def diff(self, *args, **kwargs): ...
     def get_send_progress(self, *args, **kwargs): ...
-    def mount(self, *args, **kwargs): ...
-    def mount_recursive(self, *args, **kwargs): ...
+    def mount(self, *args, **kwargs) -> None: ...
+    def mount_recursive(self, *args, **kwargs) -> None: ...
     def promote(self, *args, **kwargs): ...
     def receive(self, *args, **kwargs): ...
     def send(self, *args, **kwargs): ...
-    def snapshot(self, *args, **kwargs): ...
+    def snapshot(
+        self,
+        name: str, 
+        fsopts: Optional[Dict[str, str]],
+        recursive: bool=False
+    ) -> None: ...
     def umount(self, *args, **kwargs): ...
     def umount_recursive(self, *args, **kwargs): ...
     def __getstate__(self): ...
@@ -167,8 +172,8 @@ class ZFSPool:
     def __init__(self, *args, **kwargs): ...
     def attach_vdevs(self, *args, **kwargs): ...
     def clear(self, *args, **kwargs): ...
-    def create(self, *args, **kwargs): ...
-    def delete(self, *args, **kwargs): ...
+    def create(self, *args, **kwargs) -> None: ...
+    def delete(self, *args, **kwargs) -> None: ...
     def start_scrub(self, *args, **kwargs): ...
     def stop_scrub(self, *args, **kwargs): ...
     def upgrade(self, *args, **kwargs): ...
@@ -193,14 +198,14 @@ class ZFSProperty:
     def __setstate_cython__(self, *args, **kwargs): ...
 
 class ZFSPropertyDict(dict):
-    def __init__(self, *args, **kwargs): ...
-    def get(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs) -> None: ...
+    def get(self, *args, **kwargs) -> ZFSProperty: ...
     def has_key(self, *args, **kwargs): ...
     def items(self, *args, **kwargs): ...
     def iterkeys(self, *args, **kwargs): ...
     def itervalues(self, *args, **kwargs): ...
     def keys(self, *args, **kwargs): ...
-    def refresh(self, *args, **kwargs): ...
+    def refresh(self) -> None: ...
     def setdefault(self, *args, **kwargs): ...
     def update(self, *args, **kwargs): ...
     def values(self, *args, **kwargs): ...
@@ -214,16 +219,16 @@ class ZFSPropertyDict(dict):
 
 class ZFSSnapshot(ZFSObject):
     holds = ... # type: Any
-    mountpoint = ... # type: Any
+    mountpoint: str = ...
     parent = ... # type: Any
-    snapshot_name = ... # type: Any
-    def __init__(self, *args, **kwargs): ...
+    snapshot_name: str = ...
+    def __init__(self, *args, **kwargs) -> None: ...
     def bookmark(self, *args, **kwargs): ...
-    def clone(self, *args, **kwargs): ...
+    def clone(self, name: str, opts: Optional[Dict[str, str]]) -> None: ...
     def delete(self, *args, **kwargs): ...
     def hold(self, *args, **kwargs): ...
     def release(self, *args, **kwargs): ...
-    def rollback(self, *args, **kwargs): ...
+    def rollback(self, force: bool=False) -> None: ...
     def send(self, *args, **kwargs): ...
     def __getstate__(self): ...
     def __reduce_cython__(self, *args, **kwargs): ...
@@ -234,7 +239,7 @@ class ZFSUserProperty(ZFSProperty):
     rawvalue = ... # type: Any
     source = ... # type: Any
     value = ... # type: Any
-    def __init__(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs) -> None: ...
     def __reduce_cython__(self, *args, **kwargs): ...
     def __setstate_cython__(self, *args, **kwargs): ...
 

.travis/mypy-stubs/texttable.pyi

@@ -2,7 +2,7 @@
 #
 # NOTE: This dynamically typed stub was automatically generated by stubgen.
 
-from typing import Any
+from typing import Any, List
 
 class ArraySizeError(Exception):
     msg = ...  # type: Any
@@ -15,14 +15,18 @@ class Texttable:
     VLINES = ...  # type: Any
     def __init__(self, max_width: int = ...) -> None: ...
     def reset(self): ...
-    def set_chars(self, array): ...
+    def set_chars(self, array: List): ...
     def set_deco(self, deco): ...
-    def set_cols_align(self, array): ...
-    def set_cols_valign(self, array): ...
-    def set_cols_dtype(self, array): ...
-    def set_cols_width(self, array): ...
+    def set_cols_align(self, array: List): ...
+    def set_cols_valign(self, array: List): ...
+    def set_cols_dtype(self, array: List): ...
+    def set_cols_width(self, array: List): ...
     def set_precision(self, width): ...
-    def header(self, array): ...
-    def add_row(self, array): ...
-    def add_rows(self, rows, header: bool = ...): ...
-    def draw(self): ...
+    def header(self, array: List): ...
+    def add_row(self, array: List): ...
+    def add_rows(
+        self,
+        rows: List[List[str]],
+        header: bool = ...
+    ): ...
+    def draw(self) -> str: ...

.travis/mypy-stubs/ucl.pyi

@@ -8,6 +8,6 @@ UCL_EMIT_JSON_COMPACT = ... # type: int
 UCL_EMIT_MSGPACK = ... # type: int
 UCL_EMIT_YAML = ... # type: int
 
-def dump(*args, **kwargs): ...
-def load(*args, **kwargs): ...
+def dump(*args, **kwargs) -> str: ...
+def load(*args, **kwargs) -> dict: ...
 def validate(*args, **kwargs): ...

iocage/cli/create.py

@@ -144,7 +144,7 @@ def cli(ctx, release, template, count, props, pkglist, basejail, basejail_type,
     errors = False
     for i in range(count):
 
-        jail = iocage.lib.Jail.Jail(
+        jail = iocage.lib.Jail.JailGenerator(
             jail_data,
             logger=logger,
             host=host,
@@ -158,6 +158,7 @@ def cli(ctx, release, template, count, props, pkglist, basejail, basejail_type,
             msg = f"{jail.humanreadable_name} successfully created!{suffix}"
             logger.log(msg)
         except:
+            raise
             msg = f"{jail.humanreadable_name} could not be created!{suffix}"
             logger.warn(msg)
 

iocage/cli/set.py

@@ -48,7 +48,8 @@ def cli(
 ) -> None:
     """Get a list of jails and print the property."""
 
-    logger: libiocage.lib.Logger.Logger = ctx.parent.logger
+    parent: typing.Any = ctx.parent
+    logger: iocage.lib.Logger.Logger = parent.logger
     host = iocage.lib.Host.HostGenerator(logger=logger)
 
     # Defaults
@@ -70,15 +71,15 @@ def cli(
 
     updated_jail_count = 0
 
-    for jail in ioc_jails:
+    for ioc_jail in ioc_jails:  # type: iocage.lib.Jail.JailGenerator
 
-        updated_properties = set_properties(props, jail)
+        updated_properties = set_properties(props, ioc_jail)
 
         if len(updated_properties) == 0:
-            logger.screen(f"Jail '{jail.humanreadable_name}' unchanged")
+            logger.screen(f"Jail '{ioc_jail.humanreadable_name}' unchanged")
         else:
             logger.screen(
-                f"Jail '{jail.humanreadable_name}' updated: " +
+                f"Jail '{ioc_jail.humanreadable_name}' updated: " +
                 ", ".join(updated_properties)
             )
 
@@ -92,7 +93,7 @@ def cli(
 
 
 def set_properties(
-    properties: typing.List[str],
+    properties: typing.Iterable[str],
     target: 'iocage.lib.LaunchableResource.LaunchableResource'
 ) -> set:
 
@@ -111,6 +112,7 @@ def set_properties(
                 del target.config[key]
                 updated_properties.add(key)
             except:
+                raise
                 pass
 
     if len(updated_properties) > 0:

iocage/cli/start.py

@@ -98,7 +98,6 @@ def start_jails(jails, logger, print_function):
 
         except Exception:
             failed_jails.append(jail)
-            raise
             continue
 
         logger.log(f"{jail.humanreadable_name} running as JID {jail.jid}")

iocage/lib/Config/File.py

@@ -26,7 +26,7 @@
 
 class ConfigFile(iocage.lib.Config.Prototype.Prototype):
 
-    _file: str = None
+    _file: str
 
     def __init__(
         self,
@@ -38,7 +38,9 @@ def __init__(
             self,
             logger=logger
         )
-        self._file = file
+
+        if file is not None:
+            self._file = file
 
     @property
     def file(self) -> str:

iocage/lib/Config/Jail/BaseConfig.py

@@ -72,7 +72,7 @@ class BaseConfig(dict):
 
     def __init__(
         self,
-        logger: 'iocage.lib.Logger.Logger'=None,
+        logger: 'iocage.lib.Logger.Logger'=None
     ) -> None:
 
         dict.__init__(self)
@@ -484,20 +484,27 @@ def set(self, key: str, value, **kwargs) -> bool:
 
             bool: True if the JailConfig was changed
         """
+        hash_before: typing.Any
+        hash_after: typing.Any
+
+        existed_before = key in self.user_data
 
         try:
             hash_before = str(self.__getitem_user(key)).__hash__()
         except Exception:
             hash_before = None
-            pass
 
         self.__setitem__(key, value, **kwargs)
 
+        exists_after = key in self.user_data
+
         try:
             hash_after = str(self.__getitem_user(key)).__hash__()
         except Exception:
             hash_after = None
-            pass
+
+        if existed_before != exists_after:
+            return True
 
         return (hash_before != hash_after)
 
@@ -506,7 +513,7 @@ def user_data(self) -> dict:
         return self.data
 
     def __str__(self) -> str:
-        return iocage.lib.helpers.to_json(self.user_data)
+        return iocage.lib.helpers.to_json(self.data)
 
     def __dir__(self) -> list: