Switch to hooks for linting

Author: Dev-iL

.github/workflows/ci.yml

@@ -10,32 +10,17 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        python-version: ["3.10"]
     steps:
       - name: Checkout code
         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/dev.txt
-      - name: black
-        run: black --check flask_appbuilder
-      - name: flake8
-        run: flake8 flask_appbuilder
-      - name: mypy
-        run: mypy flask_appbuilder/**/*.py
-      - name: black
-        run: black --check tests
-      - name: flake8
-        run: flake8 tests
+          python-version: "3.10"
+      - name: Install prek
+        run: pip install prek
+      - name: Run linters
+        run: prek run --all-files
 
   test-postgres:
     runs-on: ubuntu-22.04

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.7
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-PyYAML]
+        args: [--ignore-missing-imports]
+        pass_filenames: false
+        entry: mypy flask_appbuilder

flask_appbuilder/_compat.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 """
-    Some py2/py3 compatibility support based on a stripped down
-    version of six so we don't have to depend on a specific version
-    of it.
+Some py2/py3 compatibility support based on a stripped down
+version of six so we don't have to depend on a specific version
+of it.
 
-    :copyright: (c) 2013 by Armin Ronacher.
-    :license: BSD, see LICENSE for more details.
+:copyright: (c) 2013 by Armin Ronacher.
+:license: BSD, see LICENSE for more details.
 """
+
 import sys
 
 PY2 = sys.version_info[0] == 2

flask_appbuilder/api/__init__.py

@@ -6,6 +6,7 @@
 import re
 import traceback
 from typing import (
+    TYPE_CHECKING,
     Any,
     Callable,
     Dict,
@@ -14,14 +15,13 @@
     Set,
     Tuple,
     Type,
-    TYPE_CHECKING,
     Union,
 )
 import urllib.parse
 
 from apispec import APISpec, yaml_utils
 from apispec.exceptions import DuplicateComponentNameError
-from flask import Blueprint, current_app, jsonify, make_response, request, Response
+from flask import Blueprint, Response, current_app, jsonify, make_response, request
 from flask_appbuilder._compat import as_unicode
 from flask_appbuilder.api.convert import Model2SchemaConverter
 from flask_appbuilder.api.schemas import (
@@ -507,9 +507,7 @@ def __init__(self) -> None:
         # Init class permission override attrs
         if not self.previous_class_permission_name and self.class_permission_name:
             self.previous_class_permission_name = self.__class__.__name__
-        self.class_permission_name = (
-            self.class_permission_name or self.__class__.__name__
-        )
+        self.class_permission_name = self.class_permission_name or self.__class__.__name__
 
         # Init previous permission override attrs
         is_collect_previous = False
@@ -1244,9 +1242,8 @@ def _init_properties(self) -> None:
             ]
         self.list_select_columns = self.list_select_columns or self.list_columns
 
-        self.order_columns = (
-            self.order_columns
-            or self.datamodel.get_order_columns_list(list_columns=self.list_columns)
+        self.order_columns = self.order_columns or self.datamodel.get_order_columns_list(
+            list_columns=self.list_columns
         )
         # Process excluded columns
         if not self.show_columns:
@@ -1256,9 +1253,7 @@ def _init_properties(self) -> None:
         self.show_select_columns = self.show_select_columns or self.show_columns
 
         if not self.add_columns:
-            self.add_columns = [
-                x for x in list_cols if x not in self.add_exclude_columns
-            ]
+            self.add_columns = [x for x in list_cols if x not in self.add_exclude_columns]
         if not self.edit_columns:
             self.edit_columns = [
                 x for x in list_cols if x not in self.edit_exclude_columns
@@ -1345,9 +1340,7 @@ def merge_show_columns(self, response: Dict[str, Any], **kwargs: Any) -> None:
         else:
             response[API_SHOW_COLUMNS_RES_KEY] = self.show_columns
 
-    def merge_description_columns(
-        self, response: Dict[str, Any], **kwargs: Any
-    ) -> None:
+    def merge_description_columns(self, response: Dict[str, Any], **kwargs: Any) -> None:
         pruned_select_cols = kwargs.get(API_SELECT_COLUMNS_RIS_KEY, [])
         if pruned_select_cols:
             response[API_DESCRIPTION_COLUMNS_RES_KEY] = self._description_columns_json(
@@ -1397,9 +1390,7 @@ def info_headless(self, **kwargs: Any) -> Response:
     @safe
     @rison(get_info_schema)
     @permission_name("info")
-    @merge_response_func(
-        BaseApi.merge_current_user_permissions, API_PERMISSIONS_RIS_KEY
-    )
+    @merge_response_func(BaseApi.merge_current_user_permissions, API_PERMISSIONS_RIS_KEY)
     @merge_response_func(merge_add_field_info, API_ADD_COLUMNS_RIS_KEY)
     @merge_response_func(merge_edit_field_info, API_EDIT_COLUMNS_RIS_KEY)
     @merge_response_func(merge_search_filters, API_FILTERS_RIS_KEY)
@@ -1998,9 +1989,7 @@ def _handle_columns_args(
         select_columns_arg = args.get(API_SELECT_SEL_COLUMNS_RIS_KEY, [])
         response_columns_arg = args.get(API_SELECT_COLUMNS_RIS_KEY, [])
         if select_columns_arg and response_columns_arg:
-            raise InvalidColumnArgsFABException(
-                "Cannot use both select and sel columns"
-            )
+            raise InvalidColumnArgsFABException("Cannot use both select and sel columns")
         select_columns = default_select_columns
         response_columns = []
         if select_columns_arg:

flask_appbuilder/api/convert.py

@@ -3,10 +3,9 @@
 from flask import current_app
 from flask_appbuilder.models.sqla import Model
 from flask_appbuilder.models.sqla.interface import SQLAInterface
-from marshmallow import fields, Schema
+from marshmallow import Schema, fields
 from marshmallow.fields import Field
-from marshmallow_sqlalchemy import field_for
-from marshmallow_sqlalchemy import SQLAlchemyAutoSchema
+from marshmallow_sqlalchemy import SQLAlchemyAutoSchema, field_for
 
 
 class TreeNode:

flask_appbuilder/api/manager.py

@@ -2,8 +2,7 @@
 from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec.ext.marshmallow.common import resolve_schema_cls
 from flask import current_app, request
-from flask_appbuilder.api import BaseApi
-from flask_appbuilder.api import expose, protect, safe
+from flask_appbuilder.api import BaseApi, expose, protect, safe
 from flask_appbuilder.basemanager import BaseManager
 from flask_appbuilder.baseviews import BaseView
 from flask_appbuilder.security.decorators import has_access

flask_appbuilder/api/schemas.py

@@ -1,4 +1,4 @@
-from marshmallow import post_load, Schema
+from marshmallow import Schema, post_load
 
 from ..const import (
     API_ADD_COLUMNS_RIS_KEY,

flask_appbuilder/babel/manager.py

@@ -18,9 +18,7 @@ def __init__(self, appbuilder):
         appbuilder_parent_dir = os.path.join(
             os.path.dirname(os.path.abspath(__file__)), os.pardir
         )
-        appbuilder_translations_path = os.path.join(
-            appbuilder_parent_dir, "translations"
-        )
+        appbuilder_translations_path = os.path.join(appbuilder_parent_dir, "translations")
         if "BABEL_TRANSLATION_DIRECTORIES" in current_app.config:
             current_translation_directories = current_app.config.get(
                 "BABEL_TRANSLATION_DIRECTORIES"

flask_appbuilder/base.py

@@ -2,9 +2,9 @@
 
 from functools import reduce
 import logging
-from typing import Any, Callable, cast, Dict, List, Optional, Type, TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Type, Union, cast
 
-from flask import Blueprint, current_app, Flask, url_for
+from flask import Blueprint, Flask, current_app, url_for
 from flask_appbuilder import __version__
 from flask_appbuilder.api.manager import OpenApiManager
 from flask_appbuilder.babel.manager import BabelManager
@@ -24,7 +24,7 @@
 
 if TYPE_CHECKING:
     from flask_appbuilder.basemanager import BaseManager
-    from flask_appbuilder.baseviews import BaseView, AbstractViewApi
+    from flask_appbuilder.baseviews import AbstractViewApi, BaseView
     from flask_appbuilder.security.manager import BaseSecurityManager
 
 log = logging.getLogger(__name__)
@@ -163,9 +163,7 @@ def init_app(self, app: Flask, session: SessionBase) -> None:
         self._session = session
         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
-        )
+        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:
             self.indexview = dynamic_class_import(_index_view)  # type: ignore
@@ -184,9 +182,7 @@ def init_app(self, app: Flask, session: SessionBase) -> None:
 
         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
-        )
+        _security_manager_class_name = app.config.get("FAB_SECURITY_MANAGER_CLASS", None)
         if _security_manager_class_name is not None:
             security_manager_class = dynamic_class_import(_security_manager_class_name)
             self.security_manager_class = cast(
@@ -612,9 +608,7 @@ def get_url_for_logout(self) -> str:
     def get_url_for_index(self) -> str:
         if self._indexview is None:
             return ""
-        return url_for(
-            "%s.%s" % (self._indexview.endpoint, self._indexview.default_view)
-        )
+        return url_for("%s.%s" % (self._indexview.endpoint, self._indexview.default_view))
 
     @property
     def get_url_for_userinfo(self) -> str:

flask_appbuilder/baseviews.py

@@ -3,11 +3,11 @@
 import json
 import logging
 import re
-from typing import List, Optional, TYPE_CHECKING
+from typing import TYPE_CHECKING, List, Optional
 
 from flask import (
-    abort,
     Blueprint,
+    abort,
     current_app,
     flash,
     render_template,
@@ -24,11 +24,11 @@
     wrap_route_handler_with_hooks,
 )
 from flask_appbuilder.urltools import (
+    Stack,
     get_filter_args,
     get_order_args,
     get_page_args,
     get_page_size_args,
-    Stack,
 )
 from flask_appbuilder.widgets import FormWidget, ListWidget, SearchWidget, ShowWidget
 from flask_babel import lazy_gettext
@@ -85,8 +85,7 @@ def create_blueprint(
         appbuilder: "AppBuilder",
         endpoint: Optional[str] = None,
         static_folder: Optional[str] = None,
-    ):
-        ...
+    ): ...
 
     def get_uninit_inner_views(self):
         """
@@ -209,9 +208,7 @@ def __init__(self):
         # Init class permission override attrs
         if not self.previous_class_permission_name and self.class_permission_name:
             self.previous_class_permission_name = self.__class__.__name__
-        self.class_permission_name = (
-            self.class_permission_name or self.__class__.__name__
-        )
+        self.class_permission_name = self.class_permission_name or self.__class__.__name__
 
         # Init previous permission override attrs
         is_collect_previous = False
@@ -890,8 +887,8 @@ def __init__(self, **kwargs):
                 if self.method_permission_name.get(attr_name):
                     if not self.previous_method_permission_name.get(attr_name):
                         self.previous_method_permission_name[attr_name] = action.name
-                    permission_name = (
-                        PERMISSION_PREFIX + self.method_permission_name.get(attr_name)
+                    permission_name = PERMISSION_PREFIX + self.method_permission_name.get(
+                        attr_name
                     )
                 if permission_name not in self.base_permissions:
                     self.base_permissions.append(permission_name)
@@ -958,9 +955,8 @@ def _init_properties(self):
         list_cols = self.datamodel.get_user_columns_list()
         self.list_columns = self.list_columns or [list_cols[0]]
         self._gen_labels_columns(self.list_columns)
-        self.order_columns = (
-            self.order_columns
-            or self.datamodel.get_order_columns_list(list_columns=self.list_columns)
+        self.order_columns = self.order_columns or self.datamodel.get_order_columns_list(
+            list_columns=self.list_columns
         )
         if self.show_fieldsets:
             self.show_columns = []
@@ -976,9 +972,7 @@ def _init_properties(self):
         if self.add_fieldsets:
             self.add_columns = []
             for fieldset_item in self.add_fieldsets:
-                self.add_columns = self.add_columns + list(
-                    fieldset_item[1].get("fields")
-                )
+                self.add_columns = self.add_columns + list(fieldset_item[1].get("fields"))
         else:
             if not self.add_columns:
                 self.add_columns = [
@@ -1123,9 +1117,7 @@ def _get_list_widget(
         )
         return widgets
 
-    def _get_show_widget(
-        self, pk, item, widgets=None, actions=None, show_fieldsets=None
-    ):
+    def _get_show_widget(self, pk, item, widgets=None, actions=None, show_fieldsets=None):
         widgets = widgets or {}
         actions = actions or self.actions
         show_fieldsets = show_fieldsets or self.show_fieldsets
@@ -1188,9 +1180,7 @@ def _list(self, **kwargs):
         returns list and search widget
         """
         if get_order_args().get(self.__class__.__name__):
-            order_column, order_direction = get_order_args().get(
-                self.__class__.__name__
-            )
+            order_column, order_direction = get_order_args().get(self.__class__.__name__)
         else:
             order_column, order_direction = "", ""
         page = get_page_args().get(self.__class__.__name__)