You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/11/18 02:27:12 UTC
[GitHub] [airflow] jhtimmins opened a new pull request #19667: Add FAB base class and set import_name explicitly.
jhtimmins opened a new pull request #19667:
URL: https://github.com/apache/airflow/pull/19667
This change was previously made and then reverted bc it caused static assets to load incorrectly.. The bug has been fixed by explicitly passing the name "flask_appbuilder.base" into the blueprint.
This is part of the ongoing epic to refactor Airflow's auth architecture. Currently, the auth code includes methods that are no longer needed given how Airflow uses auth, but they're still required by FABs base class. By copying the base class directly into Airflow, with attribution to Daniel Gaspar, FAB's author, we can modify the base class as necessary to simplify Airflow's auth code.
In addition to the blueprint name, the only change is customizing the behavior of `. _check_and_init()`.
Tl;Dr -- Copies FAB's AppBuilder class directly into Airflow.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] josh-fell commented on a change in pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
josh-fell commented on a change in pull request #19667:
URL: https://github.com/apache/airflow/pull/19667#discussion_r752334594
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,623 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
Review comment:
```suggestion
This is where you will register all your views
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,623 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
Review comment:
```suggestion
Initialize your application like this for SQLAlchemy::
```
No strong opinion here really. Just makes it consistent with the "When using MongoEngine::..." portion of this docstring.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] josh-fell commented on a change in pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
josh-fell commented on a change in pull request #19667:
URL: https://github.com/apache/airflow/pull/19667#discussion_r752422059
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,623 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
Review comment:
Right on, thanks Ash. @jhtimmins Ignore me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] ashb commented on a change in pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
ashb commented on a change in pull request #19667:
URL: https://github.com/apache/airflow/pull/19667#discussion_r752411285
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,623 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
Review comment:
These are all as-is from Flask-AppBuilder and in this PR we are pulling it all in without changes.
So yes, but not in this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a change in pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
uranusjr commented on a change in pull request #19667:
URL: https://github.com/apache/airflow/pull/19667#discussion_r751892256
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
+ :param indexview:
+ optional, your customized indexview
+ :param static_folder:
+ optional, your override for the global static folder
+ :param static_url_path:
+ optional, your override for the global static url path
+ :param security_manager_class:
+ optional, pass your own security manager class
+ :param update_perms:
+ optional, update permissions flag (Boolean) you can use
+ FAB_UPDATE_PERMS config key also
+ """
+
+ self.baseviews = []
+ self._addon_managers = []
+ self.addon_managers = {}
+ self.menu = menu
+ self.base_template = base_template
+ self.security_manager_class = security_manager_class
+ self.indexview = indexview
+ self.static_folder = static_folder
+ self.static_url_path = static_url_path
+ self.app = app
+ self.update_perms = update_perms
+ if app is not None:
+ self.init_app(app, session)
+
+ def init_app(self, app, session):
+ """
+ Will initialize the Flask app, supporting the app factory pattern.
+ :param app:
+ :param session: The SQLAlchemy session
+ """
+ app.config.setdefault("APP_NAME", "F.A.B.")
+ app.config.setdefault("APP_THEME", "")
+ app.config.setdefault("APP_ICON", "")
+ app.config.setdefault("LANGUAGES", {"en": {"flag": "gb", "name": "English"}})
+ app.config.setdefault("ADDON_MANAGERS", [])
+ app.config.setdefault("FAB_API_MAX_PAGE_SIZE", 100)
+ app.config.setdefault("FAB_BASE_TEMPLATE", self.base_template)
+ app.config.setdefault("FAB_STATIC_FOLDER", self.static_folder)
+ app.config.setdefault("FAB_STATIC_URL_PATH", self.static_url_path)
+
+ self.app = app
+
+ self.base_template = app.config.get("FAB_BASE_TEMPLATE", self.base_template)
+ self.static_folder = app.config.get("FAB_STATIC_FOLDER", self.static_folder)
+ self.static_url_path = app.config.get("FAB_STATIC_URL_PATH", self.static_url_path)
+ _index_view = app.config.get("FAB_INDEX_VIEW", None)
+ if _index_view is not None:
+ self.indexview = dynamic_class_import(_index_view)
+ else:
+ self.indexview = self.indexview or IndexView
+ _menu = app.config.get("FAB_MENU", None)
+ if _menu is not None:
+ self.menu = dynamic_class_import(_menu)
+ else:
+ self.menu = self.menu or Menu()
+
+ if self.update_perms: # default is True, if False takes precedence from config
+ self.update_perms = app.config.get("FAB_UPDATE_PERMS", True)
+ _security_manager_class_name = app.config.get("FAB_SECURITY_MANAGER_CLASS", None)
+ if _security_manager_class_name is not None:
+ self.security_manager_class = dynamic_class_import(_security_manager_class_name)
+ if self.security_manager_class is None:
+ from flask_appbuilder.security.sqla.manager import SecurityManager
+
+ self.security_manager_class = SecurityManager
+
+ self._addon_managers = app.config["ADDON_MANAGERS"]
+ self.session = session
+ self.sm = self.security_manager_class(self)
+ self.bm = BabelManager(self)
+ self.openapi_manager = OpenApiManager(self)
+ self.menuapi_manager = MenuApiManager(self)
+ self._add_global_static()
+ self._add_global_filters()
+ app.before_request(self.sm.before_request)
+ self._add_admin_views()
+ self._add_addon_views()
+ if self.app:
+ self._add_menu_permissions()
+ else:
+ self.post_init()
+ self._init_extension(app)
+
+ def _init_extension(self, app):
+ app.appbuilder = self
+ if not hasattr(app, "extensions"):
+ app.extensions = {}
+ app.extensions["appbuilder"] = self
+
+ def post_init(self):
+ for baseview in self.baseviews:
+ # instantiate the views and add session
+ self._check_and_init(baseview)
+ # Register the views has blueprints
+ if baseview.__class__.__name__ not in self.get_app.blueprints.keys():
+ self.register_blueprint(baseview)
+ # Add missing permissions where needed
+ self.add_permissions()
+
+ @property
+ def get_app(self):
+ """
+ Get current or configured flask app
+ :return: Flask App
+ """
+ if self.app:
+ return self.app
+ else:
+ return current_app
+
+ @property
+ def get_session(self):
+ """
+ Get the current sqlalchemy session.
+ :return: SQLAlchemy Session
+ """
+ return self.session
+
+ @property
+ def app_name(self):
+ """
+ Get the App name
+ :return: String with app name
+ """
+ return self.get_app.config["APP_NAME"]
+
+ @property
+ def app_theme(self):
+ """
+ Get the App theme name
+ :return: String app theme name
+ """
+ return self.get_app.config["APP_THEME"]
+
+ @property
+ def app_icon(self):
+ """
+ Get the App icon location
+ :return: String with relative app icon location
+ """
+ return self.get_app.config["APP_ICON"]
+
+ @property
+ def languages(self):
+ return self.get_app.config["LANGUAGES"]
+
+ @property
+ def version(self):
+ """
+ Get the current F.A.B. version
+ :return: String with the current F.A.B. version
+ """
+ return __version__
+
+ def _add_global_filters(self):
+ self.template_filters = TemplateFilters(self.get_app, self.sm)
+
+ def _add_global_static(self):
+ bp = Blueprint(
+ "appbuilder",
+ 'flask_appbuilder.base',
+ url_prefix="/static",
+ template_folder="templates",
+ static_folder=self.static_folder,
+ static_url_path=self.static_url_path,
+ )
+ self.get_app.register_blueprint(bp)
+
+ def _add_admin_views(self):
+ """
+ Registers indexview, utilview (back function), babel views and Security views.
+ """
+ self.indexview = self._check_and_init(self.indexview)
+ self.add_view_no_menu(self.indexview)
+ self.add_view_no_menu(UtilView())
+ self.bm.register_views()
+ self.sm.register_views()
+ self.openapi_manager.register_views()
+ self.menuapi_manager.register_views()
+
+ def _add_addon_views(self):
+ """
+ Registers declared addon's
+ """
+ for addon in self._addon_managers:
+ addon_class = dynamic_class_import(addon)
+ if addon_class:
+ # Instantiate manager with appbuilder (self)
+ addon_class = addon_class(self)
+ try:
+ addon_class.pre_process()
+ addon_class.register_views()
+ addon_class.post_process()
+ self.addon_managers[addon] = addon_class
+ log.info(LOGMSG_INF_FAB_ADDON_ADDED.format(str(addon)))
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_PROCESS.format(addon, e))
+
+ def _check_and_init(self, baseview):
+ if hasattr(baseview, 'datamodel'):
+ baseview.datamodel.session = self.session
+ if hasattr(baseview, "__call__"):
+ baseview = baseview()
+ return baseview
+
+ def add_view(
+ self,
+ baseview,
+ name,
+ href="",
+ icon="",
+ label="",
+ category="",
+ category_icon="",
+ category_label="",
+ menu_cond=None,
+ ):
+ """
+ Add your views associated with menus using this method.
+ :param baseview:
+ A BaseView type class instantiated or not.
+ This method will instantiate the class for you if needed.
+ :param name:
+ The string name that identifies the menu.
+ :param href:
+ Override the generated href for the menu.
+ You can use an url string or an endpoint name
+ if non provided default_view from view will be set as href.
+ :param icon:
+ Font-Awesome icon name, optional.
+ :param label:
+ The label that will be displayed on the menu,
+ if absent param name will be used
+ :param category:
+ The menu category where the menu will be included,
+ if non provided the view will be acessible as a top menu.
Review comment:
```suggestion
if non provided the view will be accessible as a top menu.
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
+ :param indexview:
+ optional, your customized indexview
+ :param static_folder:
+ optional, your override for the global static folder
+ :param static_url_path:
+ optional, your override for the global static url path
+ :param security_manager_class:
+ optional, pass your own security manager class
+ :param update_perms:
+ optional, update permissions flag (Boolean) you can use
+ FAB_UPDATE_PERMS config key also
+ """
+
+ self.baseviews = []
+ self._addon_managers = []
+ self.addon_managers = {}
+ self.menu = menu
+ self.base_template = base_template
+ self.security_manager_class = security_manager_class
+ self.indexview = indexview
+ self.static_folder = static_folder
+ self.static_url_path = static_url_path
+ self.app = app
+ self.update_perms = update_perms
+ if app is not None:
+ self.init_app(app, session)
+
+ def init_app(self, app, session):
+ """
+ Will initialize the Flask app, supporting the app factory pattern.
+ :param app:
+ :param session: The SQLAlchemy session
+ """
+ app.config.setdefault("APP_NAME", "F.A.B.")
+ app.config.setdefault("APP_THEME", "")
+ app.config.setdefault("APP_ICON", "")
+ app.config.setdefault("LANGUAGES", {"en": {"flag": "gb", "name": "English"}})
+ app.config.setdefault("ADDON_MANAGERS", [])
+ app.config.setdefault("FAB_API_MAX_PAGE_SIZE", 100)
+ app.config.setdefault("FAB_BASE_TEMPLATE", self.base_template)
+ app.config.setdefault("FAB_STATIC_FOLDER", self.static_folder)
+ app.config.setdefault("FAB_STATIC_URL_PATH", self.static_url_path)
+
+ self.app = app
+
+ self.base_template = app.config.get("FAB_BASE_TEMPLATE", self.base_template)
+ self.static_folder = app.config.get("FAB_STATIC_FOLDER", self.static_folder)
+ self.static_url_path = app.config.get("FAB_STATIC_URL_PATH", self.static_url_path)
+ _index_view = app.config.get("FAB_INDEX_VIEW", None)
+ if _index_view is not None:
+ self.indexview = dynamic_class_import(_index_view)
+ else:
+ self.indexview = self.indexview or IndexView
+ _menu = app.config.get("FAB_MENU", None)
+ if _menu is not None:
+ self.menu = dynamic_class_import(_menu)
+ else:
+ self.menu = self.menu or Menu()
+
+ if self.update_perms: # default is True, if False takes precedence from config
+ self.update_perms = app.config.get("FAB_UPDATE_PERMS", True)
+ _security_manager_class_name = app.config.get("FAB_SECURITY_MANAGER_CLASS", None)
+ if _security_manager_class_name is not None:
+ self.security_manager_class = dynamic_class_import(_security_manager_class_name)
+ if self.security_manager_class is None:
+ from flask_appbuilder.security.sqla.manager import SecurityManager
+
+ self.security_manager_class = SecurityManager
+
+ self._addon_managers = app.config["ADDON_MANAGERS"]
+ self.session = session
+ self.sm = self.security_manager_class(self)
+ self.bm = BabelManager(self)
+ self.openapi_manager = OpenApiManager(self)
+ self.menuapi_manager = MenuApiManager(self)
+ self._add_global_static()
+ self._add_global_filters()
+ app.before_request(self.sm.before_request)
+ self._add_admin_views()
+ self._add_addon_views()
+ if self.app:
+ self._add_menu_permissions()
+ else:
+ self.post_init()
+ self._init_extension(app)
+
+ def _init_extension(self, app):
+ app.appbuilder = self
+ if not hasattr(app, "extensions"):
+ app.extensions = {}
+ app.extensions["appbuilder"] = self
+
+ def post_init(self):
+ for baseview in self.baseviews:
+ # instantiate the views and add session
+ self._check_and_init(baseview)
+ # Register the views has blueprints
+ if baseview.__class__.__name__ not in self.get_app.blueprints.keys():
+ self.register_blueprint(baseview)
+ # Add missing permissions where needed
+ self.add_permissions()
+
+ @property
+ def get_app(self):
+ """
+ Get current or configured flask app
+ :return: Flask App
+ """
+ if self.app:
+ return self.app
+ else:
+ return current_app
+
+ @property
+ def get_session(self):
+ """
+ Get the current sqlalchemy session.
+ :return: SQLAlchemy Session
+ """
+ return self.session
+
+ @property
+ def app_name(self):
+ """
+ Get the App name
+ :return: String with app name
+ """
+ return self.get_app.config["APP_NAME"]
+
+ @property
+ def app_theme(self):
+ """
+ Get the App theme name
+ :return: String app theme name
+ """
+ return self.get_app.config["APP_THEME"]
+
+ @property
+ def app_icon(self):
+ """
+ Get the App icon location
+ :return: String with relative app icon location
+ """
+ return self.get_app.config["APP_ICON"]
+
+ @property
+ def languages(self):
+ return self.get_app.config["LANGUAGES"]
+
+ @property
+ def version(self):
+ """
+ Get the current F.A.B. version
+ :return: String with the current F.A.B. version
+ """
+ return __version__
+
+ def _add_global_filters(self):
+ self.template_filters = TemplateFilters(self.get_app, self.sm)
+
+ def _add_global_static(self):
+ bp = Blueprint(
+ "appbuilder",
+ 'flask_appbuilder.base',
+ url_prefix="/static",
+ template_folder="templates",
+ static_folder=self.static_folder,
+ static_url_path=self.static_url_path,
+ )
+ self.get_app.register_blueprint(bp)
+
+ def _add_admin_views(self):
+ """
+ Registers indexview, utilview (back function), babel views and Security views.
+ """
+ self.indexview = self._check_and_init(self.indexview)
+ self.add_view_no_menu(self.indexview)
+ self.add_view_no_menu(UtilView())
+ self.bm.register_views()
+ self.sm.register_views()
+ self.openapi_manager.register_views()
+ self.menuapi_manager.register_views()
+
+ def _add_addon_views(self):
+ """
+ Registers declared addon's
+ """
+ for addon in self._addon_managers:
+ addon_class = dynamic_class_import(addon)
+ if addon_class:
+ # Instantiate manager with appbuilder (self)
+ addon_class = addon_class(self)
+ try:
+ addon_class.pre_process()
+ addon_class.register_views()
+ addon_class.post_process()
+ self.addon_managers[addon] = addon_class
+ log.info(LOGMSG_INF_FAB_ADDON_ADDED.format(str(addon)))
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_PROCESS.format(addon, e))
+
+ def _check_and_init(self, baseview):
+ if hasattr(baseview, 'datamodel'):
+ baseview.datamodel.session = self.session
+ if hasattr(baseview, "__call__"):
+ baseview = baseview()
+ return baseview
+
+ def add_view(
+ self,
+ baseview,
+ name,
+ href="",
+ icon="",
+ label="",
+ category="",
+ category_icon="",
+ category_label="",
+ menu_cond=None,
+ ):
+ """
+ Add your views associated with menus using this method.
Review comment:
```suggestion
"""Add your views associated with menus using this method.
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
Review comment:
```suggestion
App-builder constructor.
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
+ :param indexview:
+ optional, your customized indexview
+ :param static_folder:
+ optional, your override for the global static folder
+ :param static_url_path:
+ optional, your override for the global static url path
+ :param security_manager_class:
+ optional, pass your own security manager class
+ :param update_perms:
+ optional, update permissions flag (Boolean) you can use
+ FAB_UPDATE_PERMS config key also
+ """
+
Review comment:
```suggestion
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
Review comment:
```suggestion
optional, a previous constructed menu
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
+ :param indexview:
+ optional, your customized indexview
+ :param static_folder:
+ optional, your override for the global static folder
+ :param static_url_path:
+ optional, your override for the global static url path
+ :param security_manager_class:
+ optional, pass your own security manager class
+ :param update_perms:
+ optional, update permissions flag (Boolean) you can use
+ FAB_UPDATE_PERMS config key also
+ """
+
+ self.baseviews = []
+ self._addon_managers = []
+ self.addon_managers = {}
+ self.menu = menu
+ self.base_template = base_template
+ self.security_manager_class = security_manager_class
+ self.indexview = indexview
+ self.static_folder = static_folder
+ self.static_url_path = static_url_path
+ self.app = app
+ self.update_perms = update_perms
+ if app is not None:
+ self.init_app(app, session)
+
+ def init_app(self, app, session):
+ """
+ Will initialize the Flask app, supporting the app factory pattern.
+ :param app:
+ :param session: The SQLAlchemy session
+ """
+ app.config.setdefault("APP_NAME", "F.A.B.")
+ app.config.setdefault("APP_THEME", "")
+ app.config.setdefault("APP_ICON", "")
+ app.config.setdefault("LANGUAGES", {"en": {"flag": "gb", "name": "English"}})
+ app.config.setdefault("ADDON_MANAGERS", [])
+ app.config.setdefault("FAB_API_MAX_PAGE_SIZE", 100)
+ app.config.setdefault("FAB_BASE_TEMPLATE", self.base_template)
+ app.config.setdefault("FAB_STATIC_FOLDER", self.static_folder)
+ app.config.setdefault("FAB_STATIC_URL_PATH", self.static_url_path)
+
+ self.app = app
+
+ self.base_template = app.config.get("FAB_BASE_TEMPLATE", self.base_template)
+ self.static_folder = app.config.get("FAB_STATIC_FOLDER", self.static_folder)
+ self.static_url_path = app.config.get("FAB_STATIC_URL_PATH", self.static_url_path)
+ _index_view = app.config.get("FAB_INDEX_VIEW", None)
+ if _index_view is not None:
+ self.indexview = dynamic_class_import(_index_view)
+ else:
+ self.indexview = self.indexview or IndexView
+ _menu = app.config.get("FAB_MENU", None)
+ if _menu is not None:
+ self.menu = dynamic_class_import(_menu)
+ else:
+ self.menu = self.menu or Menu()
+
+ if self.update_perms: # default is True, if False takes precedence from config
+ self.update_perms = app.config.get("FAB_UPDATE_PERMS", True)
+ _security_manager_class_name = app.config.get("FAB_SECURITY_MANAGER_CLASS", None)
+ if _security_manager_class_name is not None:
+ self.security_manager_class = dynamic_class_import(_security_manager_class_name)
+ if self.security_manager_class is None:
+ from flask_appbuilder.security.sqla.manager import SecurityManager
+
+ self.security_manager_class = SecurityManager
+
+ self._addon_managers = app.config["ADDON_MANAGERS"]
+ self.session = session
+ self.sm = self.security_manager_class(self)
+ self.bm = BabelManager(self)
+ self.openapi_manager = OpenApiManager(self)
+ self.menuapi_manager = MenuApiManager(self)
+ self._add_global_static()
+ self._add_global_filters()
+ app.before_request(self.sm.before_request)
+ self._add_admin_views()
+ self._add_addon_views()
+ if self.app:
+ self._add_menu_permissions()
+ else:
+ self.post_init()
+ self._init_extension(app)
+
+ def _init_extension(self, app):
+ app.appbuilder = self
+ if not hasattr(app, "extensions"):
+ app.extensions = {}
+ app.extensions["appbuilder"] = self
+
+ def post_init(self):
+ for baseview in self.baseviews:
+ # instantiate the views and add session
+ self._check_and_init(baseview)
+ # Register the views has blueprints
+ if baseview.__class__.__name__ not in self.get_app.blueprints.keys():
+ self.register_blueprint(baseview)
+ # Add missing permissions where needed
+ self.add_permissions()
+
+ @property
+ def get_app(self):
+ """
+ Get current or configured flask app
+ :return: Flask App
+ """
+ if self.app:
+ return self.app
+ else:
+ return current_app
+
+ @property
+ def get_session(self):
+ """
+ Get the current sqlalchemy session.
+ :return: SQLAlchemy Session
+ """
+ return self.session
+
+ @property
+ def app_name(self):
+ """
+ Get the App name
+ :return: String with app name
+ """
+ return self.get_app.config["APP_NAME"]
+
+ @property
+ def app_theme(self):
+ """
+ Get the App theme name
+ :return: String app theme name
+ """
+ return self.get_app.config["APP_THEME"]
+
+ @property
+ def app_icon(self):
+ """
+ Get the App icon location
+ :return: String with relative app icon location
+ """
+ return self.get_app.config["APP_ICON"]
+
+ @property
+ def languages(self):
+ return self.get_app.config["LANGUAGES"]
+
+ @property
+ def version(self):
+ """
+ Get the current F.A.B. version
+ :return: String with the current F.A.B. version
+ """
+ return __version__
+
+ def _add_global_filters(self):
+ self.template_filters = TemplateFilters(self.get_app, self.sm)
+
+ def _add_global_static(self):
+ bp = Blueprint(
+ "appbuilder",
+ 'flask_appbuilder.base',
+ url_prefix="/static",
+ template_folder="templates",
+ static_folder=self.static_folder,
+ static_url_path=self.static_url_path,
+ )
+ self.get_app.register_blueprint(bp)
+
+ def _add_admin_views(self):
+ """
+ Registers indexview, utilview (back function), babel views and Security views.
+ """
Review comment:
```suggestion
"""Register indexview, utilview (back function), babel views and Security views."""
```
##########
File path: airflow/www/extensions/init_appbuilder.py
##########
@@ -15,11 +15,627 @@
# specific language governing permissions and limitations
# under the License.
-from flask_appbuilder import AppBuilder
+# This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
+# (https://github.com/dpgaspar/Flask-AppBuilder).
+# Copyright 2013, Daniel Vaz Gaspar
+
+
+import logging
+from functools import reduce
+from typing import Dict
+
+from flask import Blueprint, current_app, url_for
+from flask_appbuilder import __version__
+from flask_appbuilder.api.manager import OpenApiManager
+from flask_appbuilder.babel.manager import BabelManager
+from flask_appbuilder.const import (
+ LOGMSG_ERR_FAB_ADD_PERMISSION_MENU,
+ LOGMSG_ERR_FAB_ADD_PERMISSION_VIEW,
+ LOGMSG_ERR_FAB_ADDON_IMPORT,
+ LOGMSG_ERR_FAB_ADDON_PROCESS,
+ LOGMSG_INF_FAB_ADD_VIEW,
+ LOGMSG_INF_FAB_ADDON_ADDED,
+ LOGMSG_WAR_FAB_VIEW_EXISTS,
+)
+from flask_appbuilder.filters import TemplateFilters
+from flask_appbuilder.menu import Menu, MenuApiManager
+from flask_appbuilder.views import IndexView, UtilView
from airflow import settings
from airflow.configuration import conf
+log = logging.getLogger(__name__)
+
+
+def dynamic_class_import(class_path):
+ """
+ Will dynamically import a class from a string path
+ :param class_path: string with class path
+ :return: class
+ """
+ # Split first occurrence of path
+ try:
+ tmp = class_path.split(".")
+ module_path = ".".join(tmp[0:-1])
+ package = __import__(module_path)
+ return reduce(getattr, tmp[1:], package)
+ except Exception as e:
+ log.exception(e)
+ log.error(LOGMSG_ERR_FAB_ADDON_IMPORT.format(class_path, e))
+
+
+class AirflowAppBuilder:
+ """
+ This is the base class for all the framework.
+ This is were you will register all your views
+ and create the menu structure.
+ Will hold your flask app object, all your views, and security classes.
+ initialize your application like this for SQLAlchemy::
+ from flask import Flask
+ from flask_appbuilder import SQLA, AppBuilder
+ app = Flask(__name__)
+ app.config.from_object('config')
+ db = SQLA(app)
+ appbuilder = AppBuilder(app, db.session)
+ When using MongoEngine::
+ from flask import Flask
+ from flask_appbuilder import AppBuilder
+ from flask_appbuilder.security.mongoengine.manager import SecurityManager
+ from flask_mongoengine import MongoEngine
+ app = Flask(__name__)
+ app.config.from_object('config')
+ dbmongo = MongoEngine(app)
+ appbuilder = AppBuilder(app, security_manager_class=SecurityManager)
+ You can also create everything as an application factory.
+ """
+
+ baseviews = []
+ security_manager_class = None
+ # Flask app
+ app = None
+ # Database Session
+ session = None
+ # Security Manager Class
+ sm = None
+ # Babel Manager Class
+ bm = None
+ # OpenAPI Manager Class
+ openapi_manager = None
+ # dict with addon name has key and intantiated class has value
+ addon_managers = None
+ # temporary list that hold addon_managers config key
+ _addon_managers = None
+
+ menu = None
+ indexview = None
+
+ static_folder = None
+ static_url_path = None
+
+ template_filters = None
+
+ def __init__(
+ self,
+ app=None,
+ session=None,
+ menu=None,
+ indexview=None,
+ base_template='airflow/main.html',
+ static_folder="static/appbuilder",
+ static_url_path="/appbuilder",
+ security_manager_class=None,
+ update_perms=conf.getboolean('webserver', 'UPDATE_FAB_PERMS'),
+ ):
+ """
+ AppBuilder constructor
+ :param app:
+ The flask app object
+ :param session:
+ The SQLAlchemy session object
+ :param menu:
+ optional, a previous contructed menu
+ :param indexview:
+ optional, your customized indexview
+ :param static_folder:
+ optional, your override for the global static folder
+ :param static_url_path:
+ optional, your override for the global static url path
+ :param security_manager_class:
+ optional, pass your own security manager class
+ :param update_perms:
+ optional, update permissions flag (Boolean) you can use
+ FAB_UPDATE_PERMS config key also
+ """
+
+ self.baseviews = []
+ self._addon_managers = []
+ self.addon_managers = {}
+ self.menu = menu
+ self.base_template = base_template
+ self.security_manager_class = security_manager_class
+ self.indexview = indexview
+ self.static_folder = static_folder
+ self.static_url_path = static_url_path
+ self.app = app
+ self.update_perms = update_perms
+ if app is not None:
+ self.init_app(app, session)
+
+ def init_app(self, app, session):
+ """
+ Will initialize the Flask app, supporting the app factory pattern.
+ :param app:
+ :param session: The SQLAlchemy session
+ """
+ app.config.setdefault("APP_NAME", "F.A.B.")
+ app.config.setdefault("APP_THEME", "")
+ app.config.setdefault("APP_ICON", "")
+ app.config.setdefault("LANGUAGES", {"en": {"flag": "gb", "name": "English"}})
+ app.config.setdefault("ADDON_MANAGERS", [])
+ app.config.setdefault("FAB_API_MAX_PAGE_SIZE", 100)
+ app.config.setdefault("FAB_BASE_TEMPLATE", self.base_template)
+ app.config.setdefault("FAB_STATIC_FOLDER", self.static_folder)
+ app.config.setdefault("FAB_STATIC_URL_PATH", self.static_url_path)
+
+ self.app = app
+
+ self.base_template = app.config.get("FAB_BASE_TEMPLATE", self.base_template)
+ self.static_folder = app.config.get("FAB_STATIC_FOLDER", self.static_folder)
+ self.static_url_path = app.config.get("FAB_STATIC_URL_PATH", self.static_url_path)
+ _index_view = app.config.get("FAB_INDEX_VIEW", None)
+ if _index_view is not None:
+ self.indexview = dynamic_class_import(_index_view)
+ else:
+ self.indexview = self.indexview or IndexView
+ _menu = app.config.get("FAB_MENU", None)
+ if _menu is not None:
+ self.menu = dynamic_class_import(_menu)
+ else:
+ self.menu = self.menu or Menu()
+
+ if self.update_perms: # default is True, if False takes precedence from config
+ self.update_perms = app.config.get("FAB_UPDATE_PERMS", True)
+ _security_manager_class_name = app.config.get("FAB_SECURITY_MANAGER_CLASS", None)
+ if _security_manager_class_name is not None:
+ self.security_manager_class = dynamic_class_import(_security_manager_class_name)
+ if self.security_manager_class is None:
+ from flask_appbuilder.security.sqla.manager import SecurityManager
+
+ self.security_manager_class = SecurityManager
+
+ self._addon_managers = app.config["ADDON_MANAGERS"]
+ self.session = session
+ self.sm = self.security_manager_class(self)
+ self.bm = BabelManager(self)
+ self.openapi_manager = OpenApiManager(self)
+ self.menuapi_manager = MenuApiManager(self)
+ self._add_global_static()
+ self._add_global_filters()
+ app.before_request(self.sm.before_request)
+ self._add_admin_views()
+ self._add_addon_views()
+ if self.app:
+ self._add_menu_permissions()
+ else:
+ self.post_init()
+ self._init_extension(app)
+
+ def _init_extension(self, app):
+ app.appbuilder = self
+ if not hasattr(app, "extensions"):
+ app.extensions = {}
+ app.extensions["appbuilder"] = self
+
+ def post_init(self):
+ for baseview in self.baseviews:
+ # instantiate the views and add session
+ self._check_and_init(baseview)
+ # Register the views has blueprints
+ if baseview.__class__.__name__ not in self.get_app.blueprints.keys():
+ self.register_blueprint(baseview)
+ # Add missing permissions where needed
+ self.add_permissions()
+
+ @property
+ def get_app(self):
+ """
+ Get current or configured flask app
+ :return: Flask App
+ """
+ if self.app:
+ return self.app
+ else:
+ return current_app
+
+ @property
+ def get_session(self):
+ """
+ Get the current sqlalchemy session.
+ :return: SQLAlchemy Session
+ """
+ return self.session
+
+ @property
+ def app_name(self):
+ """
+ Get the App name
+ :return: String with app name
+ """
+ return self.get_app.config["APP_NAME"]
+
+ @property
+ def app_theme(self):
+ """
+ Get the App theme name
+ :return: String app theme name
+ """
+ return self.get_app.config["APP_THEME"]
+
+ @property
+ def app_icon(self):
+ """
+ Get the App icon location
+ :return: String with relative app icon location
+ """
+ return self.get_app.config["APP_ICON"]
+
+ @property
+ def languages(self):
+ return self.get_app.config["LANGUAGES"]
+
+ @property
+ def version(self):
+ """
+ Get the current F.A.B. version
+ :return: String with the current F.A.B. version
+ """
+ return __version__
+
+ def _add_global_filters(self):
+ self.template_filters = TemplateFilters(self.get_app, self.sm)
+
+ def _add_global_static(self):
+ bp = Blueprint(
+ "appbuilder",
+ 'flask_appbuilder.base',
+ url_prefix="/static",
+ template_folder="templates",
+ static_folder=self.static_folder,
+ static_url_path=self.static_url_path,
+ )
+ self.get_app.register_blueprint(bp)
+
+ def _add_admin_views(self):
+ """
+ Registers indexview, utilview (back function), babel views and Security views.
+ """
+ self.indexview = self._check_and_init(self.indexview)
+ self.add_view_no_menu(self.indexview)
+ self.add_view_no_menu(UtilView())
+ self.bm.register_views()
+ self.sm.register_views()
+ self.openapi_manager.register_views()
+ self.menuapi_manager.register_views()
+
+ def _add_addon_views(self):
+ """
+ Registers declared addon's
+ """
Review comment:
```suggestion
"""Register declared addons."""
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #19667:
URL: https://github.com/apache/airflow/pull/19667#issuecomment-972512130
The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] jhtimmins merged pull request #19667: Add FAB base class and set import_name explicitly.
Posted by GitBox <gi...@apache.org>.
jhtimmins merged pull request #19667:
URL: https://github.com/apache/airflow/pull/19667
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org