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

appier/part.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,6 +34,7 @@ import logging
 
 from . import util
 
+
 class Part(object):
     """
     Abstract top level class for the "part" module infra-structure
@@ -53,11 +45,12 @@ class Part(object):
     features to it in a "transparent" way.
     """
 
-    def __init__(self, owner = None, *args, **kwargs):
+    def __init__(self, owner=None, *args, **kwargs):
         self.owner = owner
         self.loaded = False
         self._load_paths()
-        if owner: self.register(owner)
+        if owner:
+            self.register(owner)
 
     def __getattr__(self, name):
         if self.owner and hasattr(self.owner, name):
@@ -66,17 +59,22 @@ class Part(object):
 
     @classmethod
     def _merge_paths(cls, first, second):
-        if not isinstance(first, (list, tuple)): first = [first]
-        if not isinstance(second, (list, tuple)): second = [second]
-        if isinstance(first, tuple): first = list(first)
-        if isinstance(second, tuple): second = list(second)
+        if not isinstance(first, (list, tuple)):
+            first = [first]
+        if not isinstance(second, (list, tuple)):
+            second = [second]
+        if isinstance(first, tuple):
+            first = list(first)
+        if isinstance(second, tuple):
+            second = list(second)
         return first + second
 
     def name(self):
         cls = self.__class__
         cls_name = cls.__name__
         name = util.camel_to_underscore(cls_name)
-        if name.endswith("_part"): name = name[:-5]
+        if name.endswith("_part"):
+            name = name[:-5]
         return name
 
     def version(self):
@@ -84,14 +82,13 @@ class Part(object):
 
     def info(self):
         return dict(
-            name = self.name(),
-            version = self.version(),
-            class_name = self.class_name()
+            name=self.name(), version=self.version(), class_name=self.class_name()
         )
 
     def class_name(self):
         cls = self.__class__
-        if not self.__module__: return cls.__name__
+        if not self.__module__:
+            return cls.__name__
         return self.__module__ + "." + cls.__name__
 
     def register(self, owner):
@@ -119,8 +116,10 @@ class Part(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()
 
     def _load_paths(self):
         module = self.__class__.__module__

appier/preferences.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"
@@ -48,15 +39,16 @@ from . import redisdb
 from . import component
 from . import exceptions
 
-class Preferences(component.Component):
 
-    def __init__(self, name = "preferences", owner = None, *args, **kwargs):
-        component.Component.__init__(self, name = name, owner = owner, *args, **kwargs)
+class Preferences(component.Component):
+    def __init__(self, name="preferences", owner=None, *args, **kwargs):
+        component.Component.__init__(self, name=name, owner=owner, *args, **kwargs)
         load = kwargs.pop("load", True)
-        if load: self.load(*args, **kwargs)
+        if load:
+            self.load(*args, **kwargs)
 
     def __getitem__(self, key):
-        return self.get(key, strict = True)
+        return self.get(key, strict=True)
 
     def __setitem__(self, key, value):
         self.set(key, value)
@@ -68,13 +60,14 @@ class Preferences(component.Component):
     def new(cls, *args, **kwargs):
         return cls(*args, **kwargs)
 
-    def get(self, name, default = None, strict = False, *args, **kwargs):
-        return self._get(name, default = default, strict = strict, *args, **kwargs)
+    def get(self, name, default=None, strict=False, *args, **kwargs):
+        return self._get(name, default=default, strict=strict, *args, **kwargs)
 
     def set(self, name, value, *args, **kwargs):
         flush = kwargs.get("flush", True)
         result = self._set(name, value, *args, **kwargs)
-        if flush: self.flush()
+        if flush:
+            self.flush()
         return result
 
     def delete(self, name, *args, **kwargs):
@@ -86,7 +79,7 @@ class Preferences(component.Component):
     def clear(self, *args, **kwargs):
         return self._clear(*args, **kwargs)
 
-    def _get(self, name, default = None, strict = False, *args, **kwargs):
+    def _get(self, name, default=None, strict=False, *args, **kwargs):
         raise exceptions.NotImplementedError()
 
     def _set(self, name, value, *args, **kwargs):
@@ -101,10 +94,10 @@ class Preferences(component.Component):
     def _clear(self, *args, **kwargs):
         raise exceptions.NotImplementedError()
 
-class MemoryPreferences(Preferences):
 
-    def __init__(self, name = "memory", owner = None, *args, **kwargs):
-        Preferences.__init__(self, name = name, owner = owner, *args, **kwargs)
+class MemoryPreferences(Preferences):
+    def __init__(self, name="memory", owner=None, *args, **kwargs):
+        Preferences.__init__(self, name=name, owner=owner, *args, **kwargs)
 
     def _load(self, *args, **kwargs):
         Preferences._load(self, *args, **kwargs)
@@ -114,8 +107,9 @@ class MemoryPreferences(Preferences):
         Preferences._unload(self, *args, **kwargs)
         self._preferences = None
 
-    def _get(self, name, default = None, strict = False, *args, **kwargs):
-        if strict: return self._preferences[name]
+    def _get(self, name, default=None, strict=False, *args, **kwargs):
+        if strict:
+            return self._preferences[name]
         return self._preferences.get(name, default)
 
     def _set(self, name, value, *args, **kwargs):
@@ -130,10 +124,10 @@ class MemoryPreferences(Preferences):
     def _clear(self, *args, **kwargs):
         self._preferences.clear()
 
-class FilePreferences(Preferences):
 
-    def __init__(self, name = "file", owner = None, *args, **kwargs):
-        Preferences.__init__(self, name = name, owner = owner, *args, **kwargs)
+class FilePreferences(Preferences):
+    def __init__(self, name="file", owner=None, *args, **kwargs):
+        Preferences.__init__(self, name=name, owner=owner, *args, **kwargs)
 
     def _load(self, *args, **kwargs):
         Preferences._load(self, *args, **kwargs)
@@ -144,8 +138,9 @@ class FilePreferences(Preferences):
         Preferences._unload(self, *args, **kwargs)
         self._close()
 
-    def _get(self, name, default = None, strict = False, *args, **kwargs):
-        if strict: return self._shelve[name]
+    def _get(self, name, default=None, strict=False, *args, **kwargs):
+        if strict:
+            return self._shelve[name]
         return self._shelve.get(name, default)
 
     def _set(self, name, value, *args, **kwargs):
@@ -158,26 +153,25 @@ class FilePreferences(Preferences):
         self._sync()
 
     def _clear(self, *args, **kwargs):
-        if not os.path.exists(self.preferences_path): return
+        if not os.path.exists(self.preferences_path):
+            return
         os.remove(self.preferences_path)
 
     def _open(self):
         self._ensure_path()
-        self._shelve = shelve.open(
-            self.preferences_path,
-            protocol = 2,
-            writeback = True
-        )
+        self._shelve = shelve.open(self.preferences_path, protocol=2, writeback=True)
 
     def _close(self):
-        if not self._shelve: return
+        if not self._shelve:
+            return
         self._shelve.close()
         self._shelve = None
 
     def _ensure_path(self):
-        if self.preferences_path: return
+        if self.preferences_path:
+            return
         app_path = common.base().get_base_path()
-        util.verify(not app_path == None, message = "No app path available")
+        util.verify(not app_path == None, message="No app path available")
         preferences_path = os.path.join(app_path, "preferences.shelve")
         preferences_path = config.conf("PREFERENCES_PATH", preferences_path)
         preferences_path = os.path.expanduser(preferences_path)
@@ -185,7 +179,7 @@ class FilePreferences(Preferences):
         preferences_path = os.path.normpath(preferences_path)
         self.preferences_path = preferences_path
 
-    def _sync(self, secure = None):
+    def _sync(self, secure=None):
         if secure == None:
             secure = self._db_secure()
         if secure:
@@ -202,8 +196,8 @@ class FilePreferences(Preferences):
         shelve_dbm = shelve_cls.__name__
         return shelve_dbm
 
-class RedisPreferences(Preferences):
 
+class RedisPreferences(Preferences):
     SERIALIZER = pickle
     """ The serializer to be used for the values contained in
     the preferences (used on top of the class) """
@@ -212,8 +206,8 @@ class RedisPreferences(Preferences):
     """The default prefix value that is going to
     be prepended to the key name to handle preferences"""
 
-    def __init__(self, name = "redis", owner = None, *args, **kwargs):
-        Preferences.__init__(self, name = name, owner = owner, *args, **kwargs)
+    def __init__(self, name="redis", owner=None, *args, **kwargs):
+        Preferences.__init__(self, name=name, owner=owner, *args, **kwargs)
 
     def _load(self, *args, **kwargs):
         Preferences._load(self, *args, **kwargs)
@@ -226,14 +220,17 @@ class RedisPreferences(Preferences):
         Preferences._unload(self, *args, **kwargs)
         self._close()
 
-    def _get(self, name, default = None, strict = False, *args, **kwargs):
+    def _get(self, name, default=None, strict=False, *args, **kwargs):
         name = self._fqn(name)
         value = self._redis.get(name)
         if not value:
-            if strict: raise KeyError("not found")
+            if strict:
+                raise KeyError("not found")
+            return default
+        try:
+            return self._serializer.loads(value)
+        except Exception:
             return default
-        try: return self._serializer.loads(value)
-        except Exception: return default
 
     def _set(self, name, value, *args, **kwargs):
         name = self._fqn(name)

appier/queuing.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,21 +37,21 @@ from . import amqp
 from . import legacy
 from . import exceptions
 
-class Queue(object):
 
+class Queue(object):
     def length(self):
         raise exceptions.NotImplementedError()
 
     def clear(self):
         raise exceptions.NotImplementedError()
 
-    def push(self, value, priority = None, identify = False):
+    def push(self, value, priority=None, identify=False):
         raise exceptions.NotImplementedError()
 
-    def pop(self, block = True, full = False):
+    def pop(self, block=True, full=False):
         raise exceptions.NotImplementedError()
 
-    def subscribe(self, callback, full = False):
+    def subscribe(self, callback, full=False):
         raise exceptions.NotImplementedError()
 
     def loop(self):
@@ -75,23 +66,20 @@ class Queue(object):
     def nack(self):
         raise exceptions.NotImplementedError()
 
-    def build_value(
-        self,
-        value,
-        priority = None,
-        identify = False,
-        reverse = False
-    ):
-        if identify: identifier = self.build_identifier()
-        else: identifier = None
-        if priority and reverse: priority *= -1
+    def build_value(self, value, priority=None, identify=False, reverse=False):
+        if identify:
+            identifier = self.build_identifier()
+        else:
+            identifier = None
+        if priority and reverse:
+            priority *= -1
         return (priority, identifier, value), identifier
 
     def build_identifier(self):
         return str(uuid.uuid4())
 
-class MemoryQueue(Queue):
 
+class MemoryQueue(Queue):
     def __init__(self):
         Queue.__init__(self)
         self._queue = []
@@ -102,25 +90,24 @@ class MemoryQueue(Queue):
     def clear(self):
         del self._queue[:]
 
-    def push(self, value, priority = None, identify = False):
+    def push(self, value, priority=None, identify=False):
         value, identifier = self.build_value(
-            value,
-            priority = priority,
-            identify = identify,
-            reverse = True
+            value, priority=priority, identify=identify, reverse=True
         )
         heapq.heappush(self._queue, value)
         return identifier
 
-    def pop(self, block = True, full = False):
+    def pop(self, block=True, full=False):
         priority, identifier, value = heapq.heappop(self._queue)
         return (priority, identifier, value) if full else value
 
-class MultiprocessQueue(Queue):
 
+class MultiprocessQueue(Queue):
     def __init__(self):
-        try: import queue
-        except ImportError: import Queue as queue
+        try:
+            import queue
+        except ImportError:
+            import Queue as queue
         Queue.__init__(self)
         self._queue = queue.PriorityQueue()
 
@@ -128,36 +115,35 @@ class MultiprocessQueue(Queue):
         return self._queue.qsize()
 
     def clear(self):
-        try: import queue
-        except ImportError: import Queue as queue
+        try:
+            import queue
+        except ImportError:
+            import Queue as queue
         self._queue = queue.PriorityQueue()
 
-    def push(self, value, priority = None, identify = False):
+    def push(self, value, priority=None, identify=False):
         value, identifier = self.build_value(
-            value,
-            priority = priority,
-            identify = identify,
-            reverse = True
+            value, priority=priority, identify=identify, reverse=True
         )
         self._queue.put(value)
         return identifier
 
-    def pop(self, block = True, full = False):
+    def pop(self, block=True, full=False):
         priority, identifier, value = self._queue.get(block)
         return (priority, identifier, value) if full else value
 
-class AMQPQueue(Queue):
 
+class AMQPQueue(Queue):
     def __init__(
         self,
-        url = None,
-        name = "default",
-        durable = False,
-        max_priority = 255,
-        encoder = "pickle",
-        protocol = 2,
-        encoding = "utf-8",
-        amqp = None
+        url=None,
+        name="default",
+        durable=False,
+        max_priority=255,
+        encoder="pickle",
+        protocol=2,
+        encoding="utf-8",
+        amqp=None,
     ):
         self.url = url
         self.name = name
@@ -170,33 +156,27 @@ class AMQPQueue(Queue):
         self._build()
 
     def clear(self):
-        self.channel.queue_purge(queue = self.name)
+        self.channel.queue_purge(queue=self.name)
 
-    def push(self, value, priority = None, identify = False):
+    def push(self, value, priority=None, identify=False):
         value, identifier = self.build_value(
-            value,
-            priority = priority,
-            identify = identify,
-            reverse = False
+            value, priority=priority, identify=identify, reverse=False
         )
         body = self._dump(value)
 
         self._add_callback(
             self.channel.basic_publish,
-            exchange = "",
-            routing_key = self.name,
-            body = body,
-            properties = amqp.properties(
-                delivery_mode = 2,
-                priority = value[0] or 0
-            )
+            exchange="",
+            routing_key=self.name,
+            body=body,
+            properties=amqp.properties(delivery_mode=2, priority=value[0] or 0),
         )
 
         return identifier
 
-    def pop(self, block = True, full = False):
+    def pop(self, block=True, full=False):
         _method, _properties, body = self.channel.basic_get(
-            queue = self.name, auto_ack = False
+            queue=self.name, auto_ack=False
         )
         priority, identifier, value = self._load(body)
         return (priority, identifier, value) if full else value
@@ -204,33 +184,33 @@ class AMQPQueue(Queue):
     def subscribe(
         self,
         callback,
-        full = False,
-        auto_ack = True,
-        exclusive = False,
-        consumer_tag = None,
-        arguments = None
+        full=False,
+        auto_ack=True,
+        exclusive=False,
+        consumer_tag=None,
+        arguments=None,
     ):
         def handler(channel, method, properties, body):
             priority, identifier, value = self._load(body)
             result = (priority, identifier, value) if full else value
-            ack = lambda: self.ack(delivery_tag = method.delivery_tag)
-            nack = lambda: self.nack(delivery_tag = method.delivery_tag)
+            ack = lambda: self.ack(delivery_tag=method.delivery_tag)
+            nack = lambda: self.nack(delivery_tag=method.delivery_tag)
             callback(result) if auto_ack else callback(result, ack, nack)
 
         self.channel.basic_consume(
-            queue = self.name,
-            on_message_callback = handler,
-            auto_ack = auto_ack,
-            exclusive = exclusive,
-            consumer_tag = consumer_tag,
-            arguments = arguments
+            queue=self.name,
+            on_message_callback=handler,
+            auto_ack=auto_ack,
+            exclusive=exclusive,
+            consumer_tag=consumer_tag,
+            arguments=arguments,
         )
 
-    def ack(self, delivery_tag = None):
-        self.channel.basic_ack(delivery_tag = delivery_tag)
+    def ack(self, delivery_tag=None):
+        self.channel.basic_ack(delivery_tag=delivery_tag)
 
-    def nack(self, delivery_tag = None):
-        self.channel.basic_nack(delivery_tag = delivery_tag)
+    def nack(self, delivery_tag=None):
+        self.channel.basic_nack(delivery_tag=delivery_tag)
 
     def loop(self):
         self.channel.start_consuming()
@@ -242,35 +222,37 @@ class AMQPQueue(Queue):
         return self._dumper(value)
 
     def _dump_pickle(self, value):
-        return legacy.cPickle.dumps(value, protocol = self.protocol)
+        return legacy.cPickle.dumps(value, protocol=self.protocol)
 
     def _dump_json(self, value):
         body = json.dumps(value)
-        return legacy.bytes(body, encoding = self.encoding)
+        return legacy.bytes(body, encoding=self.encoding)
 
     def _load(self, body):
         return self._loader(body)
 
     def _load_pickle(self, body):
-        if legacy.PYTHON_3: kwargs = dict(encoding = "bytes")
-        else: kwargs = dict()
+        if legacy.PYTHON_3:
+            kwargs = dict(encoding="bytes")
+        else:
+            kwargs = dict()
         return legacy.cPickle.loads(body, **kwargs)
 
     def _load_json(self, body):
-        if legacy.is_bytes(body): body = body.decode(self.encoding)
+        if legacy.is_bytes(body):
+            body = body.decode(self.encoding)
         return json.loads(body)
 
     def _build(self):
-        if not self.amqp: self.amqp = amqp.AMQP(url = self.url)
+        if not self.amqp:
+            self.amqp = amqp.AMQP(url=self.url)
         self.connection = self.amqp.get_connection()
         self.channel = self.connection.channel()
-        self.channel.basic_qos(prefetch_count = 1)
+        self.channel.basic_qos(prefetch_count=1)
         self.queue = self.channel.queue_declare(
-            queue = self.name,
-            durable = self.durable,
-            arguments = {
-                "x-max-priority" : self.max_priority
-            }
+            queue=self.name,
+            durable=self.durable,
+            arguments={"x-max-priority": self.max_priority},
         )
         self._dumper = getattr(self, "_dump_" + self.encoder)
         self._loader = getattr(self, "_load_" + self.encoder)