appier 1.31.4__py2.py3-none-any.whl → 1.32.0__py2.py3-none-any.whl

appier/component.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Hive Appier Framework
-# Copyright (c) 2008-2022 Hive Solutions Lda.
+# Copyright (c) 2008-2024 Hive Solutions Lda.
 #
 # This file is part of Hive Appier Framework.
 #
@@ -22,16 +22,7 @@
 __author__ = "João Magalhães <joamag@hive.pt>"
 """ The author(s) of the module """
 
-__version__ = "1.0.0"
-""" The version of the module """
-
-__revision__ = "$LastChangedRevision$"
-""" The revision number of the module """
-
-__date__ = "$LastChangedDate$"
-""" The last change date of the module """
-
-__copyright__ = "Copyright (c) 2008-2022 Hive Solutions Lda."
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
 """ The copyright for the module """
 
 __license__ = "Apache License, Version 2.0"
@@ -42,6 +33,7 @@ import logging
 from . import util
 from . import common
 
+
 class Component(object):
     """
     Top level component class to be used as an abstract definition
@@ -51,7 +43,7 @@ class Component(object):
     component should behave and the life-cycle stages for it.
     """
 
-    def __init__(self, name = "component", owner = None, *args, **kwargs):
+    def __init__(self, name="component", owner=None, *args, **kwargs):
         object.__init__(self)
         self.id = util.gen_token()
         self.name = name
@@ -59,12 +51,14 @@ class Component(object):
         self.loaded = False
 
     def load(self, *args, **kwargs):
-        if self.is_loaded: return
+        if self.is_loaded:
+            return
         self._load(*args, **kwargs)
         return self
 
     def unload(self, *args, **kwargs):
-        if not self.is_loaded: return
+        if not self.is_loaded:
+            return
         self._unload(*args, **kwargs)
         return self
 
@@ -72,10 +66,12 @@ class Component(object):
         set_state = kwargs.get("set_state", True)
         owner = self.owner
         state = self.get_state()
-        if self.is_loaded: self.unload()
+        if self.is_loaded:
+            self.unload()
         self.owner = owner
         self.load()
-        if set_state: self.set_state(state)
+        if set_state:
+            self.set_state(state)
 
     def get_state(self):
         return self._get_state()
@@ -85,8 +81,10 @@ class Component(object):
 
     @property
     def logger(self):
-        if self.owner: return self.owner.logger
-        else: return logging.getLogger()
+        if self.owner:
+            return self.owner.logger
+        else:
+            return logging.getLogger()
 
     @property
     def is_loaded(self):
@@ -100,7 +98,7 @@ class Component(object):
         self.loaded = False
 
     def _get_state(self):
-        return dict(owner = self.owner)
+        return dict(owner=self.owner)
 
     def _set_state(self, state):
         self.owner = state.get("owner", None)

appier/compress.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Hive Appier Framework
-# Copyright (c) 2008-2022 Hive Solutions Lda.
+# Copyright (c) 2008-2024 Hive Solutions Lda.
 #
 # This file is part of Hive Appier Framework.
 #
@@ -22,16 +22,7 @@
 __author__ = "João Magalhães <joamag@hive.pt>"
 """ The author(s) of the module """
 
-__version__ = "1.0.0"
-""" The version of the module """
-
-__revision__ = "$LastChangedRevision$"
-""" The revision number of the module """
-
-__date__ = "$LastChangedDate$"
-""" The last change date of the module """
-
-__copyright__ = "Copyright (c) 2008-2022 Hive Solutions Lda."
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
 """ The copyright for the module """
 
 __license__ = "Apache License, Version 2.0"
@@ -42,40 +33,42 @@ import os
 from . import legacy
 from . import exceptions
 
-class Compress(object):
 
+class Compress(object):
     def __init__(self):
         self._load_compress()
 
     def load_jsmin(self):
-        try: import jsmin
-        except ImportError: self.jsmin = None; return
+        try:
+            import jsmin
+        except ImportError:
+            self.jsmin = None
+            return
         self.jsmin = jsmin
 
     def type_jpeg(self):
         return "image/jpeg"
 
-    def compress(self, file_path, modified = None, method = None):
+    def compress(self, file_path, modified=None, method=None):
         # retrieves the modification data from the requested file and
         # uses it to construct the complete (cache) key to be used in
         # cache try, in case there's a match returns the new file
         modified = modified or os.path.getmtime(file_path)
         key = "%s:%s" % (method, file_path)
         result = self.try_cache(key, modified)
-        if result: return (len(result), legacy.BytesIO(result))
+        if result:
+            return (len(result), legacy.BytesIO(result))
 
         # in case there's no provided method a proper not found exception
         # should be raised so that the end user is notified about the non
         # existence of such unset compressor (as expected)
-        if method == None: raise exceptions.NotFoundError(
-            message = "Compressor is not defined"
-        )
+        if method == None:
+            raise exceptions.NotFoundError(message="Compressor is not defined")
 
         # in case the compress string is defined, tries to find the proper
         # compress method and in case it's not found raises an exception
-        if not hasattr(self, "compress_" + method): raise exceptions.NotFoundError(
-            message = "Compressor '%s' not found" % method
-        )
+        if not hasattr(self, "compress_" + method):
+            raise exceptions.NotFoundError(message="Compressor '%s' not found" % method)
 
         # retrieves the proper compressor method for the requested compress
         # technique, this should be used in a dynamic way enforcing some
@@ -85,8 +78,10 @@ class Compress(object):
         # opens the requested file and reads the complete set of information
         # from it closing the file object after the operation is complete
         file = open(file_path, "rb")
-        try: data = file.read()
-        finally: file.close()
+        try:
+            data = file.read()
+        finally:
+            file.close()
 
         # runs the compressing operation using the target compressor and uses
         # the resulting (compressed) data as the value to be returned
@@ -103,20 +98,22 @@ class Compress(object):
         return (result_size, result_file)
 
     def compress_jpeg(self, file_path):
-        if self.jinja: return self.compress_jpeg_pil(file_path)
+        if self.jinja:
+            return self.compress_jpeg_pil(file_path)
         return self.compress_fallback(file_path)
 
-    def compress_jpeg_pil(self, data, quality = 80):
+    def compress_jpeg_pil(self, data, quality=80):
         input = legacy.BytesIO(data)
         output = legacy.BytesIO()
         image = self.pil.Image.open(input)
-        image.save(output, format = "jpeg", quality = quality, optimize = True)
+        image.save(output, format="jpeg", quality=quality, optimize=True)
         output.seek(0, os.SEEK_SET)
         data = output.read()
         return data
 
     def compress_js(self, data):
-        if self.jsmin: return self.compress_js_jsmin(data)
+        if self.jsmin:
+            return self.compress_js_jsmin(data)
         return self.compress_fallback(data)
 
     def compress_js_jsmin(self, data):

appier/config.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Hive Appier Framework
-# Copyright (c) 2008-2022 Hive Solutions Lda.
+# Copyright (c) 2008-2024 Hive Solutions Lda.
 #
 # This file is part of Hive Appier Framework.
 #
@@ -22,16 +22,7 @@
 __author__ = "João Magalhães <joamag@hive.pt>"
 """ The author(s) of the module """
 
-__version__ = "1.0.0"
-""" The version of the module """
-
-__revision__ = "$LastChangedRevision$"
-""" The revision number of the module """
-
-__date__ = "$LastChangedDate$"
-""" The last change date of the module """
-
-__copyright__ = "Copyright (c) 2008-2022 Hive Solutions Lda."
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
 """ The copyright for the module """
 
 __license__ = "Apache License, Version 2.0"
@@ -60,19 +51,15 @@ IMPORT_NAMES = ("$import", "$include", "$IMPORT", "$INCLUDE")
 name that references a list of include files to be loaded """
 
 CASTS = {
-    bool : lambda v: v if isinstance(v, bool) else v in ("1", "true", "True"),
-    list : lambda v: v if isinstance(v, list) else v.split(";") if v else [],
-    tuple : lambda v: v if isinstance(v, tuple) else tuple(v.split(";") if v else [])
+    bool: lambda v: v if isinstance(v, bool) else v in ("1", "true", "True"),
+    list: lambda v: v if isinstance(v, list) else v.split(";") if v else [],
+    tuple: lambda v: v if isinstance(v, tuple) else tuple(v.split(";") if v else []),
 }
 """ The map containing the various cast method
 operation associated with the various data types,
 they provide a different type of casting strategy """
 
-ENV_ENCODINGS = (
-    "utf-8",
-    sys.getdefaultencoding(),
-    sys.getfilesystemencoding()
-)
+ENV_ENCODINGS = ("utf-8", sys.getdefaultencoding(), sys.getfilesystemencoding())
 """ The sequence of encodings that are going to
 be used to try to decode possible byte based strings
 for the various environment variable values """
@@ -95,7 +82,8 @@ be set on the initial loading of the ".home" file """
 if not isinstance(__builtins__, dict):
     __builtins__ = __builtins__.__dict__
 
-def conf(name, default = None, cast = None, ctx = None):
+
+def conf(name, default=None, cast=None, ctx=None):
     """
     Retrieves the configuration value for the provided value
     defaulting to the provided default value in case no value
@@ -125,42 +113,53 @@ def conf(name, default = None, cast = None, ctx = None):
     configs = ctx["configs"] if ctx else CONFIGS
     cast = _cast_r(cast)
     value = configs.get(name, default)
-    if cast and not value == None: value = cast(value)
+    if cast and not value == None:
+        value = cast(value)
     return value
 
-def conf_prefix(prefix, ctx = None):
+
+def conf_prefix(prefix, ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
     configs_prefix = dict()
     for name, value in configs.items():
-        if not name.startswith(prefix): continue
+        if not name.startswith(prefix):
+            continue
         configs_prefix[name] = value
     return configs_prefix
 
-def conf_suffix(suffix, ctx = None):
+
+def conf_suffix(suffix, ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
     configs_suffix = dict()
     for name, value in configs.items():
-        if not name.endswith(suffix): continue
+        if not name.endswith(suffix):
+            continue
         configs_suffix[name] = value
     return configs_suffix
 
-def conf_s(name, value, ctx = None):
+
+def conf_s(name, value, ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
     configs[name] = value
 
-def conf_r(name, ctx = None):
+
+def conf_r(name, ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
-    if not name in configs: return
+    if not name in configs:
+        return
     del configs[name]
 
-def conf_d(ctx = None):
+
+def conf_d(ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
     return configs
 
+
 def conf_ctx():
-    return dict(configs = dict(), config_f = dict())
+    return dict(configs=dict(), config_f=dict())
+
 
-def load(names = (FILE_NAME,), path = None, encoding = "utf-8", ctx = None):
+def load(names=(FILE_NAME,), path=None, encoding="utf-8", ctx=None):
     paths = []
     homes = get_homes()
     for home in homes:
@@ -172,43 +171,54 @@ def load(names = (FILE_NAME,), path = None, encoding = "utf-8", ctx = None):
     paths.append(path)
     for path in paths:
         for name in names:
-            load_file(name = name, path = path, encoding = encoding, ctx = ctx)
-    load_env(ctx = ctx)
+            load_file(name=name, path=path, encoding=encoding, ctx=ctx)
+    load_env(ctx=ctx)
 
-def load_file(name = FILE_NAME, path = None, encoding = "utf-8", ctx = None):
+
+def load_file(name=FILE_NAME, path=None, encoding="utf-8", ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
     config_f = ctx["config_f"] if ctx else CONFIG_F
 
-    if path: path = os.path.normpath(path)
-    if path: file_path = os.path.join(path, name)
-    else: file_path = name
+    if path:
+        path = os.path.normpath(path)
+    if path:
+        file_path = os.path.join(path, name)
+    else:
+        file_path = name
 
     file_path = os.path.abspath(file_path)
     file_path = os.path.normpath(file_path)
     base_path = os.path.dirname(file_path)
 
     exists = os.path.exists(file_path)
-    if not exists: return
+    if not exists:
+        return
 
     exists = file_path in config_f
-    if exists: config_f.remove(file_path)
+    if exists:
+        config_f.remove(file_path)
     config_f.append(file_path)
 
     file = open(file_path, "rb")
-    try: data = file.read()
-    finally: file.close()
-    if not data: return
+    try:
+        data = file.read()
+    finally:
+        file.close()
+    if not data:
+        return
 
     data = data.decode(encoding)
     data_j = json.loads(data)
 
-    _load_includes(base_path, data_j, encoding = encoding)
+    _load_includes(base_path, data_j, encoding=encoding)
 
     for key, value in data_j.items():
-        if not _is_valid(key): continue
+        if not _is_valid(key):
+            continue
         configs[key] = value
 
-def load_env(ctx = None):
+
+def load_env(ctx=None):
     configs = ctx["configs"] if ctx else CONFIGS
 
     config = dict(os.environ)
@@ -218,28 +228,31 @@ def load_env(ctx = None):
         _load_includes(home, config)
 
     for key, value in legacy.iteritems(config):
-        if not _is_valid(key): continue
+        if not _is_valid(key):
+            continue
         configs[key] = value
         is_bytes = legacy.is_bytes(value)
-        if not is_bytes: continue
+        if not is_bytes:
+            continue
         for encoding in ENV_ENCODINGS:
-            try: value = value.decode(encoding)
-            except UnicodeDecodeError: pass
-            else: break
+            try:
+                value = value.decode(encoding)
+            except UnicodeDecodeError:
+                pass
+            else:
+                break
         configs[key] = value
 
-def get_homes(
-    file_path = HOME_FILE,
-    default = "~",
-    encoding = "utf-8",
-    force_default = False
-):
+
+def get_homes(file_path=HOME_FILE, default="~", encoding="utf-8", force_default=False):
     global HOMES
-    if HOMES: return HOMES
+    if HOMES:
+        return HOMES
 
     HOMES = os.environ.get("HOMES", None)
     HOMES = HOMES.split(";") if HOMES else HOMES
-    if not HOMES == None: return HOMES
+    if not HOMES == None:
+        return HOMES
 
     default = os.path.expanduser(default)
     default = os.path.abspath(default)
@@ -249,13 +262,17 @@ def get_homes(
     file_path = os.path.expanduser(file_path)
     file_path = os.path.normpath(file_path)
     exists = os.path.exists(file_path)
-    if not exists: return HOMES
+    if not exists:
+        return HOMES
 
-    if not force_default: del HOMES[:]
+    if not force_default:
+        del HOMES[:]
 
     file = open(file_path, "rb")
-    try: data = file.read()
-    finally: file.close()
+    try:
+        data = file.read()
+    finally:
+        file.close()
 
     data = data.decode("utf-8")
     data = data.strip()
@@ -264,7 +281,8 @@ def get_homes(
 
     for path in paths:
         path = path.strip()
-        if not path: continue
+        if not path:
+            continue
         path = os.path.expanduser(path)
         path = os.path.abspath(path)
         path = os.path.normpath(path)
@@ -272,13 +290,17 @@ def get_homes(
 
     return HOMES
 
+
 def _cast_r(cast):
     is_string = type(cast) in legacy.STRINGS
-    if is_string: cast = __builtins__.get(cast, None)
-    if not cast: return None
+    if is_string:
+        cast = __builtins__.get(cast, None)
+    if not cast:
+        return None
     return CASTS.get(cast, cast)
 
-def _load_includes(base_path, config, encoding = "utf-8"):
+
+def _load_includes(base_path, config, encoding="utf-8"):
     includes = ()
 
     for alias in IMPORT_NAMES:
@@ -288,16 +310,15 @@ def _load_includes(base_path, config, encoding = "utf-8"):
         includes = includes.split(";")
 
     for include in includes:
-        load_file(
-            name = include,
-            path = base_path,
-            encoding = encoding
-        )
+        load_file(name=include, path=base_path, encoding=encoding)
+
 
 def _is_valid(key):
-    if key in IMPORT_NAMES: return False
+    if key in IMPORT_NAMES:
+        return False
     return True
 
+
 def _is_devel():
     """
     Simple debug/development level detection mechanism to be
@@ -315,6 +336,7 @@ def _is_devel():
 
     return conf("LEVEL", "INFO") in ("DEBUG",)
 
+
 def _is_secure():
     """
     Simple secure variable that should be overriden only under
@@ -327,6 +349,7 @@ def _is_secure():
     secured type level of traceability.
     """
 
-    return conf("SECURE", True, cast = bool)
+    return conf("SECURE", True, cast=bool)
+
 
 load()

appier/controller.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Hive Appier Framework
-# Copyright (c) 2008-2022 Hive Solutions Lda.
+# Copyright (c) 2008-2024 Hive Solutions Lda.
 #
 # This file is part of Hive Appier Framework.
 #
@@ -22,16 +22,7 @@
 __author__ = "João Magalhães <joamag@hive.pt>"
 """ The author(s) of the module """
 
-__version__ = "1.0.0"
-""" The version of the module """
-
-__revision__ = "$LastChangedRevision$"
-""" The revision number of the module """
-
-__date__ = "$LastChangedDate$"
-""" The last change date of the module """
-
-__copyright__ = "Copyright (c) 2008-2022 Hive Solutions Lda."
+__copyright__ = "Copyright (c) 2008-2024 Hive Solutions Lda."
 """ The copyright for the module """
 
 __license__ = "Apache License, Version 2.0"
@@ -41,6 +32,7 @@ from . import meta
 from . import legacy
 from . import observer
 
+
 class Controller(legacy.with_meta(meta.Indexed, observer.Observable)):
     """
     Top level abstract controller class from which all the
@@ -62,12 +54,14 @@ class Controller(legacy.with_meta(meta.Indexed, observer.Observable)):
             return getattr(self.owner, name)
         raise AttributeError("'%s' not found" % name)
 
-    def register(self, lazy = False):
-        if lazy: return
+    def register(self, lazy=False):
+        if lazy:
+            return
         self.setup()
 
-    def unregister(self, lazy = False):
-        if lazy: return
+    def unregister(self, lazy=False):
+        if lazy:
+            return
         self.teardown()
 
     def setup(self):