Flask-Exts 0.2.1__tar.gz → 0.2.3__tar.gz

{flask_exts-0.2.1 → flask_exts-0.2.3}/.gitignore

@@ -32,3 +32,6 @@ docs/_build/
 
 # sqlite db
 *.sqlite
+
+# production config
+**/config_prod.py

{flask_exts-0.2.1 → flask_exts-0.2.3}/CHANGES.rst

@@ -1,3 +1,26 @@
+v0.2.3
+------
+
+Released 2025-08-28
+
+- move form into template
+- add folder email
+- add security.email_verification
+
+
+v0.2.2
+------
+
+Released 2025-04-09
+
+- fix datetimepicker
+- set session = db.session as default if ModelView of sqla init session is None
+- set session = db.session as default if QueryAjaxModelLoader init session is None
+- fix select.ajax for select2@4.1.0 
+- fix select in modal
+- add casbin
+- add module: security 
+
 v0.2.1
 ------
 

{flask_exts-0.2.1 → flask_exts-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Flask-Exts
-Version: 0.2.1
+Version: 0.2.3
 Summary: Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
 Project-URL: Documentation, https://flask-exts.readthedocs.io
 Project-URL: Source, https://github.com/ojso/flask-exts
@@ -41,11 +41,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
+Requires-Dist: casbin>=1.0
 Requires-Dist: flask-babel>=4.0
 Requires-Dist: flask-login>=0.6
 Requires-Dist: flask-sqlalchemy>=3.0
 Requires-Dist: flask>=3.0
+Requires-Dist: pyjwt>=2.0
 Requires-Dist: tablib>=3.0
+Requires-Dist: webauthn>=2.0
 Requires-Dist: wtforms>=3.0
 Provides-Extra: rediscli
 Requires-Dist: redis>=4.0.0; extra == 'rediscli'
@@ -56,10 +59,10 @@ Flask Exts
 
 Flask-Exts is mainly inspired by:
 
-- `WTForms <https://github.com/wtforms/wtforms/>`_
-- `Flask-Admin <https://github.com/flask-admin/flask-admin/>`_
+- `Flask-Admin <https://github.com/pallets-eco/flask-admin/>`_
+- `Flask-Security <https://github.com/pallets-eco/flask-security/>`_
 
-Flask-Exts is part rewrited from above and well tested.
+Flask-Exts is partially rewrited from above and well tested.
 
 License
 -------

{flask_exts-0.2.1 → flask_exts-0.2.3}/README.rst

@@ -3,10 +3,10 @@ Flask Exts
 
 Flask-Exts is mainly inspired by:
 
-- `WTForms <https://github.com/wtforms/wtforms/>`_
-- `Flask-Admin <https://github.com/flask-admin/flask-admin/>`_
+- `Flask-Admin <https://github.com/pallets-eco/flask-admin/>`_
+- `Flask-Security <https://github.com/pallets-eco/flask-security/>`_
 
-Flask-Exts is part rewrited from above and well tested.
+Flask-Exts is partially rewrited from above and well tested.
 
 License
 -------

{flask_exts-0.2.1 → flask_exts-0.2.3}/docs/configure.rst

@@ -6,8 +6,6 @@ Configuration
 ==============
 
 ========================== =====================================================================
-``BABEL_ENABLED``          Set to ``False`` to disable babel extension.
-                           Default is ``True``.
 ``BABEL_ACCEPT_LANGUAGES`` Set to ``en;zh`` to bebel's accept languages.
                            Default is ``None``.
 ``BABEL_DEFAULT_TIMEZONE`` Set to ``Asia/Shanghai`` to babel's default timezone.
@@ -20,17 +18,8 @@ Configuration
                            Default is ``csrf_token``.
 ``CSRF_TIME_LIMIT``        Max age in seconds for CSRF tokens. 
                            Default is ``1800``. 
-``TEMPLATE_ENABLED``       Set to ``False`` to disable templating extension.
-                           Default is ``True``.
-``TEMPLATE_THEME``         Set to ``theme`` to create custom theme                           
-                           Default is ``template.theme.BootstrapTheme(4)``
-``USER_ENABLED``           Set to ``False`` to disable ``User`` support. 
-                           Default is ``True``. 
-``ADMIN_ENABLED``          Set to ``False`` to disable ``Admin`` support. 
-                           Default is ``True``. 
-``USER_CENTER``            set to ``user center`` to create custom user_center
-                           Default is ``users.user_center.DefaultUserCenter()``
-``FLASK_LOGIN_ENABLED``    Set to ``False`` to disable ``Flask-Login``. 
-                           Default is ``True``. 
+``VERIFY_EMAIL_SENDER``    Email address used to send verification emails.
+                           It is a dict for smtp with keys: host,port,user,password.
+                           Default is None.
 ========================== =====================================================================
 

{flask_exts-0.2.1 → flask_exts-0.2.3}/docs/index.rst

@@ -6,7 +6,14 @@
 Welcome to Flask-Exts's documentation!
 ======================================
 
-**Flask-Exts** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
+**Flask-Exts** is a Flask extensions with SQLAlchemy, babel, forms, fields, widgets, and so on.
+
+Flask-Exts is mainly inspired by:
+
+- `Flask-Admin <https://github.com/pallets-eco/flask-admin/>`_
+- `Flask-Security <https://github.com/pallets-eco/flask-security/>`_
+
+Flask-Exts is partially rewrited from above and well tested.
 
 .. _installation:
 

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/bootstrap4/app.py

@@ -1,13 +1,12 @@
-# -*- coding: utf-8 -*-
 from enum import Enum
 from flask import Flask, render_template, request, flash, redirect, url_for
 from markupsafe import Markup
 from wtforms.validators import DataRequired, Length, Regexp
 from wtforms.fields import *
-from flask_sqlalchemy import SQLAlchemy
-from flask_exts.forms.form import FlaskForm
-from flask_exts.forms.fields import SwitchField
+from flask_exts.template.form.flask_form import FlaskForm
+from flask_exts.template.fields import SwitchField
 from flask_exts import Manager
+from flask_exts.datastore.sqla import db
 
 manager = Manager()
 
@@ -16,7 +15,6 @@ app.secret_key = 'dev'
 app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///:memory:'
 app.config['ADMIN_ENABLED'] = False
 manager.init_app(app)
-db = SQLAlchemy(app)
 
 class ExampleForm(FlaskForm):
     """An example form that contains all the supported bootstrap style form fields."""

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/bootstrap5/app.py

@@ -1,29 +1,30 @@
 from enum import Enum
 from flask import Flask, render_template, request, flash, redirect, url_for
-from flask import current_app
 from markupsafe import Markup
 from wtforms.validators import DataRequired, Length, Regexp
 from wtforms.fields import *
-from flask_sqlalchemy import SQLAlchemy
 
-from flask_exts.forms.form import FlaskForm
-from flask_exts.forms.fields import SwitchField
+from flask_exts.template.form.flask_form import FlaskForm
+from flask_exts.template.fields import SwitchField
 from flask_exts import Manager
 from flask_exts.template.theme import BootstrapTheme
+from flask_exts.datastore.sqla import db
 
-theme = BootstrapTheme(version=5)
 
-manager = Manager()
 app = Flask(__name__)
 app.secret_key = "dev"
 
 app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
 app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
 # set bootstrap5
-app.config["TEMPLATE_THEME"] = theme
 app.config['ADMIN_ENABLED'] = False
+
+class MyManager(Manager):
+    def get_theme(self):
+        return BootstrapTheme(5)
+
+manager = MyManager()
 manager.init_app(app)
-db = SQLAlchemy(app)
 
 
 class ExampleForm(FlaskForm):

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/bootstrap5/templates/pagination.html

@@ -1,5 +1,5 @@
 {% extends "mybase.html" %}
-{% from 'pagination4/pagination.html' import render_pager, render_pagination %}
+{% from 'bootstrap4/pagination.html' import render_pager, render_pagination %}
 
 {% block content %}
 <h2>Messages</h2>

flask_exts-0.2.3/examples/demo/admin_views.py

@@ -0,0 +1,31 @@
+from .views.my_view import myview
+from .views.user_view import userview
+from .views.keyword_view import keywordview
+from .views.tree_view import treeview
+from .views.tag_view import tagview
+from .views.author_view import authorview
+from .views.post_view import postview
+from .views.location_image_view import locationview
+from flask_exts.admin.menu import MenuLink
+
+
+def add_views(app):
+    admin = app.extensions["manager"].admin
+
+    admin.add_view(myview)
+    admin.add_view(userview)
+    admin.add_view(keywordview)
+    admin.add_view(authorview)
+    admin.add_view(tagview)
+    admin.add_view(postview)
+    admin.add_view(treeview)
+    admin.add_view(locationview)
+    admin.menu.add_link(
+        MenuLink(name="locationlist", url="/locationlist", category="List")
+    )
+    admin.menu.add_category(name="Links")
+    admin.menu.add_link(MenuLink(name="Back Home", url="/", category="Links"))
+    admin.menu.add_sub_category(name='External',parent_name='Links')
+    # admin.menu.add_link(
+    #     MenuLink(name="External link", url="http://www.example.com/", category="External")
+    # )

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/build_sample.py

@@ -1,5 +1,6 @@
 import random
 import datetime
+from flask_exts.proxies import _usercenter
 from .models import db
 from .models.author import Author
 from .models.author import AVAILABLE_USER_TYPES
@@ -7,11 +8,30 @@ from .models.tag import Tag
 from .models.post import Post
 from .models.tree import Tree
 from .models.keyword import Keyword
-from .models.user import User
+from .models.user import MyUser
+from .models.location_image import ImageType
+
+
+def build_user_admin():
+    u, _ = _usercenter.create_user(
+        username="admin", password="admin", email="admin@example.com"
+    )
+    r, _ = _usercenter.create_role(name="admin")
+    _usercenter.user_add_role(u, r)
+
+
+def build_sample_image_type():
+
+    # Add some image types for the form_ajax_refs inside the inline_model
+    image_types = ("JPEG", "PNG", "GIF")
+    for image_type in image_types:
+        itype = ImageType(name=image_type)
+        db.session.add(itype)
+    db.session.commit()
 
 
 def build_sample_userkeyword():
-    user_log = User()
+    user_log = MyUser()
     user_log.username = "log"
     user_log.email = "log"
     user_log.password = "log"
@@ -215,5 +235,7 @@ def build_sample_db():
     build_sample_userkeyword()
     build_sample_tree()
     build_sample_post()
+    build_user_admin()
+    build_sample_image_type()
 
     return

flask_exts-0.2.3/examples/demo/file_op.py

@@ -0,0 +1,13 @@
+import os.path as op
+import os
+
+# Figure out base upload path
+static_path = op.join(op.dirname(__file__), "static")
+
+
+def remove_image(image_path):
+    os.remove(op.join(static_path, image_path))
+
+
+def save_image(file_data, image_path):
+    file_data.save(op.join(static_path, image_path))

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/make_app.py

@@ -1,7 +1,11 @@
 import os.path as op
 from flask import Flask
 from flask_exts import Manager
-from .user_center import UserCenter
+
+class MyManager(Manager):
+    def get_admin_class(self):
+        from flask_exts.admin.admin import Admin
+        return Admin
 
 
 def get_sqlite_path():
@@ -10,44 +14,43 @@ def get_sqlite_path():
     return database_path
 
 
-def register_users(app):
-    user_center = app.config["USER_CENTER"]
-    user_center.register_user("admin", "admin", "admin@example.com")
-
-
 def create_app():
-    app = Flask(__name__)
+    app = Flask(__name__, instance_relative_config=True)
     app.config["SECRET_KEY"] = "dev"
-
+    app.config.from_pyfile('config.py',silent=True)
+    app.config.from_pyfile('config_prod.py',silent=True)
     # app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
     # app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://'
     # app.config["SQLALCHEMY_ECHO"] = True
     app.config["DATABASE_FILE"] = get_sqlite_path()
     app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///" + app.config["DATABASE_FILE"]
-
-    app.config["USER_CENTER"] = UserCenter()
-
     init_app(app)
-
     return app
 
 
 def init_app(app: Flask):
+    manager = MyManager()
+    manager.init_app(app)
 
-    from .models import init_db
-
-    init_db(app)
+    from .models import init_models
 
-    manager = Manager()
-    manager.init_app(app)
+    init_models()
 
     from .admin_views import add_views
 
     add_views(app)
 
+    @app.route("/locationlist")
+    def location_list():
+        from .models.location_image import Location
+        from flask import render_template
+        from .models import db
+
+        locations = db.session.query(Location).all()
+        return render_template("locations.html", locations=locations)
+
     if not op.exists(app.config["DATABASE_FILE"]):
         with app.app_context():
             from .build_sample import build_sample_db
 
             build_sample_db()
-            register_users(app)

flask_exts-0.2.3/examples/demo/models/__init__.py

@@ -0,0 +1,12 @@
+from flask_exts.datastore.sqla import db
+
+
+def init_models():
+    from . import user
+    from . import keyword
+    from . import user_keyword
+    from . import tag
+    from . import author
+    from . import post
+    from . import post_tag
+    from . import tree

flask_exts-0.2.1/examples/sqla-custom-inline-forms/models/model.py → flask_exts-0.2.3/examples/demo/models/location_image.py

@@ -1,14 +1,19 @@
 from . import db
 from typing import Optional
+from typing import List
 from sqlalchemy import ForeignKey
 from sqlalchemy.orm import relationship
 from sqlalchemy.orm import Mapped
 from sqlalchemy.orm import mapped_column
-
+from sqlalchemy import event
+from ..file_op import remove_image
 
 class Location(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str]
+    images: Mapped[List["LocationImage"]] = relationship(
+        "LocationImage", back_populates="location", cascade="all, delete-orphan"
+    )
 
 
 class ImageType(db.Model):
@@ -33,10 +38,21 @@ class LocationImage(db.Model):
     alt: Mapped[str]
     path: Mapped[str]
 
-    location_id: Mapped[int] = mapped_column(ForeignKey("location.id"))
-    location: Mapped["Location"] = relationship(backref='images')
+    location_id = mapped_column(ForeignKey("location.id"))
+    location: Mapped["Location"] = relationship(back_populates="images")
+
+    image_type_id = mapped_column(ForeignKey("image_type.id"))
+    image_type: Mapped["ImageType"] = relationship()
+
 
-    image_type_id: Mapped[int] = mapped_column(ForeignKey("image_type.id"))
-    image_type: Mapped["ImageType"] = relationship(backref='images')
 
 
+# Register after_delete handler which will delete image file after model gets deleted
+@event.listens_for(Location, "after_delete")
+def _handle_image_delete(mapper, conn, target):
+    for location_image in target.images:
+        try:
+            if location_image.path:
+                remove_image(location_image.path)
+        except:
+            pass

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/models/tree.py

@@ -5,6 +5,7 @@ from sqlalchemy.orm import relationship
 from sqlalchemy.orm import Mapped
 from sqlalchemy.orm import mapped_column
 
+
 class Tree(db.Model):
     id: Mapped[int] = mapped_column(primary_key=True)
     name: Mapped[str]
@@ -12,7 +13,7 @@ class Tree(db.Model):
     # recursive relationship
     parent_id: Mapped[Optional[int]] = mapped_column(ForeignKey("tree.id"))
     parent = relationship("Tree", back_populates="children", remote_side=id)
-    children = relationship("Tree",back_populates="parent")
+    children = relationship("Tree", back_populates="parent")
 
     def __str__(self):
-        return "{}".format(self.name)
+        return "{}".format(self.name)

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/models/user.py

@@ -5,12 +5,12 @@ from sqlalchemy.orm import mapped_column
 from sqlalchemy.orm import relationship
 from sqlalchemy.ext.associationproxy import association_proxy
 from sqlalchemy.ext.associationproxy import AssociationProxy
-from flask_login import UserMixin
 from . import db
 from .keyword import Keyword
 from .user_keyword import UserKeywordAssociation
 
-class User(db.Model, UserMixin):
+class MyUser(db.Model):
+    __tablename__="myuser"
     id: Mapped[int] = mapped_column(primary_key=True)
     username: Mapped[str]
     email: Mapped[str]
@@ -21,7 +21,7 @@ class User(db.Model, UserMixin):
     )
 
     user_keyword_associations: Mapped[List["UserKeywordAssociation"]] = relationship(
-        back_populates="user",
+        back_populates="myuser",
         cascade="all, delete-orphan",
     )
 

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/models/user_keyword.py

@@ -10,17 +10,17 @@ from .keyword import Keyword
 
 class UserKeywordAssociation(db.Model):
     __tablename__ = "user_keyword"
-    user_id = mapped_column(ForeignKey("user.id"), primary_key=True)
+    myuser_id = mapped_column(ForeignKey("myuser.id"), primary_key=True)
     keyword_id = mapped_column(ForeignKey("keyword.id"), primary_key=True)
     special_key: Mapped[Optional[str]]
 
-    user: Mapped["User"] = relationship(back_populates="user_keyword_associations")
+    myuser: Mapped["MyUser"] = relationship(back_populates="user_keyword_associations")
     keyword: Mapped[Keyword] = relationship()
 
     # Reference to the "keyword" column inside the "Keyword" object.
     keyword_value = association_proxy('keyword', 'keyword')
 
-    def __init__(self, keyword=None, user=None, special_key=None):
-        self.user = user
+    def __init__(self, keyword=None, myuser=None, special_key=None):
+        self.myuser = myuser
         self.keyword = keyword
         self.special_key = special_key

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/views/author_view.py

@@ -4,12 +4,10 @@ from flask_babel import gettext
 from flask_exts.admin.sqla.filters import BaseSQLAFilter
 from flask_exts.admin.sqla.filters import FilterEqual
 from flask_exts.admin.sqla import ModelView
-from ..models import db
-from ..models.author import Author,AVAILABLE_USER_TYPES
+from ..models.author import Author, AVAILABLE_USER_TYPES
 from ..models.post import Post
 
 
-
 # Custom filter class
 class FilterLastNameBrown(BaseSQLAFilter):
     def apply(self, query, value, alias=None):
@@ -133,4 +131,4 @@ class AuthorView(ModelView):
         return form
 
 
-authorview = AuthorView(Author, db.session)
+authorview = AuthorView(Author)

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/views/keyword_view.py

@@ -1,5 +1,4 @@
 from flask_exts.admin.sqla import ModelView
-from ..models import db
 from ..models.keyword import Keyword
 
 
@@ -7,4 +6,4 @@ class KeywordView(ModelView):
     column_list = ("id", "keyword")
 
 
-keywordview = KeywordView(Keyword, db.session)
+keywordview = KeywordView(Keyword)

flask_exts-0.2.1/examples/sqla-custom-inline-forms/views/image_view.py → flask_exts-0.2.3/examples/demo/views/location_image_view.py

@@ -3,13 +3,13 @@ from flask import request
 from flask import current_app
 from wtforms.fields import FileField
 from flask_exts.admin.sqla.ajax import QueryAjaxModelLoader
-from flask_exts.forms.widgets.render_template import RenderTemplateWidget
+from flask_exts.template.widgets.render_template import RenderTemplateWidget
 from flask_exts.admin.model.form import InlineFormAdmin
 from flask_exts.admin.sqla import ModelView
 from flask_exts.admin.sqla.form import InlineModelConverter
-from flask_exts.forms.fields.sqla import InlineModelFormList
-from ..models import db
-from ..models.model import ImageType, Location, LocationImage
+from flask_exts.template.fields.sqla import InlineModelFormList
+from ..models.location_image import ImageType, Location, LocationImage
+from ..file_op import save_image
 
 
 # This widget uses custom template for inline field list
@@ -41,7 +41,6 @@ class LocationImageInlineModelForm(InlineFormAdmin):
     form_ajax_refs = {
         "image_type": QueryAjaxModelLoader(
             name="image_type",
-            session=db.session,
             model=ImageType,
             fields=("name",),
             order_by="name",
@@ -62,7 +61,7 @@ class LocationImageInlineModelForm(InlineFormAdmin):
 
         if file_data:
             model.path = secure_filename(file_data.filename)
-            current_app.save_image(file_data, model.path)
+            save_image(file_data, model.path)
 
 
 # Administrative class
@@ -72,7 +71,7 @@ class LocationView(ModelView):
     inline_models = (LocationImageInlineModelForm(),)
 
     def __init__(self):
-        super().__init__(Location, db.session, name="Locations")
+        super().__init__(Location, name="Locations")
 
 
 locationview = LocationView()

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/views/post_view.py

@@ -1,13 +1,13 @@
 from wtforms import validators
 from flask_exts.admin.sqla import ModelView
 from flask_exts.admin.sqla.filters import FilterLike
-from ..models import db
 from ..models.post import Post
 from ..models.author import Author
 
 
 # Customized Post model admin
 class PostView(ModelView):
+    can_view_details = True
     column_display_pk = True
     column_list = [
         "id",
@@ -24,6 +24,8 @@ class PostView(ModelView):
     column_default_sort = ("date", True)
     create_modal = True
     # edit_modal = True
+    # details_modal = True
+
     column_sortable_list = [
         "id",
         "title",
@@ -80,8 +82,12 @@ class PostView(ModelView):
         # },
     }
 
+    column_descriptions = dict(
+        color='favorite color'
+        )
+
 
 # Add views
 
 
-postview = PostView(Post, db.session)
+postview = PostView(Post)

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/views/tag_view.py

@@ -1,5 +1,4 @@
 from flask_exts.admin.sqla import ModelView
 from ..models.tag import Tag
-from ..models import db
 
-tagview = ModelView(Tag, db.session)
+tagview = ModelView(Tag)

{flask_exts-0.2.1 → flask_exts-0.2.3}/examples/demo/views/tree_view.py

@@ -1,20 +1,27 @@
 from flask_exts.admin.sqla import ModelView
-from ..models import db
 from ..models.tree import Tree
 
+
 class TreeView(ModelView):
-    list_template = 'tree_list.html'
+    list_template = "tree_list.html"
     column_auto_select_related = True
     column_list = [
-        'id',
-        'name',
-        'parent',
+        "id",
+        "name",
+        "parent",
+    ]
+    form_excluded_columns = [
+        "children",
+    ]
+    column_filters = [
+        "id",
+        "name",
+        "parent",
     ]
-    form_excluded_columns = ['children', ]
-    column_filters = ['id', 'name', 'parent', ]
 
     # override the 'render' method to pass your own parameters to the template
     def render(self, template, **kwargs):
         return super().render(template, foo="bar", **kwargs)
 
-treeview = TreeView(Tree, db.session, category="tree")
+
+treeview = TreeView(Tree)