chore: support sqlalchemy 2.x and flask-sqlalchemy 3 (breaking)

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
       - name: flake8
         run: flake8 flask_appbuilder
       - name: mypy
-        run: mypy flask_appbuilder
+        run: mypy flask_appbuilder/**/*.py
       - name: black
         run: black --check tests
       - name: flake8
@@ -187,62 +187,3 @@ jobs:
       - name: Upload code coverage
         run: |
           bash <(curl -s https://codecov.io/bash) -cF python
-
-  test-mongodb:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        python-version: [3.8]
-    services:
-      mongo:
-        image: mongo:4.4.1-bionic
-        ports:
-          - 27017:27017
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libldap2-dev libsasl2-dev libssl-dev
-          pip install --upgrade pip
-          pip install -r requirements/base.txt
-          pip install -r requirements/tests.txt
-          pip install -r requirements/extra.txt
-          pip install -r requirements/mongodb.txt
-      - name: Run tests
-        run: |
-          nose2 -c setup.cfg -F -v --with-coverage --coverage flask_appbuilder -A 'mongo' tests
-      - name: Upload code coverage
-        run: |
-          bash <(curl -s https://codecov.io/bash) -cF python
-
-  test-openid:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        python-version: [3.8]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libldap2-dev libsasl2-dev libssl-dev
-          pip install --upgrade pip
-          pip install -r requirements/base.txt
-          pip install -r requirements/tests.txt
-          pip install -r requirements/extra.txt
-          pip install -r requirements/openid.txt
-      - name: Run tests
-        run: |
-          nose2 -c setup.cfg -F -v --with-coverage --coverage flask_appbuilder -A 'openid' tests
-      - name: Upload code coverage
-        run: |
-          bash <(curl -s https://codecov.io/bash) -cF python

examples/base_api/README.rst

@@ -5,7 +5,6 @@ Simple example showing how to use *BaseApi* class
 
 Run it::
 
-    $ export FLASK_APP=app/__init__.py
     $ flask run
 
 For Swagger view go to: http://localhost:5000/swagger/v1

examples/base_api/app/__init__.py

@@ -1,19 +1,13 @@
-import logging
-
 from flask import Flask
-from flask_appbuilder import AppBuilder, SQLA
-
-"""
- Logging configuration
-"""
-logging.basicConfig(format="%(asctime)s:%(levelname)s:%(name)s:%(message)s")
-logging.getLogger().setLevel(logging.DEBUG)
-
 
-app = Flask(__name__)
-app.config.from_object("config")
-db = SQLA(app)
-appbuilder = AppBuilder(app, db.session)
+from .api import ExampleApi
+from .extensions import appbuilder
 
 
-from . import api  # noqa
+def create_app() -> Flask:
+    app = Flask(__name__)
+    app.config.from_object("config")
+    with app.app_context():
+        appbuilder.init_app(app)
+        appbuilder.add_api(ExampleApi)
+    return app

examples/base_api/app/api.py

@@ -2,13 +2,15 @@
 from flask_appbuilder.api import BaseApi, expose, rison, safe
 from flask_appbuilder.security.decorators import protect
 
-from . import appbuilder
 
-greeting_schema = {"type": "object", "properties": {"name": {"type": "string"}}}
+greeting_schema = {
+    "type": "object",
+    "properties": {"name": {"type": "string"}},
+    "required": ["name"],
+}
 
 
 class ExampleApi(BaseApi):
-
     resource_name = "example"
     apispec_parameter_schemas = {"greeting_schema": greeting_schema}
 
@@ -77,7 +79,12 @@ def greeting4(self, **kwargs):
         ---
         get:
           parameters:
-          - $ref: '#/components/parameters/greeting_schema'
+          - in: query
+            name: q
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/greeting_schema'
           responses:
             200:
               description: Greet the user
@@ -137,6 +144,3 @@ def error(self):
               $ref: '#/components/responses/500'
         """
         raise Exception
-
-
-appbuilder.add_api(ExampleApi)

examples/base_api/app/extensions.py

@@ -0,0 +1,4 @@
+from flask_appbuilder import AppBuilder
+
+
+appbuilder = AppBuilder()

examples/base_api/config.py

@@ -5,55 +5,12 @@
 CSRF_ENABLED = True
 SECRET_KEY = "\2\1thisismyscretkey\1\2\e\y\y\h"
 
-OPENID_PROVIDERS = [
-    {"name": "Google", "url": "https://www.google.com/accounts/o8/id"},
-    {"name": "Yahoo", "url": "https://me.yahoo.com"},
-    {"name": "AOL", "url": "http://openid.aol.com/<username>"},
-    {"name": "Flickr", "url": "http://www.flickr.com/<username>"},
-    {"name": "MyOpenID", "url": "https://www.myopenid.com"},
-]
-
 SQLALCHEMY_DATABASE_URI = "sqlite:///" + os.path.join(basedir, "app.db")
 # SQLALCHEMY_DATABASE_URI = 'mysql://myapp@localhost/myapp'
 # SQLALCHEMY_DATABASE_URI = 'postgresql://root:password@localhost/myapp'
 BABEL_DEFAULT_LOCALE = "en"
 
-
 # ------------------------------
 # GLOBALS FOR APP Builder
 # ------------------------------
 FAB_API_SWAGGER_UI = True
-
-BABEL_DEFAULT_LOCALE = "en"
-BABEL_DEFAULT_FOLDER = "translations"
-LANGUAGES = {
-    "en": {"flag": "gb", "name": "English"},
-    "pt": {"flag": "pt", "name": "Portuguese"},
-    "es": {"flag": "es", "name": "Spanish"},
-    "de": {"flag": "de", "name": "German"},
-    "zh": {"flag": "cn", "name": "Chinese"},
-    "ru": {"flag": "ru", "name": "Russian"},
-}
-
-
-UPLOAD_FOLDER = basedir + "/app/static/uploads/"
-IMG_UPLOAD_FOLDER = basedir + "/app/static/uploads/"
-IMG_UPLOAD_URL = "/static/uploads/"
-AUTH_TYPE = 1
-AUTH_ROLE_ADMIN = "Admin"
-AUTH_ROLE_PUBLIC = "Public"
-# APP_NAME = "My App Name"
-# APP_ICON = "static/img/logo.jpg"
-APP_THEME = ""  # default
-# APP_THEME = "cerulean.css"
-# APP_THEME = "amelia.css"
-# APP_THEME = "cosmo.css"
-# APP_THEME = "cyborg.css"
-# APP_THEME = "flatly.css"
-# APP_THEME = "journal.css"
-# APP_THEME = "readable.css"
-# APP_THEME = "simplex.css"
-# APP_THEME = "slate.css"
-# APP_THEME = "spacelab.css"
-# APP_THEME = "united.css"
-# APP_THEME = "yeti.css"