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

appier/mongo.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,14 +37,20 @@ from . import config
 from . import common
 from . import exceptions
 
-try: import pymongo
-except ImportError: pymongo = None
+try:
+    import pymongo
+except ImportError:
+    pymongo = None
 
-try: import bson.json_util
-except ImportError: bson = None
+try:
+    import bson.json_util
+except ImportError:
+    bson = None
 
-try: import motor.motor_asyncio
-except ImportError: motor = None
+try:
+    import motor.motor_asyncio
+except ImportError:
+    motor = None
 
 URL = "mongodb://localhost"
 """ The default URL to be used for the connection when
@@ -67,44 +64,52 @@ connection_a = None
 """ The global connection reference for the async version
 of the Mongo client """
 
-class Mongo(object):
 
-    def __init__(self, url = None):
+class Mongo(object):
+    def __init__(self, url=None):
         self.url = url
         self._connection = None
         self._db = None
 
-    def get_connection(self, url = None, connect = False):
-        if self._connection: return self._connection
+    def get_connection(self, url=None, connect=False):
+        if self._connection:
+            return self._connection
         url_c = config.conf("MONGOHQ_URL", None)
         url_c = config.conf("MONGOLAB_URI", url_c)
         url_c = config.conf("MONGO_URL", url_c)
         url = url or self.url or url_c or URL
-        if is_new(): self._connection = _pymongo().MongoClient(url, connect = connect)
-        else: self._connection = _pymongo().Connection(url)
+        if is_new():
+            self._connection = _pymongo().MongoClient(url, connect=connect)
+        else:
+            self._connection = _pymongo().Connection(url)
         return self._connection
 
     def reset_connection(self):
-        if not self._connection: return
-        if is_new(): self._connection.close()
-        else: self._connection.disconnect()
+        if not self._connection:
+            return
+        if is_new():
+            self._connection.close()
+        else:
+            self._connection.disconnect()
         self._connection = None
 
     def get_db(self, name):
-        if self._db: return self._db
+        if self._db:
+            return self._db
         connection = self.get_connection()
         self._db = connection[name]
         return self._db
 
-class MongoAsync(object):
 
-    def __init__(self, url = None):
+class MongoAsync(object):
+    def __init__(self, url=None):
         self.url = url
         self._connection = None
         self._db = None
 
-    def get_connection(self, url = None, connect = False):
-        if self._connection: return self._connection
+    def get_connection(self, url=None, connect=False):
+        if self._connection:
+            return self._connection
         url_c = config.conf("MONGOHQ_URL", None)
         url_c = config.conf("MONGOLAB_URI", url_c)
         url_c = config.conf("MONGO_URL", url_c)
@@ -113,57 +118,76 @@ class MongoAsync(object):
         return self._connection
 
     def reset_connection(self):
-        if not self._connection: return
+        if not self._connection:
+            return
         self._connection.disconnect()
         self._connection = None
 
     def get_db(self, name):
-        if self._db: return self._db
+        if self._db:
+            return self._db
         connection = self.get_connection()
         self._db = connection[name]
         return self._db
 
-class MongoEncoder(json.JSONEncoder):
 
+class MongoEncoder(json.JSONEncoder):
     def default(self, obj, **kwargs):
-        if not bson: return json.JSONEncoder.default(self, obj, **kwargs)
-        if isinstance(obj, bson.objectid.ObjectId): return str(obj)
-        if isinstance(obj, legacy.BYTES): return legacy.str(obj, encoding = "utf-8")
-        else: return json.JSONEncoder.default(self, obj, **kwargs)
+        if not bson:
+            return json.JSONEncoder.default(self, obj, **kwargs)
+        if isinstance(obj, bson.objectid.ObjectId):
+            return str(obj)
+        if isinstance(obj, legacy.BYTES):
+            return legacy.str(obj, encoding="utf-8")
+        else:
+            return json.JSONEncoder.default(self, obj, **kwargs)
+
 
-def get_connection(url = URL, connect = False):
+def get_connection(url=URL, connect=False):
     global connection
-    if connection: return connection
+    if connection:
+        return connection
     url = config.conf("MONGOHQ_URL", url)
     url = config.conf("MONGOLAB_URI", url)
     url = config.conf("MONGO_URL", url)
-    if is_new(): connection = _pymongo().MongoClient(url, connect = connect)
-    else: connection = _pymongo().Connection(url)
+    if is_new():
+        connection = _pymongo().MongoClient(url, connect=connect)
+    else:
+        connection = _pymongo().Connection(url)
     return connection
 
-def get_connection_a(url = URL, connect = False):
+
+def get_connection_a(url=URL, connect=False):
     global connection_a
-    if connection_a: return connection_a
+    if connection_a:
+        return connection_a
     url = config.conf("MONGOHQ_URL", url)
     url = config.conf("MONGOLAB_URI", url)
     url = config.conf("MONGO_URL", url)
     connection_a = _motor().AsyncIOMotorClient(url)
     return connection_a
 
+
 def reset_connection():
     global connection
-    if not connection: return
-    if is_new(): connection.close()
-    else: connection.disconnect()
+    if not connection:
+        return
+    if is_new():
+        connection.close()
+    else:
+        connection.disconnect()
     connection = None
 
+
 def reset_connection_a():
     global connection_a
-    if not connection_a: return
+    if not connection_a:
+        return
     connection_a.close()
     connection_a = None
 
-def get_db(name = None, get_connection = get_connection):
+
+def get_db(name=None, get_connection=get_connection):
     url = config.conf("MONGOHQ_URL", None)
     url = config.conf("MONGOLAB_URI", url)
     url = config.conf("MONGO_URL", url)
@@ -175,7 +199,8 @@ def get_db(name = None, get_connection = get_connection):
     db = connection[name]
     return db
 
-def get_db_a(name = None, get_connection = get_connection):
+
+def get_db_a(name=None, get_connection=get_connection):
     url = config.conf("MONGOHQ_URL", None)
     url = config.conf("MONGOLAB_URI", url)
     url = config.conf("MONGO_URL", url)
@@ -187,125 +212,176 @@ def get_db_a(name = None, get_connection = get_connection):
     db = connection[name]
     return db
 
-def drop_db(name = None, get_connection = get_connection):
-    db = get_db(name = name)
+
+def drop_db(name=None, get_connection=get_connection):
+    db = get_db(name=name)
     names = _list_names(db)
     for name in names:
-        if name.startswith("system."): continue
+        if name.startswith("system."):
+            continue
         db.drop_collection(name)
     connection = get_connection()
     connection.drop_database(db.name)
 
-def drop_db_a(name = None, get_connection = get_connection):
-    db = get_db_a(name = name)
+
+def drop_db_a(name=None, get_connection=get_connection):
+    db = get_db_a(name=name)
     names = _list_names(db)
     for name in names:
-        if name.startswith("system."): continue
+        if name.startswith("system."):
+            continue
         db.drop_collection(name)
     connection = get_connection_a()
     connection.drop_database(db.name)
 
+
 def object_id(value):
     return bson.ObjectId(value)
 
+
 def dumps(*args):
-    return json.dumps(default = serialize, *args)
+    return json.dumps(default=serialize, *args)
+
 
 def serialize(obj):
-    if isinstance(obj, common.model().Model): return obj.model
-    if isinstance(obj, typesf.AbstractType): return obj.json_v()
+    if isinstance(obj, common.model().Model):
+        return obj.model
+    if isinstance(obj, typesf.AbstractType):
+        return obj.json_v()
     return bson.json_util.default(obj)
 
-def directions(all = False):
+
+def directions(all=False):
     return (
-        _pymongo().ASCENDING,
-        _pymongo().DESCENDING,
-        _pymongo().HASHED
-    ) if all else (
-        _pymongo().ASCENDING,
-        _pymongo().DESCENDING
+        (_pymongo().ASCENDING, _pymongo().DESCENDING, _pymongo().HASHED)
+        if all
+        else (_pymongo().ASCENDING, _pymongo().DESCENDING)
     )
 
+
 def is_mongo(obj):
-    if bson and isinstance(obj, bson.ObjectId): return True
-    if bson and isinstance(obj, bson.DBRef): return True
+    if bson and isinstance(obj, bson.ObjectId):
+        return True
+    if bson and isinstance(obj, bson.DBRef):
+        return True
     return False
 
-def is_new(major = 3, minor = 0, patch = 0):
+
+def is_new(major=3, minor=0, patch=0):
     _major, _minor, _patch = _version_t()
-    if _major > major: return True
-    elif _major < major: return False
-    if _minor > minor: return True
-    elif _minor < minor: return False
-    if _patch >= patch: return True
-    else: return False
+    if _major > major:
+        return True
+    elif _major < major:
+        return False
+    if _minor > minor:
+        return True
+    elif _minor < minor:
+        return False
+    if _patch >= patch:
+        return True
+    else:
+        return False
+
 
 def _list_names(db, *args, **kwargs):
-    if is_new(3, 7): return db.list_collection_names()
-    else: return db.collection_names()
+    if is_new(3, 7):
+        return db.list_collection_names()
+    else:
+        return db.collection_names()
+
 
 def _count(store, *args, **kwargs):
-    if len(args) == 0: args = [{}]
-    if is_new(3, 7): return store.count_documents(*args, **kwargs)
+    if len(args) == 0:
+        args = [{}]
+    if is_new(3, 7):
+        return store.count_documents(*args, **kwargs)
     return store.count(*args, **kwargs)
 
+
 def _count_documents(store, *args, **kwargs):
-    if len(args) == 0: args = [{}]
-    if is_new(3, 7): return store.count_documents(*args, **kwargs)
+    if len(args) == 0:
+        args = [{}]
+    if is_new(3, 7):
+        return store.count_documents(*args, **kwargs)
     result = store.find(*args, **kwargs)
     return result.count()
 
+
 def _store_find_and_modify(store, *args, **kwargs):
-    if is_new(): return store.find_one_and_update(*args, **kwargs)
-    else: return store.find_and_modify(*args, **kwargs)
+    if is_new():
+        return store.find_one_and_update(*args, **kwargs)
+    else:
+        return store.find_and_modify(*args, **kwargs)
+
 
 def _store_insert(store, *args, **kwargs):
-    if is_new(): return store.insert_one(*args, **kwargs)
-    else: return store.insert(*args, **kwargs)
+    if is_new():
+        return store.insert_one(*args, **kwargs)
+    else:
+        return store.insert(*args, **kwargs)
+
 
 def _store_update(store, *args, **kwargs):
-    if is_new(): return store.update_one(*args, **kwargs)
-    else: return store.update(*args, **kwargs)
+    if is_new():
+        return store.update_one(*args, **kwargs)
+    else:
+        return store.update(*args, **kwargs)
+
 
 def _store_remove(store, *args, **kwargs):
-    if is_new(): return store.delete_many(*args, **kwargs)
-    else: return store.remove(*args, **kwargs)
+    if is_new():
+        return store.delete_many(*args, **kwargs)
+    else:
+        return store.remove(*args, **kwargs)
+
 
 def _store_ensure_index(store, *args, **kwargs):
     kwargs["background"] = kwargs.get("background", True)
-    if is_new(): return store.create_index(*args, **kwargs)
-    else: return store.ensure_index(*args, **kwargs)
+    if is_new():
+        return store.create_index(*args, **kwargs)
+    else:
+        return store.ensure_index(*args, **kwargs)
+
 
 def _store_ensure_index_many(store, *args, **kwargs):
     directions_l = kwargs.pop("directions", None)
-    if directions_l == "all": directions_l = directions(all = True)
-    elif directions_l == None: directions_l = directions()
+    if directions_l == "all":
+        directions_l = directions(all=True)
+    elif directions_l == None:
+        directions_l = directions()
     for direction in directions_l:
         _args = list(args)
         _args[0] = [(_args[0], direction)]
         _store_ensure_index(store, *_args, **kwargs)
 
+
 def _version_t():
     pymongo_l = _pymongo()
-    if hasattr(pymongo_l, "_version_t"): return pymongo_l._version_t
+    if hasattr(pymongo_l, "_version_t"):
+        return pymongo_l._version_t
     version_l = pymongo.version.split(".", 2)
-    if len(version_l) == 2: version_l.append("0")
+    if len(version_l) == 2:
+        version_l.append("0")
     major_s, minor_s, patch_s = version_l
     pymongo_l._version_t = (int(major_s), int(minor_s), int(patch_s))
     return pymongo_l._version_t
 
-def _pymongo(verify = True):
-    if verify: util.verify(
-        not pymongo == None,
-        message = "PyMongo library not available",
-        exception = exceptions.OperationalError
-    )
+
+def _pymongo(verify=True):
+    if verify:
+        util.verify(
+            not pymongo == None,
+            message="PyMongo library not available",
+            exception=exceptions.OperationalError,
+        )
     return pymongo
 
-def _motor(verify = True):
-    if verify: util.verify(
-        not motor == None,
-        message = "Motor library not available",
-        exception = exceptions.OperationalError
-    )
+
+def _motor(verify=True):
+    if verify:
+        util.verify(
+            not motor == None,
+            message="Motor library not available",
+            exception=exceptions.OperationalError,
+        )
     return motor.motor_asyncio

appier/observer.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,6 +30,7 @@ __license__ = "Apache License, Version 2.0"
 
 from . import util
 
+
 class Observable(object):
     """
     The base class that implements the observable
@@ -68,19 +60,22 @@ class Observable(object):
         return name_f
 
     @classmethod
-    def bind_g(cls, name, method, oneshot = False):
-        if oneshot: method.oneshot = oneshot
+    def bind_g(cls, name, method, oneshot=False):
+        if oneshot:
+            method.oneshot = oneshot
         name_f = cls.name_f(name)
         methods = cls._events_g.get(name_f, [])
         methods.append(method)
         cls._events_g[name_f] = methods
 
     @classmethod
-    def unbind_g(cls, name, method = None):
+    def unbind_g(cls, name, method=None):
         name_f = cls.name_f(name)
         methods = cls._events_g.get(name_f, [])
-        if method: methods.remove(method)
-        else: del methods[:]
+        if method:
+            methods.remove(method)
+        else:
+            del methods[:]
 
     @classmethod
     def trigger_g(cls, name, *args, **kwargs):
@@ -89,12 +84,16 @@ class Observable(object):
         methods = cls._events_g.get(name_f, [])
         for method in methods:
             method(*args, **kwargs)
-            if not hasattr(method, "oneshot"): continue
-            if not method.oneshot: continue
+            if not hasattr(method, "oneshot"):
+                continue
+            if not method.oneshot:
+                continue
             oneshots = [] if oneshots == None else oneshots
             oneshots.append(method)
-        if not oneshots: return
-        for oneshot in oneshots: cls.unbind_g(name, oneshot)
+        if not oneshots:
+            return
+        for oneshot in oneshots:
+            cls.unbind_g(name, oneshot)
 
     def build(self):
         pass
@@ -102,20 +101,25 @@ class Observable(object):
     def destroy(self):
         self.unbind_all()
 
-    def bind(self, name, method, oneshot = False):
-        if oneshot: method.oneshot = oneshot
+    def bind(self, name, method, oneshot=False):
+        if oneshot:
+            method.oneshot = oneshot
         methods = self._events.get(name, [])
         methods.append(method)
         self._events[name] = methods
 
-    def unbind(self, name, method = None):
+    def unbind(self, name, method=None):
         methods = self._events.get(name, [])
-        if method: methods.remove(method)
-        else: del methods[:]
+        if method:
+            methods.remove(method)
+        else:
+            del methods[:]
 
     def unbind_all(self):
-        if not hasattr(self, "_events"): return
-        for methods in self._events.values(): del methods[:]
+        if not hasattr(self, "_events"):
+            return
+        for methods in self._events.values():
+            del methods[:]
         self._events.clear()
 
     def trigger(self, name, *args, **kwargs):
@@ -127,10 +131,14 @@ class Observable(object):
         methods = self._events.get(name, [])
         for method in methods:
             method(*args, **kwargs)
-            if not hasattr(method, "oneshot"): continue
-            if not method.oneshot: continue
+            if not hasattr(method, "oneshot"):
+                continue
+            if not method.oneshot:
+                continue
             oneshots = [] if oneshots == None else oneshots
             oneshots.append(method)
         level.trigger_g(name, self, *args, **kwargs)
-        if not oneshots: return
-        for oneshot in oneshots: self.unbind(name, oneshot)
+        if not oneshots:
+            return
+        for oneshot in oneshots:
+            self.unbind(name, oneshot)