flask-appbuilder 3.2.1rc1__py3-none-any.whl → 5.0.2__py3-none-any.whl

flask_appbuilder/models/group.py

@@ -16,10 +16,10 @@ log = logging.getLogger(__name__)
 
 def aggregate(label=""):
     """
-        Use this decorator to set a label for your aggregation functions on charts.
+    Use this decorator to set a label for your aggregation functions on charts.
 
-        :param label:
-            The label to complement with the column
+    :param label:
+        The label to complement with the column
     """
 
     def wrap(f):
@@ -32,8 +32,8 @@ def aggregate(label=""):
 @aggregate(_("Count of"))
 def aggregate_count(items, col):
     """
-        Function to use on Group by Charts.
-        accepts a list and returns the count of the list's items
+    Function to use on Group by Charts.
+    accepts a list and returns the count of the list's items
     """
     return len(list(items))
 
@@ -41,8 +41,8 @@ def aggregate_count(items, col):
 @aggregate(_("Sum of"))
 def aggregate_sum(items, col):
     """
-        Function to use on Group by Charts.
-        accepts a list and returns the sum of the list's items
+    Function to use on Group by Charts.
+    accepts a list and returns the sum of the list's items
     """
     return sum(getattr(item, col) for item in items)
 
@@ -50,8 +50,8 @@ def aggregate_sum(items, col):
 @aggregate(_("Avg. of"))
 def aggregate_avg(items, col):
     """
-        Function to use on Group by Charts.
-        accepts a list and returns the average of the list's items
+    Function to use on Group by Charts.
+    accepts a list and returns the average of the list's items
     """
     try:
         return aggregate_sum(items, col) / aggregate_count(items, col)
@@ -70,12 +70,12 @@ class BaseGroupBy(object):
         self, column_name, name, aggregate_func=aggregate_count, aggregate_col=""
     ):
         """
-            Constructor.
+        Constructor.
 
-            :param column_name:
-                Model field name
-            :param name:
-                The group by name
+        :param column_name:
+            Model field name
+        :param name:
+            The group by name
 
         """
         self.column_name = column_name
@@ -85,7 +85,7 @@ class BaseGroupBy(object):
 
     def apply(self, data):
         """
-            Override this to implement you own new filters
+        Override this to implement you own new filters
         """
         pass
 
@@ -118,7 +118,7 @@ class GroupByCol(BaseGroupBy):
             },
         ]
         json_data["rows"] = []
-        for (grouped, items) in groupby(data, self.get_group_col):
+        for grouped, items in groupby(data, self.get_group_col):
             aggregate_value = self.aggregate_func(items, self.aggregate_col)
             json_data["rows"].append(
                 {
@@ -181,13 +181,13 @@ class GroupByDateMonth(BaseGroupBy):
 
 class BaseProcessData(object):
     """
-        Base class to process data.
-        It will group data by one or many columns or functions.
-        The aggregation is made by an already defined function, or by a custom function
+    Base class to process data.
+    It will group data by one or many columns or functions.
+    The aggregation is made by an already defined function, or by a custom function
 
-        :group_bys_cols: A list of columns or functions to group data.
-        :aggr_by_cols: A list of tuples [(<AGGR FUNC>,'<COLNAME>'),...].
-        :formatter_by_cols: A dict.
+    :group_bys_cols: A list of columns or functions to group data.
+    :aggr_by_cols: A list of tuples [(<AGGR FUNC>,'<COLNAME>'),...].
+    :formatter_by_cols: A dict.
     """
 
     group_bys_cols = None
@@ -255,7 +255,7 @@ class BaseProcessData(object):
                 for group_col_data, i in zip(item[0], enumerate(item[0])):
                     row[self.group_bys_cols[i]] = str(group_col_data)
             for col_data, i in zip(item[1:], enumerate(item[1:])):
-                log.debug("{0},{1}".format(col_data, i))
+                log.debug("%s,%s", col_data, i)
                 key = self.aggr_by_cols[i].__name__ + self.aggr_by_cols[i]
                 if isinstance(col_data, datetime.date):
                     row[key] = str(col_data)
@@ -266,18 +266,18 @@ class BaseProcessData(object):
 
     def to_json(self, data, labels=None):
         """
-            Will return a dict with Google JSON structure for charts
+        Will return a dict with Google JSON structure for charts
 
-            The Google structure::
+        The Google structure::
 
-                {
-                    cols: [{id:<COL_NAME>, label:<LABEL FOR COL>, type: <COL TYPE>}, ...]
-                    rows: [{c: [{v: <COL VALUE}, ...], ... ]
-                }
+            {
+                cols: [{id:<COL_NAME>, label:<LABEL FOR COL>, type: <COL TYPE>}, ...]
+                rows: [{c: [{v: <COL VALUE}, ...], ... ]
+            }
 
-            :param data:
-            :param labels: dict with labels to include on Google JSON strcut
-            :return: dict with Google JSON structure
+        :param data:
+        :param labels: dict with labels to include on Google JSON strcut
+        :return: dict with Google JSON structure
         """
         labels = labels or dict()
         json_data = dict()
@@ -331,20 +331,18 @@ class DirectProcessData(BaseProcessData):
 
 class GroupByProcessData(BaseProcessData):
     """
-        Groups by data by chosen columns (property group_bys_cols).
+    Groups by data by chosen columns (property group_bys_cols).
 
-        :data: A list of objects
-        :sort: boolean, if true python will sort the data
-        :return: A List of lists with group column and aggregation
+    :data: A list of objects
+    :sort: boolean, if true python will sort the data
+    :return: A List of lists with group column and aggregation
     """
 
     def apply(self, data, sort=True):
         if sort:
             data = sorted(data, key=self.attrgetter(*self.group_bys_cols))
         result = []
-        for (grouped, items) in groupby(
-            data, key=self.attrgetter(*self.group_bys_cols)
-        ):
+        for grouped, items in groupby(data, key=self.attrgetter(*self.group_bys_cols)):
             items = list(items)
             result_item = [self.format_columns(grouped)]
             for aggr_by_col in self.aggr_by_cols:

flask_appbuilder/models/mixins.py

@@ -1,4 +1,4 @@
-import datetime
+from datetime import datetime
 import logging
 
 from flask import g
@@ -13,7 +13,7 @@ log = logging.getLogger(__name__)
 
 class FileColumn(types.TypeDecorator):
     """
-        Extends SQLAlchemy to support and mostly identify a File Column
+    Extends SQLAlchemy to support and mostly identify a File Column
     """
 
     impl = types.Text
@@ -21,7 +21,7 @@ class FileColumn(types.TypeDecorator):
 
 class ImageColumn(types.TypeDecorator):
     """
-        Extends SQLAlchemy to support and mostly identify an Image Column
+    Extends SQLAlchemy to support and mostly identify an Image Column
 
     """
 
@@ -33,24 +33,24 @@ class ImageColumn(types.TypeDecorator):
         self.size = size
 
 
-class AuditMixin(object):
+class AuditMixin:
     """
-        AuditMixin
-        Mixin for models, adds 4 columns to stamp,
-        time and user on creation and modification
-        will create the following columns:
-
-        :created on:
-        :changed on:
-        :created by:
-        :changed by:
+    AuditMixin
+    Mixin for models, adds 4 columns to stamp,
+    time and user on creation and modification
+    will create the following columns:
+
+    :created on:
+    :changed on:
+    :created by:
+    :changed by:
     """
 
-    created_on = Column(DateTime, default=datetime.datetime.now, nullable=False)
+    created_on = Column(DateTime, default=lambda: datetime.now(), nullable=False)
     changed_on = Column(
         DateTime,
-        default=datetime.datetime.now,
-        onupdate=datetime.datetime.now,
+        default=lambda: datetime.now(),
+        onupdate=lambda: datetime.now(),
         nullable=False,
     )
 
@@ -62,8 +62,10 @@ class AuditMixin(object):
 
     @declared_attr
     def created_by(cls):
+        from flask_appbuilder.security.sqla.models import User
+
         return relationship(
-            "User",
+            User,
             primaryjoin="%s.created_by_fk == User.id" % cls.__name__,
             enable_typechecks=False,
         )
@@ -80,8 +82,10 @@ class AuditMixin(object):
 
     @declared_attr
     def changed_by(cls):
+        from flask_appbuilder.security.sqla.models import User
+
         return relationship(
-            "User",
+            User,
             primaryjoin="%s.changed_by_fk == User.id" % cls.__name__,
             enable_typechecks=False,
         )

flask_appbuilder/models/sqla/__init__.py

@@ -1,91 +1,38 @@
-import datetime
-import logging
-import re
-
-from flask_sqlalchemy import _QueryProperty, DefaultMeta, SQLAlchemy
-
-try:
-    from sqlalchemy.ext.declarative import as_declarative
-except ImportError:
-    from sqlalchemy.ext.declarative.api import as_declarative
-
-try:
-    from sqlalchemy.orm.util import identity_key  # noqa
-
-    has_identity_key = True
-except ImportError:
-    has_identity_key = False
-
-log = logging.getLogger(__name__)
-
-_camelcase_re = re.compile(r"([A-Z]+)(?=[a-z0-9])")
-
-
-class SQLA(SQLAlchemy):
-    """
-        This is a child class of flask_SQLAlchemy
-        It's purpose is to override the declarative base of the original
-        package. So that it is bound to F.A.B. Model class allowing the dev
-        to be in the same namespace of the security tables (and others)
-        and can use AuditMixin class alike.
+from __future__ import annotations
 
-        Use it and configure it just like flask_SQLAlchemy
-    """
+import datetime
+from typing import Any
 
-    def make_declarative_base(self, model, metadata=None):
-        base = Model
-        base.query = _QueryProperty(self)
-        return base
+from sqlalchemy.orm import declarative_base
 
-    def get_tables_for_bind(self, bind=None):
-        """Returns a list of all tables relevant for a bind."""
-        result = []
-        tables = Model.metadata.tables
-        for key in tables:
-            if tables[key].info.get("bind_key") == bind:
-                result.append(tables[key])
-        return result
+Base = declarative_base()
 
 
-class ModelDeclarativeMeta(DefaultMeta):
-    """
-        Base Model declarative meta for all Models definitions.
-        Setups bind_keys to support multiple databases.
-        Setup the table name based on the class camelcase name.
+class Model(Base):
+    __abstract__ = True
     """
+    Use this class has the base for your models,
+    it will define your table names automatically
+    MyModel will be called my_model on the database.
 
+    ::
 
-@as_declarative(name="Model", metaclass=ModelDeclarativeMeta)
-class Model(object):
-    """
-        Use this class has the base for your models,
-        it will define your table names automatically
-        MyModel will be called my_model on the database.
+        from sqlalchemy import Integer, String
+        from flask_appbuilder import Model
 
-        ::
-
-            from sqlalchemy import Integer, String
-            from flask_appbuilder import Model
-
-            class MyModel(Model):
-                id = Column(Integer, primary_key=True)
-                name = Column(String(50), unique = True, nullable=False)
+        class MyModel(Model):
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50), unique = True, nullable=False)
 
     """
 
     __table_args__ = {"extend_existing": True}
 
-    def to_json(self):
-        result = dict()
+    def to_json(self) -> dict[str, Any]:
+        result = {}
         for key in self.__mapper__.c.keys():
             col = getattr(self, key)
-            if isinstance(col, datetime.datetime) or isinstance(col, datetime.date):
+            if isinstance(col, (datetime.datetime, datetime.date)):
                 col = col.isoformat()
             result[key] = col
         return result
-
-
-"""
-    This is for retro compatibility
-"""
-Base = Model

flask_appbuilder/models/sqla/base.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.engine import Connection, Engine
+from sqlalchemy.sql.schema import Table
+
+
+class SQLA(SQLAlchemy):
+    """
+    This is a child class of flask_SQLAlchemy
+    It's purpose is to override the declarative base of the original
+    package. So that it is bound to F.A.B. Model class allowing the dev
+    to be in the same namespace of the security tables (and others)
+    and can use AuditMixin class alike.
+
+    Configure just like flask_sqlalchemy SQLAlchemy
+    """
+
+    @staticmethod
+    def get_tables_for_bind(bind: Engine | Connection) -> list[Table]:
+        from sqlalchemy import inspect
+
+        inspector = inspect(bind)
+        return inspector.get_table_names()

flask_appbuilder/models/sqla/base_legacy.py

@@ -0,0 +1,132 @@
+import datetime
+import logging
+import re
+
+from flask_sqlalchemy import (
+    _QueryProperty,
+    DefaultMeta,
+    get_state,
+    SessionBase,
+    SignallingSession,
+    SQLAlchemy,
+)
+from sqlalchemy import orm
+
+try:
+    from sqlalchemy.ext.declarative import as_declarative
+except ImportError:
+    from sqlalchemy.ext.declarative.api import as_declarative
+
+try:
+    from sqlalchemy.orm.util import identity_key  # noqa
+
+    has_identity_key = True
+except ImportError:
+    has_identity_key = False
+
+log = logging.getLogger(__name__)
+
+_camelcase_re = re.compile(r"([A-Z]+)(?=[a-z0-9])")
+
+
+class CustomSignallingSession(SignallingSession):
+    """
+    Custom Signaling Session to support SQLALchemy>=1.4 with flask-sqlalchemy 2.X
+    https://github.com/pallets/flask-sqlalchemy/issues/953
+    """
+
+    def get_bind(self, mapper=None, *args, **kwargs):
+        """Return the engine or connection for a given model or
+        table, using the ``__bind_key__`` if it is set.
+
+        Patch from https://github.com/pallets/flask-sqlalchemy/pull/1001
+        """
+        # mapper is None if someone tries to just get a connection
+        if mapper is not None:
+            try:
+                # SA >= 1.3
+                persist_selectable = mapper.persist_selectable
+            except AttributeError:
+                # SA < 1.3
+                persist_selectable = mapper.mapped_table
+            info = getattr(persist_selectable, "info", {})
+            bind_key = info.get("bind_key")
+            if bind_key is not None:
+                state = get_state(self.app)
+                return state.db.get_engine(self.app, bind=bind_key)
+        return SessionBase.get_bind(self, mapper, *args, **kwargs)
+
+
+class SQLA(SQLAlchemy):
+    """
+    This is a child class of flask_SQLAlchemy
+    It's purpose is to override the declarative base of the original
+    package. So that it is bound to F.A.B. Model class allowing the dev
+    to be in the same namespace of the security tables (and others)
+    and can use AuditMixin class alike.
+
+    Use it and configure it just like flask_SQLAlchemy
+    """
+
+    def make_declarative_base(self, model, metadata=None):
+        base = Model
+        base.query = _QueryProperty(self)
+        return base
+
+    def get_tables_for_bind(self, bind=None):
+        """Returns a list of all tables relevant for a bind."""
+        result = []
+        tables = Model.metadata.tables
+        for key in tables:
+            if tables[key].info.get("bind_key") == bind:
+                result.append(tables[key])
+        return result
+
+    def create_session(self, options):
+        """
+        Custom Session factory to support SQLALchemy>=1.4 with flask-sqlalchemy 2.X
+
+        https://github.com/pallets/flask-sqlalchemy/issues/953
+
+        :param options: dict of keyword arguments passed to session class
+        """
+
+        return orm.sessionmaker(class_=CustomSignallingSession, db=self, **options)
+
+
+class ModelDeclarativeMeta(DefaultMeta):
+    """
+    Base Model declarative meta for all Models definitions.
+    Setups bind_keys to support multiple databases.
+    Setup the table name based on the class camelcase name.
+    """
+
+
+@as_declarative(name="Model", metaclass=ModelDeclarativeMeta)
+class Model(object):
+    """
+    Use this class has the base for your models,
+    it will define your table names automatically
+    MyModel will be called my_model on the database.
+
+    ::
+
+        from sqlalchemy import Integer, String
+        from flask_appbuilder import Model
+
+        class MyModel(Model):
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50), unique = True, nullable=False)
+
+    """
+
+    __table_args__ = {"extend_existing": True}
+
+    def to_json(self):
+        result = dict()
+        for key in self.__mapper__.c.keys():
+            col = getattr(self, key)
+            if isinstance(col, datetime.datetime) or isinstance(col, datetime.date):
+                col = col.isoformat()
+            result[key] = col
+        return result