vincbeck commented on code in PR #44464: URL: https://github.com/apache/airflow/pull/44464#discussion_r1868339019
########## providers/src/airflow/providers/fab/www/extensions/init_appbuilder.py: ########## @@ -0,0 +1,580 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +# mypy: disable-error-code=var-annotated +from __future__ import annotations + +import logging +from functools import reduce +from typing import TYPE_CHECKING + +from flask import Blueprint, current_app, url_for +from flask_appbuilder import __version__ +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 +from flask_appbuilder.views import IndexView + +from airflow import settings +from airflow.configuration import conf +from airflow.www.extensions.init_auth_manager import init_auth_manager + +if TYPE_CHECKING: + from flask import Flask + from flask_appbuilder import BaseView + from flask_appbuilder.security.manager import BaseSecurityManager + from sqlalchemy.orm import Session + + +# 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 +# This module contains code imported from FlaskAppbuilder, so lets use _its_ logger name +log = logging.getLogger("flask_appbuilder.base") + + +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, class_path, e) + + +class AirflowAppBuilder: + """ + This is the base class for all the framework. + + This is where 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) + You can also create everything as an application factory. + """ + + baseviews: list[BaseView | Session] = [] + # Flask app + app = None + # Database Session + session = None + # Security Manager Class + sm: BaseSecurityManager + # Babel Manager Class + bm = None + # dict with addon name has key and instantiated class has value + addon_managers: dict + # temporary list that hold addon_managers config key + _addon_managers: list + + menu = None + indexview = None + + static_folder = None + static_url_path = None + + template_filters = None + + def __init__( + self, + app=None, + session: Session | None = None, + menu=None, + indexview=None, + base_template="airflow/main.html", + static_folder="static/appbuilder", + static_url_path="/appbuilder", + ): + """ + App-builder constructor. + + :param app: + The flask app object + :param session: + The SQLAlchemy session object + :param menu: + optional, a previous constructed 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 + """ + from airflow.providers_manager import ProvidersManager + + providers_manager = ProvidersManager() + providers_manager.initialize_providers_configuration() + self.baseviews = [] + self._addon_managers = [] + self.addon_managers = {} + self.menu = menu + self.base_template = base_template + self.indexview = indexview + self.static_folder = static_folder + self.static_url_path = static_url_path + self.app = app + self.update_perms = conf.getboolean("fab", "UPDATE_FAB_PERMS") + self.auth_rate_limited = conf.getboolean("fab", "AUTH_RATE_LIMITED") + self.auth_rate_limit = conf.get("fab", "AUTH_RATE_LIMIT") + 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("RATELIMIT_ENABLED", self.auth_rate_limited) + 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) + app.config.setdefault("AUTH_RATE_LIMITED", self.auth_rate_limited) + app.config.setdefault("AUTH_RATE_LIMIT", self.auth_rate_limit) + + 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() + + self._addon_managers = app.config["ADDON_MANAGERS"] + self.session = session + auth_manager = init_auth_manager(self) + self.sm = auth_manager.security_manager + self.bm = BabelManager(self) + self._add_global_static() + self._add_global_filters() + app.before_request(self.sm.before_request) + self._add_admin_views() + self._add_addon_views() + self._init_extension(app) + + def _init_extension(self, app): + app.appbuilder = self + if not hasattr(app, "extensions"): + app.extensions = {} + app.extensions["appbuilder"] = self + + @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): + """Register indexview, utilview (back function), babel views and Security views.""" + self.indexview = self._check_and_init(self.indexview) + self.add_view_no_menu(self.indexview) + + def _add_addon_views(self): + """Register declared addons.""" + 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, addon) + except Exception as e: + log.exception(e) + log.error(LOGMSG_ERR_FAB_ADDON_PROCESS, addon, e) + + def _check_and_init(self, baseview): + if hasattr(baseview, "datamodel"): + baseview.datamodel.session = self.session + if callable(baseview): + 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 accessible as a top menu. + :param category_icon: + Font-Awesome icon name for the category, optional. + :param category_label: + The label that will be displayed on the menu, + if absent param name will be used + :param menu_cond: + If a callable, :code:`menu_cond` will be invoked when + constructing the menu items. If it returns :code:`True`, + then this link will be a part of the menu. Otherwise, it + will not be included in the menu items. Defaults to + :code:`None`, meaning the item will always be present. + + Examples:: + + appbuilder = AppBuilder(app, db) + # Register a view, rendering a top menu without icon. + appbuilder.add_view(MyModelView(), "My View") + # or not instantiated + appbuilder.add_view(MyModelView, "My View") + # Register a view, a submenu "Other View" from "Other" with a phone icon. + appbuilder.add_view(MyOtherModelView, "Other View", icon="fa-phone", category="Others") + # Register a view, with category icon and translation. + appbuilder.add_view( + YetOtherModelView, + "Other View", + icon="fa-phone", + label=_("Other View"), + category="Others", + category_icon="fa-envelop", + category_label=_("Other View"), + ) + # Register a view whose menu item will be conditionally displayed + appbuilder.add_view( + YourFeatureView, + "Your Feature", + icon="fa-feature", + label=_("Your Feature"), + menu_cond=lambda: is_feature_enabled("your-feature"), + ) + # Add a link + appbuilder.add_link("google", href="www.google.com", icon="fa-google-plus") + """ + baseview = self._check_and_init(baseview) + log.info(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, name) + + if not self._view_exists(baseview): + baseview.appbuilder = self + self.baseviews.append(baseview) + self._process_inner_views() + if self.app: + self.register_blueprint(baseview) + self._add_permission(baseview) + self.add_limits(baseview) + self.add_link( + name=name, + href=href, + icon=icon, + label=label, + category=category, + category_icon=category_icon, + category_label=category_label, + baseview=baseview, + cond=menu_cond, + ) + return baseview + + def add_link( + self, + name, + href, + icon="", + label="", + category="", + category_icon="", + category_label="", + baseview=None, + cond=None, + ): + """ + Add your own links to menu using this method. + + :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 + :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 accessible as a top menu. + :param category_icon: + Font-Awesome icon name for the category, optional. + :param category_label: + The label that will be displayed on the menu, + if absent param name will be used + :param baseview: + A BaseView type class instantiated. + :param cond: + If a callable, :code:`cond` will be invoked when + constructing the menu items. If it returns :code:`True`, + then this link will be a part of the menu. Otherwise, it + will not be included in the menu items. Defaults to + :code:`None`, meaning the item will always be present. + """ + self.menu.add_link( + name=name, + href=href, + icon=icon, + label=label, + category=category, + category_icon=category_icon, + category_label=category_label, + baseview=baseview, + cond=cond, + ) + if self.app: + self._add_permissions_menu(name) + if category: + self._add_permissions_menu(category) + + def add_separator(self, category, cond=None): + """ + Add a separator to the menu, you will sequentially create the menu. + + :param category: + The menu category where the separator will be included. + :param cond: + If a callable, :code:`cond` will be invoked when + constructing the menu items. If it returns :code:`True`, + then this separator will be a part of the menu. Otherwise, + it will not be included in the menu items. Defaults to + :code:`None`, meaning the separator will always be present. + """ + self.menu.add_separator(category, cond=cond) + + def add_view_no_menu(self, baseview, endpoint=None, static_folder=None): + """ + Add your views without creating a menu. + + :param baseview: A BaseView type class instantiated. + """ + baseview = self._check_and_init(baseview) + log.info(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, "") + + if not self._view_exists(baseview): + baseview.appbuilder = self + self.baseviews.append(baseview) + self._process_inner_views() + if self.app: + self.register_blueprint(baseview, endpoint=endpoint, static_folder=static_folder) + self._add_permission(baseview) + else: + log.warning(LOGMSG_WAR_FAB_VIEW_EXISTS, baseview.__class__.__name__) + return baseview + + @property + def get_url_for_index(self): + # TODO: Return the fast api application homepage Review Comment: TODO: Return the fast api application homepage. When the user click on the Airflow logo on the top left, it should go back to Airflow 3 home page -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
