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

appier/smtp.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"
@@ -46,19 +37,21 @@ import email.mime.application
 from . import config
 from . import legacy
 
+
 def message(
     sender,
     receivers,
     contents,
-    host = None,
-    port = 25,
-    username = None,
-    password = None,
-    stls = False,
-    safe = True
+    host=None,
+    port=25,
+    username=None,
+    password=None,
+    stls=False,
+    safe=True,
 ):
     is_contents = isinstance(contents, legacy.STRINGS)
-    if not is_contents: contents = contents.as_string()
+    if not is_contents:
+        contents = contents.as_string()
     if safe:
         contents = contents.replace("\r\n", "\n")
         contents = contents.replace("\n", "\r\n")
@@ -69,72 +62,83 @@ def message(
         sender,
         receivers,
         contents,
-        host = host,
-        port = port,
-        username = username,
-        password = password,
-        stls = stls,
-        helo_host = helo_host
+        host=host,
+        port=port,
+        username=username,
+        password=password,
+        stls=stls,
+        helo_host=helo_host,
     )
 
+
 def message_base(
     sender,
     receivers,
     contents,
-    host = None,
-    port = 25,
-    username = None,
-    password = None,
-    stls = False,
-    helo_host = None,
+    host=None,
+    port=25,
+    username=None,
+    password=None,
+    stls=False,
+    helo_host=None,
     *args,
     **kwargs
 ):
     pass
 
+
 def message_netius(
     sender,
     receivers,
     contents,
-    host = None,
-    port = 25,
-    username = None,
-    password = None,
-    stls = False,
-    helo_host = None,
+    host=None,
+    port=25,
+    username=None,
+    password=None,
+    stls=False,
+    helo_host=None,
     *args,
     **kwargs
 ):
     import netius.clients
-    smtp_client = netius.clients.SMTPClient(auto_close = True, host = helo_host)
+
+    smtp_client = netius.clients.SMTPClient(auto_close=True, host=helo_host)
     smtp_client.message(
         [sender],
         receivers,
         contents,
-        host = host,
-        port = port,
-        username = username,
-        password = password,
-        stls = stls
+        host=host,
+        port=port,
+        username=username,
+        password=password,
+        stls=stls,
     )
 
+
 def smtp_engine():
-    if legacy.has_module("netius"): return "netius"
+    if legacy.has_module("netius"):
+        return "netius"
     return "base"
 
+
 def multipart():
     return email.mime.multipart.MIMEMultipart("alternative")
 
-def plain(contents, encoding = "utf-8"):
+
+def plain(contents, encoding="utf-8"):
     return email.mime.text.MIMEText(contents, "plain", encoding)
 
-def html(contents, encoding = "utf-8"):
+
+def html(contents, encoding="utf-8"):
     return email.mime.text.MIMEText(contents, "html", encoding)
 
-def application(contents, name = "unnamed"):
-    return email.mime.application.MIMEApplication(contents, Name = name)
 
-def header(value, encoding = "utf-8", encode = True):
+def application(contents, name="unnamed"):
+    return email.mime.application.MIMEApplication(contents, Name=name)
+
+
+def header(value, encoding="utf-8", encode=True):
     header = email.header.Header(value, encoding)
-    if encode: header = header.encode()
+    if encode:
+        header = header.encode()
     return header

appier/storage.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"
@@ -43,8 +34,8 @@ import tempfile
 from . import config
 from . import exceptions
 
-class StorageEngine(object):
 
+class StorageEngine(object):
     @classmethod
     def load(cls, file, *args, **kwargs):
         raise exceptions.NotImplementedError()
@@ -81,21 +72,25 @@ class StorageEngine(object):
     def _compute(cls, file, *args, **kwargs):
         file._compute(*args, **kwargs)
 
-class BaseEngine(StorageEngine):
 
+class BaseEngine(StorageEngine):
     @classmethod
     def load(cls, file, *args, **kwargs):
         force = kwargs.get("force", False)
-        if not file.file_name: return
-        if file.data and not force: return
+        if not file.file_name:
+            return
+        if file.data and not force:
+            return
 
         path = tempfile.mkdtemp()
         path_f = os.path.join(path, file.file_name)
         file.file.save(path_f)
 
         handle = open(path_f, "rb")
-        try: file.data = handle.read()
-        finally: handle.close()
+        try:
+            file.data = handle.read()
+        finally:
+            handle.close()
 
         cls._compute()
 
@@ -113,14 +108,16 @@ class BaseEngine(StorageEngine):
         # reading in case none is defined the handled flag
         # handling is ignored and the data returned immediately
         size = kwargs.get("size", None)
-        if not size: return file.data
+        if not size:
+            return file.data
 
         # verifies if the handled flag is already set (data)
         # has been already retrieved and if that's not the
         # case sets the handled flag and returns the data
         handled = hasattr(file, "_handled")
         file._handled = True
-        if not handled: return file.data
+        if not handled:
+            return file.data
 
         # runs the final cleanup operation and returns an empty
         # value to end the reading sequence
@@ -129,22 +126,25 @@ class BaseEngine(StorageEngine):
 
     @classmethod
     def cleanup(cls, file, *args, **kwargs):
-        if not hasattr(file, "handled"): return
+        if not hasattr(file, "handled"):
+            return
         del file._handled
 
     @classmethod
     def is_stored(self):
         return True
 
-class FsEngine(StorageEngine):
 
+class FsEngine(StorageEngine):
     @classmethod
     def store(cls, file, *args, **kwargs):
         file_path = cls._file_path(file)
         file_data = file.data or b""
         handle = open(file_path, "wb")
-        try: handle.write(file_data)
-        finally: handle.close()
+        try:
+            handle.write(file_data)
+        finally:
+            handle.close()
 
     @classmethod
     def load(cls, file, *args, **kwargs):
@@ -152,7 +152,7 @@ class FsEngine(StorageEngine):
 
     @classmethod
     def delete(cls, file, *args, **kwargs):
-        file_path = cls._file_path(file, ensure = False)
+        file_path = cls._file_path(file, ensure=False)
         os.remove(file_path)
 
     @classmethod
@@ -160,7 +160,8 @@ class FsEngine(StorageEngine):
         data = None
         size = kwargs.get("size", None)
         handle = cls._handle(file)
-        try: data = handle.read(size or -1)
+        try:
+            data = handle.read(size or -1)
         finally:
             is_final = True if not size or not data else False
             is_final and cls.cleanup(file)
@@ -169,13 +170,15 @@ class FsEngine(StorageEngine):
     @classmethod
     def seek(cls, file, *args, **kwargs):
         offset = kwargs.get("offset", None)
-        if offset == None: return
+        if offset == None:
+            return
         handle = cls._handle(file)
         handle.seek(offset)
 
     @classmethod
     def cleanup(cls, file, *args, **kwargs):
-        if not hasattr(file, "_handle"): return
+        if not hasattr(file, "_handle"):
+            return
         file._handle.close()
         del file._handle
 
@@ -185,7 +188,7 @@ class FsEngine(StorageEngine):
 
     @classmethod
     def _compute(cls, file):
-        file_path = cls._file_path(file, ensure = False)
+        file_path = cls._file_path(file, ensure=False)
         size = os.path.getsize(file_path)
         mtime = os.path.getmtime(file_path)
         file.hash = str(mtime)
@@ -194,14 +197,15 @@ class FsEngine(StorageEngine):
 
     @classmethod
     def _handle(cls, file):
-        file_path = cls._file_path(file, ensure = False)
+        file_path = cls._file_path(file, ensure=False)
         handle = hasattr(file, "_handle") and file._handle
-        if not handle: handle = open(file_path, "rb")
+        if not handle:
+            handle = open(file_path, "rb")
         file._handle = handle
         return handle
 
     @classmethod
-    def _file_path(cls, file, ensure = True, base = None):
+    def _file_path(cls, file, ensure=True, base=None):
         # verifies that the standard params value is defined and
         # if that's no the case defaults the value, then tries to
         # retrieve a series of parameters for file path discovery
@@ -225,8 +229,10 @@ class FsEngine(StorageEngine):
         # verifies if the ensure flag is not set of if the directory
         # path associated with the current file path exists and if
         # that's the case returns the file path immediately
-        if not ensure: return file_path
-        if os.path.exists(dir_path): return file_path
+        if not ensure:
+            return file_path
+        if os.path.exists(dir_path):
+            return file_path
 
         # creates the directories (concrete and parents) as requested
         # and then returns the "final" file path value to the caller

appier/structures.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"
@@ -39,15 +30,16 @@ __license__ = "Apache License, Version 2.0"
 
 import os
 
-class OrderedDict(dict):
 
-    def __init__(self, value = None, *args, **kwargs):
+class OrderedDict(dict):
+    def __init__(self, value=None, *args, **kwargs):
         object.__init__(self, *args, **kwargs)
         self._list = list()
         self._dict = dict()
         self._items = dict()
         is_dict = isinstance(value, dict)
-        if not is_dict: return
+        if not is_dict:
+            return
         self._from_dict(value)
 
     def __str__(self):
@@ -82,16 +74,16 @@ class OrderedDict(dict):
         self._verify()
         return self._dict.__contains__(item)
 
-    def __iter__(self, verify = True):
-        self._verify(force = verify)
+    def __iter__(self, verify=True):
+        self._verify(force=verify)
         return self._list.__iter__()
 
-    def items(self, verify = True):
-        self._verify(force = verify)
+    def items(self, verify=True):
+        self._verify(force=verify)
         return self
 
-    def iteritems(self, verify = True):
-        self._verify(force = verify)
+    def iteritems(self, verify=True):
+        self._verify(force=verify)
         return self
 
     def item(self, key):
@@ -106,7 +98,7 @@ class OrderedDict(dict):
         self._verify()
         return self.push(value)
 
-    def pop(self, index = -1):
+    def pop(self, index=-1):
         self._verify()
         value = self._list.pop(index)
         key, _value = value
@@ -119,9 +111,10 @@ class OrderedDict(dict):
         key, value = value
         self.set(key, value)
 
-    def get(self, key, default = None):
+    def get(self, key, default=None):
         self._verify()
-        if not key in self._dict: return default
+        if not key in self._dict:
+            return default
         return self._dict[key]
 
     def set(self, key, value):
@@ -147,7 +140,7 @@ class OrderedDict(dict):
         self._dict.clear()
         self._items.clear()
 
-    def _from_dict(self, base, empty = True):
+    def _from_dict(self, base, empty=True):
         """
         Builds the ordered dictionary from a base (unordered) one
         sorting all of its items accordingly.
@@ -164,15 +157,17 @@ class OrderedDict(dict):
         to an empty state before using the dictionary.
         """
 
-        if empty: self.empty()
+        if empty:
+            self.empty()
         keys = list(base.keys())
         keys.sort()
         for key in keys:
             value = base[key]
             self.set(key, value)
-        if empty: self._dict = base
+        if empty:
+            self._dict = base
 
-    def _verify(self, force = False):
+    def _verify(self, force=False):
         """
         Runs the consistency check on the current structure so that
         if any change occurs in the base dictionary (either adding
@@ -187,51 +182,57 @@ class OrderedDict(dict):
         exactly the same.
         """
 
-        if not force and len(self._list) == len(self._dict): return
+        if not force and len(self._list) == len(self._dict):
+            return
 
         for value in list(self._list):
             key, _value = value
             exists = True
             exists &= key in self._dict
             exists &= key in self._items
-            if exists: continue
+            if exists:
+                continue
             self._list.remove(value)
 
-        if len(self._list) == len(self._dict): return
+        if len(self._list) == len(self._dict):
+            return
 
         for key, value in self._dict.items():
             item = [key, value]
-            if item in self._list: continue
+            if item in self._list:
+                continue
             self._list.append(item)
             self._items[key] = item
 
-class LazyDict(dict):
 
-    def __getitem__(self, key, force = False, resolve = False):
+class LazyDict(dict):
+    def __getitem__(self, key, force=False, resolve=False):
         value = dict.__getitem__(self, key)
-        if force: return value
-        if not isinstance(value, LazyValue): return value
-        return value.resolve(force = resolve)
+        if force:
+            return value
+        if not isinstance(value, LazyValue):
+            return value
+        return value.resolve(force=resolve)
 
-    def resolve(self, force = False):
+    def resolve(self, force=False):
         result = dict()
         for key in self:
-            value = self.__getitem__(key, resolve = force)
+            value = self.__getitem__(key, resolve=force)
             result[key] = value
         return result
 
-    def to_dict(self, force = True):
-        return self.resolve(force = force)
+    def to_dict(self, force=True):
+        return self.resolve(force=force)
 
-class LazyValue(object):
 
+class LazyValue(object):
     def __init__(self, callable):
         self.callable = callable
 
     def __call__(self):
         return self.call()
 
-    def resolve(self, force = False):
+    def resolve(self, force=False):
         if hasattr(self, "_value") and not force:
             return self._value
         self._value = self.callable()
@@ -240,6 +241,7 @@ class LazyValue(object):
     def call(self):
         return self.resolve()
 
+
 class GeneratorFile(object):
     """
     File like class that encapsulates an underlying
@@ -256,7 +258,7 @@ class GeneratorFile(object):
         self._size = next(generator)
         self._position = 0
 
-    def seek(self, offset, whence = os.SEEK_SET):
+    def seek(self, offset, whence=os.SEEK_SET):
         if whence == os.SEEK_SET:
             self._position = offset
         if whence == os.SEEK_CUR:
@@ -268,12 +270,15 @@ class GeneratorFile(object):
         return self._position
 
     def read(self, size):
-        try: data = next(self._generator)
-        except StopIteration: data = b""
+        try:
+            data = next(self._generator)
+        except StopIteration:
+            data = b""
         return data
 
     def close(self):
         self._generator.close()
 
+
 lazy_dict = LazyDict
 lazy = LazyValue

appier/test/__init__.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.
 #
@@ -19,16 +19,7 @@
 # You should have received a copy of the Apache License along with
 # Hive Appier Framework. If not, see <http://www.apache.org/licenses/>.
 
-__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"