flask-appbuilder 3.2.1rc1__py3-none-any.whl → 5.0.2rc1__py3-none-any.whl

flask_appbuilder/charts/jsontools.py

@@ -5,17 +5,17 @@ from flask_appbuilder._compat import as_unicode
 
 def dict_to_json(xcol, ycols, labels, value_columns):  # pragma: no cover
     """
-        Converts a list of dicts from datamodel query results
-        to google chart json data.
+    Converts a list of dicts from datamodel query results
+    to google chart json data.
 
-        :param xcol:
-            The name of a string column to be used has X axis on chart
-        :param ycols:
-            A list with the names of series cols, that can be used as numeric
-        :param labels:
-            A dict with the columns labels.
-        :param value_columns:
-            A list of dicts with the values to convert
+    :param xcol:
+        The name of a string column to be used has X axis on chart
+    :param ycols:
+        A list with the names of series cols, that can be used as numeric
+    :param labels:
+        A dict with the columns labels.
+    :param value_columns:
+        A list of dicts with the values to convert
     """
     json_data = dict()
 

flask_appbuilder/charts/views.py

@@ -15,10 +15,10 @@ log = logging.getLogger(__name__)
 
 class BaseChartView(BaseModelView):
     """
-        This is the base class for all chart views.
-        Use DirectByChartView or GroupByChartView, override their properties
-         and their base classes
-        (BaseView, BaseModelView, BaseChartView) to customise your charts
+    This is the base class for all chart views.
+    Use DirectByChartView or GroupByChartView, override their properties
+     and their base classes
+    (BaseView, BaseModelView, BaseChartView) to customise your charts
     """
 
     chart_template = "appbuilder/general/charts/chart.html"
@@ -60,8 +60,8 @@ class BaseChartView(BaseModelView):
 
     def _get_view_widget(self, **kwargs):
         """
-            :return:
-                Returns a widget
+        :return:
+            Returns a widget
         """
         return self._get_chart_widget(**kwargs).get("chart")
 
@@ -139,7 +139,7 @@ class GroupByChartView(BaseChartView):
 
     def get_group_by_class(self, definition):
         """
-            intantiates the processing class (Direct or Grouped) and returns it.
+        intantiates the processing class (Direct or Grouped) and returns it.
         """
         group_by = definition["group"]
         series = definition["series"]
@@ -160,7 +160,6 @@ class GroupByChartView(BaseChartView):
         definition="",
         **args
     ):
-
         height = height or self.height
         widgets = widgets or dict()
         joined_filters = filters.get_joined_filters(self._base_filters)
@@ -221,45 +220,45 @@ class GroupByChartView(BaseChartView):
 
 class DirectByChartView(GroupByChartView):
     """
-        Use this class to display charts with multiple series,
-        based on columns or methods defined on models.
-        You can display multiple charts on the same view.
+    Use this class to display charts with multiple series,
+    based on columns or methods defined on models.
+    You can display multiple charts on the same view.
 
-        Default routing point is '/chart'
+    Default routing point is '/chart'
 
-        Setup definitions property to configure the chart
+    Setup definitions property to configure the chart
 
-        :label: (optional) String label to display on chart selection.
-        :group: String with the column name or method from model.
-        :formatter: (optional) function that formats the output of 'group' key
-        :series: A list of tuples with the aggregation function and the column name
-                to apply the aggregation
+    :label: (optional) String label to display on chart selection.
+    :group: String with the column name or method from model.
+    :formatter: (optional) function that formats the output of 'group' key
+    :series: A list of tuples with the aggregation function and the column name
+            to apply the aggregation
 
-        The **definitions** property respects the following grammar::
+    The **definitions** property respects the following grammar::
 
-            definitions = [
-                    {
-                     'label': 'label for chart definition',
-                     'group': '<COLNAME>'|'<MODEL FUNCNAME>',
-                     'formatter': <FUNC FORMATTER FOR GROUP COL>,
-                     'series': ['<COLNAME>'|'<MODEL FUNCNAME>',...]
-                    }, ...
-                  ]
+        definitions = [
+                {
+                 'label': 'label for chart definition',
+                 'group': '<COLNAME>'|'<MODEL FUNCNAME>',
+                 'formatter': <FUNC FORMATTER FOR GROUP COL>,
+                 'series': ['<COLNAME>'|'<MODEL FUNCNAME>',...]
+                }, ...
+              ]
 
-        example::
+    example::
 
-            class CountryDirectChartView(DirectByChartView):
-                datamodel = SQLAInterface(CountryStats)
-                chart_title = 'Direct Data Example'
+        class CountryDirectChartView(DirectByChartView):
+            datamodel = SQLAInterface(CountryStats)
+            chart_title = 'Direct Data Example'
 
-                definitions = [
-                    {
-                        'label': 'Unemployment',
-                        'group': 'stat_date',
-                        'series': ['unemployed_perc',
-                            'college_perc']
-                    }
-                ]
+            definitions = [
+                {
+                    'label': 'Unemployment',
+                    'group': 'stat_date',
+                    'series': ['unemployed_perc',
+                        'college_perc']
+                }
+            ]
 
     """
 
@@ -293,7 +292,6 @@ class BaseSimpleGroupByChartView(BaseChartView):  # pragma: no cover
         height=None,
         **args
     ):
-
         height = height or self.height
         widgets = widgets or dict()
         group_by = group_by or self.group_by_columns[0]
@@ -333,8 +331,8 @@ class BaseSimpleDirectChartView(BaseChartView):  # pragma: no cover
 
     def get_group_by_columns(self):
         """
-            returns the keys from direct_columns
-            Used in template, so that user can choose from options
+        returns the keys from direct_columns
+        Used in template, so that user can choose from options
         """
         return list(self.direct_columns.keys())
 
@@ -348,7 +346,6 @@ class BaseSimpleDirectChartView(BaseChartView):  # pragma: no cover
         height=None,
         **args
     ):
-
         height = height or self.height
         widgets = widgets or dict()
         joined_filters = filters.get_joined_filters(self._base_filters)
@@ -377,11 +374,11 @@ class BaseSimpleDirectChartView(BaseChartView):  # pragma: no cover
 
 class ChartView(BaseSimpleGroupByChartView):  # pragma: no cover
     """
-        **DEPRECATED**
+    **DEPRECATED**
 
-        Provides a simple (and hopefully nice) way to draw charts on your application.
+    Provides a simple (and hopefully nice) way to draw charts on your application.
 
-        This will show Google Charts based on group by of your tables.
+    This will show Google Charts based on group by of your tables.
     """
 
     @expose("/chart/<group_by>")
@@ -410,12 +407,12 @@ class ChartView(BaseSimpleGroupByChartView):  # pragma: no cover
 
 class TimeChartView(BaseSimpleGroupByChartView):  # pragma: no cover
     """
-        **DEPRECATED**
+    **DEPRECATED**
 
-        Provides a simple way to draw some time charts on your application.
+    Provides a simple way to draw some time charts on your application.
 
-        This will show Google Charts based on count and group
-        by month and year for your tables.
+    This will show Google Charts based on count and group
+    by month and year for your tables.
     """
 
     chart_template = "appbuilder/general/charts/chart_time.html"
@@ -432,7 +429,6 @@ class TimeChartView(BaseSimpleGroupByChartView):  # pragma: no cover
         height=None,
         **args
     ):
-
         height = height or self.height
         widgets = widgets or dict()
         group_by = group_by or self.group_by_columns[0]
@@ -487,17 +483,17 @@ class TimeChartView(BaseSimpleGroupByChartView):  # pragma: no cover
 
 class DirectChartView(BaseSimpleDirectChartView):  # pragma: no cover
     """
-        **DEPRECATED**
+    **DEPRECATED**
 
-        This class is responsible for displaying a Google chart with
-        direct model values. Chart widget uses json.
-        No group by is processed, example::
+    This class is responsible for displaying a Google chart with
+    direct model values. Chart widget uses json.
+    No group by is processed, example::
 
-            class StatsChartView(DirectChartView):
-                datamodel = SQLAInterface(Stats)
-                chart_title = lazy_gettext('Statistics')
-                direct_columns = {'Some Stats': ('X_col_1', 'stat_col_1', 'stat_col_2'),
-                                  'Other Stats': ('X_col2', 'stat_col_3')}
+        class StatsChartView(DirectChartView):
+            datamodel = SQLAInterface(Stats)
+            chart_title = lazy_gettext('Statistics')
+            direct_columns = {'Some Stats': ('X_col_1', 'stat_col_1', 'stat_col_2'),
+                              'Other Stats': ('X_col2', 'stat_col_3')}
 
     """
 

flask_appbuilder/cli.py

@@ -1,35 +1,59 @@
+from __future__ import annotations
+
 from io import BytesIO
 import os
 import shutil
+from typing import Any, Optional, Union
 from urllib.request import urlopen
 from zipfile import ZipFile
 
 import click
 from flask import current_app
 from flask.cli import with_appcontext
+import jinja2
 
-from .const import AUTH_DB, AUTH_LDAP, AUTH_OAUTH, AUTH_OID, AUTH_REMOTE_USER
+from .const import AUTH_DB, AUTH_LDAP, AUTH_OAUTH, AUTH_REMOTE_USER
 
 
 SQLA_REPO_URL = (
-    "https://github.com/dpgaspar/Flask-AppBuilder-Skeleton/archive/master.zip"
-)
-MONGOENGIE_REPO_URL = (
-    "https://github.com/dpgaspar/Flask-AppBuilder-Skeleton-me/archive/master.zip"
+    "https://github.com/dpgaspar/Flask-AppBuilder-Skeleton/archive/refs/heads/v5.zip"
 )
 ADDON_REPO_URL = (
     "https://github.com/dpgaspar/Flask-AppBuilder-Skeleton-AddOn/archive/master.zip"
 )
 
+MIN_SECRET_KEY_SIZE = 20
+
 
-def echo_header(title):
+def validate_secret_key(ctx: click.Context, param: click.Option, value: str) -> str:
+    if len(value) < MIN_SECRET_KEY_SIZE:
+        raise click.BadParameter(f"SECRET_KEY size is less then {MIN_SECRET_KEY_SIZE}")
+    return value
+
+
+def echo_header(title: str) -> None:
     click.echo(click.style(title, fg="green"))
     click.echo(click.style("-" * len(title), fg="green"))
 
 
+def cast_int_like_to_int(cli_arg: Any) -> Union[None, str, int]:
+    """Cast int-like objects to int if possible
+
+    If the arg cannot be cast to an integer, return the unmodified object instead."""
+    try:
+        cli_arg_int = int(cli_arg)
+        return cli_arg_int
+    except TypeError:
+        # Don't cast if None
+        return cli_arg
+    except ValueError:
+        # Don't cast non-int-like strings
+        return cli_arg
+
+
 @click.group()
-def fab():
-    """ FAB flask group commands"""
+def fab() -> None:
+    """FAB flask group commands"""
     pass
 
 
@@ -40,13 +64,14 @@ def fab():
 @click.option("--email", default="admin@fab.org", prompt="Email")
 @click.password_option()
 @with_appcontext
-def create_admin(username, firstname, lastname, email, password):
+def create_admin(
+    username: str, firstname: str, lastname: str, email: str, password: str
+) -> None:
     """
-        Creates an admin user
+    Creates an admin user
     """
     auth_type = {
         AUTH_DB: "Database Authentications",
-        AUTH_OID: "OpenID Authentication",
         AUTH_LDAP: "LDAP Authentication",
         AUTH_REMOTE_USER: "WebServer REMOTE_USER Authentication",
         AUTH_OAUTH: "OAuth Authentication",
@@ -76,7 +101,7 @@ def create_admin(username, firstname, lastname, email, password):
     if user:
         click.echo(click.style("Admin User {0} created.".format(username), fg="green"))
     else:
-        click.echo(click.style("No user created an error occured", fg="red"))
+        click.echo(click.style("No user created an error occurred", fg="red"))
 
 
 @fab.command("create-user")
@@ -87,9 +112,11 @@ def create_admin(username, firstname, lastname, email, password):
 @click.option("--email", prompt="Email")
 @click.password_option()
 @with_appcontext
-def create_user(role, username, firstname, lastname, email, password):
+def create_user(
+    role: str, username: str, firstname: str, lastname: str, email: str, password: str
+) -> None:
     """
-        Create a user
+    Create a user
     """
     user = current_app.appbuilder.sm.find_user(username=username)
     if user:
@@ -121,9 +148,9 @@ def create_user(role, username, firstname, lastname, email, password):
 )
 @click.password_option()
 @with_appcontext
-def reset_password(username, password):
+def reset_password(username: str, password: str) -> None:
     """
-        Resets a user's password
+    Resets a user's password
     """
     user = current_app.appbuilder.sm.find_user(username=username)
     if not user:
@@ -135,22 +162,45 @@ def reset_password(username, password):
 
 @fab.command("create-db")
 @with_appcontext
-def create_db():
+def create_db() -> None:
     """
-        Create all your database objects (SQLAlchemy specific).
+    Create all your database objects (SQLAlchemy specific).
     """
     from flask_appbuilder.models.sqla import Model
 
-    engine = current_app.appbuilder.get_session.get_bind(mapper=None, clause=None)
+    engine = current_app.appbuilder.session.get_bind(mapper=None, clause=None)
     Model.metadata.create_all(engine)
     click.echo(click.style("DB objects created", fg="green"))
 
 
+@fab.command("export-roles")
+@with_appcontext
+@click.option("--path", "-path", help="Specify filepath to export roles to")
+@click.option("--indent", help="Specify indent of generated JSON file")
+def export_roles(
+    path: Optional[str] = None, indent: Optional[Union[int, str]] = None
+) -> None:
+    """Exports roles with permissions and view menus to JSON file"""
+    # Cast negative numbers to int (as they are passed as str from CLI)
+    cast_indent = cast_int_like_to_int(indent)
+    current_app.appbuilder.sm.export_roles(path=path, indent=cast_indent)
+
+
+@fab.command("import-roles")
+@with_appcontext
+@click.option(
+    "--path", "-p", help="Path to a JSON file containing roles", required=True
+)
+def import_roles(path: str) -> None:
+    """Imports roles with permissions and view menus from JSON file"""
+    current_app.appbuilder.sm.import_roles(path)
+
+
 @fab.command("version")
 @with_appcontext
-def version():
+def version() -> None:
     """
-        Flask-AppBuilder package version
+    Flask-AppBuilder package version
     """
     click.echo(
         click.style(
@@ -163,9 +213,9 @@ def version():
 
 @fab.command("security-cleanup")
 @with_appcontext
-def security_cleanup():
+def security_cleanup() -> None:
     """
-        Cleanup unused permissions from views and roles.
+    Cleanup unused permissions from views and roles.
     """
     current_app.appbuilder.security_cleanup()
     click.echo(click.style("Finished security cleanup", fg="green"))
@@ -176,9 +226,9 @@ def security_cleanup():
     "--dry-run", "-d", is_flag=True, help="Dry run & print state transitions."
 )
 @with_appcontext
-def security_converge(dry_run=False):
+def security_converge(dry_run: bool = False) -> None:
     """
-        Converges security deletes previous_class_permission_name
+    Converges security deletes previous_class_permission_name
     """
     state_transitions = current_app.appbuilder.security_converge(dry=dry_run)
     if dry_run:
@@ -201,9 +251,9 @@ def security_converge(dry_run=False):
 
 @fab.command("create-permissions")
 @with_appcontext
-def create_permissions():
+def create_permissions() -> None:
     """
-        Creates all permissions and add them to the ADMIN Role.
+    Creates all permissions and add them to the ADMIN Role.
     """
     current_app.appbuilder.add_permissions(update_perms=True)
     click.echo(click.style("Created all permissions", fg="green"))
@@ -211,9 +261,9 @@ def create_permissions():
 
 @fab.command("list-views")
 @with_appcontext
-def list_views():
+def list_views() -> None:
     """
-        List all registered views
+    List all registered views
     """
     echo_header("List of registered views")
     for view in current_app.appbuilder.baseviews:
@@ -226,9 +276,9 @@ def list_views():
 
 @fab.command("list-users")
 @with_appcontext
-def list_users():
+def list_users() -> None:
     """
-        List all users on the database
+    List all users on the database
     """
     echo_header("List of users")
     for user in current_app.appbuilder.sm.get_all_users():
@@ -246,43 +296,38 @@ def list_users():
     help="Your application name, directory will have this name",
 )
 @click.option(
-    "--engine",
-    prompt="Your engine type, SQLAlchemy or MongoEngine",
-    type=click.Choice(["SQLAlchemy", "MongoEngine"]),
-    default="SQLAlchemy",
-    help="Write your engine type",
+    "--secret-key",
+    prompt="Your app SECRET_KEY. It should be a long random string. Minimal size is 20",
+    callback=validate_secret_key,
+    help="This secret key is used by Flask for"
+    "securely signing the session cookie and can be used for any other security"
+    "related needs by extensions or your application."
+    "It should be a long random bytes or str",
 )
-def create_app(name, engine):
+def create_app(name: str, secret_key: str) -> None:
     """
-        Create a Skeleton application (needs internet connection to github)
+    Create a Skeleton application (needs internet connection to github)
     """
     try:
-        if engine.lower() == "sqlalchemy":
-            url = urlopen(SQLA_REPO_URL)
-            dirname = "Flask-AppBuilder-Skeleton-master"
-        elif engine.lower() == "mongoengine":
-            url = urlopen(MONGOENGIE_REPO_URL)
-            dirname = "Flask-AppBuilder-Skeleton-me-master"
+        url = urlopen(SQLA_REPO_URL)
+        dirname = "Flask-AppBuilder-Skeleton-5"
         zipfile = ZipFile(BytesIO(url.read()))
         zipfile.extractall()
         os.rename(dirname, name)
+
+        template_filename = os.path.join(os.path.abspath(name), "config.py.tpl")
+        config_filename = os.path.join(os.path.abspath(name), "config.py")
+        template = jinja2.Template(open(template_filename).read())
+        rendered_template = template.render({"secret_key": secret_key})
+        with open(config_filename, "w") as fd:
+            fd.write(rendered_template)
+
         click.echo(click.style("Downloaded the skeleton app, good coding!", fg="green"))
-        return True
     except Exception as e:
         click.echo(click.style("Something went wrong {0}".format(e), fg="red"))
-        if engine.lower() == "sqlalchemy":
-            click.echo(
-                click.style(
-                    "Try downloading from {0}".format(SQLA_REPO_URL), fg="green"
-                )
-            )
-        elif engine.lower() == "mongoengine":
-            click.echo(
-                click.style(
-                    "Try downloading from {0}".format(MONGOENGIE_REPO_URL), fg="green"
-                )
-            )
-        return False
+        click.echo(
+            click.style("Try downloading from {0}".format(SQLA_REPO_URL), fg="green")
+        )
 
 
 @fab.command("create-addon")
@@ -291,9 +336,9 @@ def create_app(name, engine):
     prompt="Your new addon name",
     help="Your addon name will be prefixed by fab_addon_, directory will have this name",
 )
-def create_addon(name):
+def create_addon(name: str) -> None:
     """
-        Create a Skeleton AddOn (needs internet connection to github)
+    Create a Skeleton AddOn (needs internet connection to github)
     """
     try:
         full_name = "fab_addon_" + name
@@ -311,19 +356,17 @@ def create_addon(name):
         click.echo(
             click.style("Downloaded the skeleton addon, good coding!", fg="green")
         )
-        return True
     except Exception as e:
         click.echo(click.style("Something went wrong {0}".format(e), fg="red"))
-        return False
 
 
 @fab.command("collect-static")
 @click.option(
     "--static_folder", default="app/static", help="Your projects static folder"
 )
-def collect_static(static_folder):
+def collect_static(static_folder: str) -> None:
     """
-        Copies flask-appbuilder static files to your projects static folder
+    Copies flask-appbuilder static files to your projects static folder
     """
     appbuilder_static_path = os.path.join(
         os.path.dirname(os.path.abspath(__file__)), "static/appbuilder"
@@ -357,9 +400,11 @@ def collect_static(static_folder):
 @click.option(
     "--keywords", "-k", multiple=True, default=["lazy_gettext", "gettext", "_", "__"]
 )
-def babel_extract(config, input, output, target, keywords):
+def babel_extract(
+    config: str, input: str, output: str, target: str, keywords: list[str]
+) -> None:
     """
-        Babel, Extracts and updates all messages marked for translation
+    Babel, Extracts and updates all messages marked for translation
     """
     click.echo(
         click.style(
@@ -369,10 +414,10 @@ def babel_extract(config, input, output, target, keywords):
             fg="green",
         )
     )
-    keywords = " -k ".join(keywords)
+    keywords_args = " -k ".join(keywords)
     os.popen(
         "pybabel extract -F {0} -k {1} -o {2} {3}".format(
-            config, keywords, output, input
+            config, keywords_args, output, input
         )
     )
     click.echo(click.style("Starting Update target:{0}".format(target), fg="green"))
@@ -386,9 +431,9 @@ def babel_extract(config, input, output, target, keywords):
     default="app/translations",
     help="The target directory where translations reside",
 )
-def babel_compile(target):
+def babel_compile(target: str) -> None:
     """
-        Babel, Compiles all translations
+    Babel, Compiles all translations
     """
     click.echo(click.style("Starting Compile target:{0}".format(target), fg="green"))
     os.popen("pybabel compile -f -d {0}".format(target))