apache-airflow-providers-fab 3.1.0rc1__py3-none-any.whl → 3.2.0rc1__py3-none-any.whl

airflow/providers/fab/{auth_manager/cli_commands → cli}/definition.py

@@ -17,6 +17,7 @@
 from __future__ import annotations
 
 import textwrap
+from typing import TYPE_CHECKING
 
 from airflow.cli.cli_config import (
     ARG_DB_FROM_REVISION,
@@ -35,6 +36,9 @@ from airflow.cli.cli_config import (
     lazy_load_command,
 )
 
+if TYPE_CHECKING:
+    import argparse
+
 ############
 # # ARGS # #
 ############
@@ -143,7 +147,7 @@ USERS_COMMANDS = (
         ),
         epilog=(
             "examples:\n"
-            'To create an user with "Admin" role and username equals to "admin", run:\n'
+            'To create a user with "Admin" role and username equals to "admin", run:\n'
             "\n"
             "    $ airflow users create \\\n"
             "          --username admin \\\n"
@@ -168,7 +172,7 @@ USERS_COMMANDS = (
         ),
         epilog=(
             "examples:\n"
-            'To reset an user with username equals to "admin", run:\n'
+            'To reset a user with username equals to "admin", run:\n'
             "\n"
             "    $ airflow users reset-password \\\n"
             "          --username admin"
@@ -336,3 +340,47 @@ DB_COMMANDS = (
         args=(ARG_YES, ARG_DB_SKIP_INIT, ARG_VERBOSE),
     ),
 )
+
+
+def get_fab_cli_commands():
+    """Return CLI commands for FAB auth manager."""
+    import packaging.version
+
+    from airflow import __version__ as airflow_version
+    from airflow.cli.cli_config import GroupCommand
+
+    commands = [
+        GroupCommand(
+            name="users",
+            help="Manage users",
+            subcommands=USERS_COMMANDS,
+        ),
+        GroupCommand(
+            name="roles",
+            help="Manage roles",
+            subcommands=ROLES_COMMANDS,
+        ),
+        SYNC_PERM_COMMAND,  # not in a command group
+        PERMISSIONS_CLEANUP_COMMAND,  # single command for permissions cleanup
+    ]
+    # If Airflow version is 3.0.0 or higher, add the fab-db command group
+    if packaging.version.parse(
+        packaging.version.parse(airflow_version).base_version
+    ) >= packaging.version.parse("3.0.0"):
+        commands.append(GroupCommand(name="fab-db", help="Manage FAB", subcommands=DB_COMMANDS))
+    return commands
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """
+    Generate documentation; used by Sphinx argparse.
+
+    :meta private:
+    """
+    from airflow.cli.cli_parser import AirflowHelpFormatter, DefaultHelpParser, _add_command
+
+    parser = DefaultHelpParser(prog="airflow", formatter_class=AirflowHelpFormatter)
+    subparsers = parser.add_subparsers(dest="subcommand", metavar="GROUP_OR_COMMAND")
+    for group_command in get_fab_cli_commands():
+        _add_command(subparsers, group_command)
+    return parser

airflow/providers/fab/get_provider_info.py

@@ -177,8 +177,16 @@ def get_provider_info():
                         "example": None,
                         "default": "1",
                     },
+                    "cache_ttl": {
+                        "description": "Number of seconds after which the user cache will expire to refetch updated user and\npermissions.\n",
+                        "version_added": "3.2.0",
+                        "type": "integer",
+                        "example": None,
+                        "default": "30",
+                    },
                 },
             }
         },
         "auth-managers": ["airflow.providers.fab.auth_manager.fab_auth_manager.FabAuthManager"],
+        "cli": ["airflow.providers.fab.cli.definition.get_fab_cli_commands"],
     }

airflow/providers/fab/version_compat.py

@@ -34,3 +34,4 @@ def get_base_airflow_version_tuple() -> tuple[int, int, int]:
 
 AIRFLOW_V_3_1_PLUS = get_base_airflow_version_tuple() >= (3, 1, 0)
 AIRFLOW_V_3_1_1_PLUS = get_base_airflow_version_tuple() >= (3, 1, 1)
+AIRFLOW_V_3_2_PLUS = get_base_airflow_version_tuple() >= (3, 2, 0)

airflow/providers/fab/www/app.py

@@ -31,7 +31,7 @@ from airflow.api_fastapi.app import get_auth_manager
 from airflow.configuration import conf
 from airflow.exceptions import AirflowConfigException
 from airflow.logging_config import configure_logging
-from airflow.providers.fab.www.extensions.init_appbuilder import AirflowAppBuilder
+from airflow.providers.fab.www.extensions.init_appbuilder import init_appbuilder
 from airflow.providers.fab.www.extensions.init_jinja_globals import init_jinja_globals
 from airflow.providers.fab.www.extensions.init_manifest_files import configure_manifest_files
 from airflow.providers.fab.www.extensions.init_security import init_api_auth
@@ -93,12 +93,7 @@ def create_app(enable_plugins: bool):
     init_api_auth(flask_app)
 
     with flask_app.app_context():
-        AirflowAppBuilder(
-            app=flask_app,
-            session=db.session(),
-            base_template="airflow/main.html",
-            enable_plugins=enable_plugins,
-        )
+        init_appbuilder(flask_app, enable_plugins=enable_plugins)
         init_error_handlers(flask_app)
         # In two scenarios a Flask application can be created:
         # - To support Airflow 2 plugins relying on Flask (``enable_plugins`` is True)

airflow/providers/fab/www/extensions/init_appbuilder.py

@@ -49,6 +49,7 @@ if TYPE_CHECKING:
     from flask_appbuilder import BaseView
     from flask_appbuilder.security.manager import BaseSecurityManager
     from sqlalchemy.orm import Session
+    from sqlalchemy.orm.scoping import scoped_session
 
 
 # This product contains a modified portion of 'Flask App Builder' developed by Daniel Vaz Gaspar.
@@ -102,7 +103,7 @@ class AirflowAppBuilder:
     def __init__(
         self,
         app=None,
-        session: Session | None = None,
+        session: scoped_session | None = None,
         menu=None,
         indexview=None,
         base_template="airflow/main.html",
@@ -597,7 +598,7 @@ def init_appbuilder(app: Flask, enable_plugins: bool) -> AirflowAppBuilder:
         raise RuntimeError("Session not configured. Call configure_orm() first.")
     return AirflowAppBuilder(
         app=app,
-        session=settings.Session(),
+        session=settings.Session,
         base_template="airflow/main.html",
         enable_plugins=enable_plugins,
     )

airflow/providers/fab/www/extensions/init_views.py

@@ -26,7 +26,7 @@ from connexion.exceptions import BadRequestProblem, ProblemException
 from flask import request
 
 from airflow.api_fastapi.app import get_auth_manager
-from airflow.providers.fab.version_compat import AIRFLOW_V_3_1_PLUS
+from airflow.providers.fab.version_compat import AIRFLOW_V_3_1_PLUS, AIRFLOW_V_3_2_PLUS
 from airflow.providers.fab.www.api_connexion.exceptions import common_error_handler
 
 if TYPE_CHECKING:
@@ -102,11 +102,17 @@ def init_plugins(app):
     """Integrate Flask and FAB with plugins."""
     from airflow import plugins_manager
 
-    plugins_manager.initialize_flask_plugins()
+    if AIRFLOW_V_3_2_PLUS:
+        blueprints, appbuilder_views, appbuilder_menu_links = plugins_manager.get_flask_plugins()
+    else:
+        plugins_manager.initialize_flask_plugins()  # type: ignore
+        blueprints = plugins_manager.flask_blueprints  # type: ignore
+        appbuilder_views = plugins_manager.flask_appbuilder_views  # type: ignore
+        appbuilder_menu_links = plugins_manager.flask_appbuilder_menu_links  # type: ignore
 
     appbuilder = app.appbuilder
 
-    for view in plugins_manager.flask_appbuilder_views:
+    for view in appbuilder_views:
         name = view.get("name")
         if name:
             filtered_view_kwargs = {k: v for k, v in view.items() if k not in ["view"]}
@@ -124,13 +130,11 @@ def init_plugins(app):
     # Since Airflow 3.1 flask_appbuilder_menu_links are added to the Airflow 3 UI
     # navbar..
     if not AIRFLOW_V_3_1_PLUS:
-        for menu_link in sorted(
-            plugins_manager.flask_appbuilder_menu_links, key=lambda x: (x.get("category", ""), x["name"])
-        ):
+        for menu_link in sorted(appbuilder_menu_links, key=lambda x: (x.get("category", ""), x["name"])):
             log.debug("Adding menu link %s to %s", menu_link["name"], menu_link["href"])
             appbuilder.add_link(**menu_link)
 
-    for blue_print in plugins_manager.flask_blueprints:
+    for blue_print in blueprints:
         log.debug("Adding blueprint %s:%s", blue_print["name"], blue_print["blueprint"].import_name)
         app.register_blueprint(blue_print["blueprint"])