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

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

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

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

@@ -1,3 +1,13 @@
+v0.2.3
+------
+
+Released 2025-08-28
+
+- move form into template
+- add folder email
+- add security.email_verification
+
+
 v0.2.2
 ------
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Flask-Exts
-Version: 0.2.2
+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

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

@@ -18,7 +18,8 @@ Configuration
                            Default is ``csrf_token``.
 ``CSRF_TIME_LIMIT``        Max age in seconds for CSRF tokens. 
                            Default is ``1800``. 
-``TEMPLATE_THEME``         Set to ``theme`` to create custom theme                           
-                           Default is ``template.theme.BootstrapTheme(4)``
+``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.2 → flask_exts-0.2.3}/examples/bootstrap4/app.py

@@ -3,8 +3,8 @@ 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_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
 

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

@@ -4,13 +4,12 @@ from markupsafe import Markup
 from wtforms.validators import DataRequired, Length, Regexp
 from wtforms.fields import *
 
-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)
 
 app = Flask(__name__)
 app.secret_key = "dev"
@@ -18,10 +17,13 @@ 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
 
-manager = Manager()
+class MyManager(Manager):
+    def get_theme(self):
+        return BootstrapTheme(5)
+
+manager = MyManager()
 manager.init_app(app)
 
 

{flask_exts-0.2.2 → 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.2 → flask_exts-0.2.3}/examples/demo/admin_views.py

@@ -5,11 +5,12 @@ 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"].admins[0]
+    admin = app.extensions["manager"].admin
 
     admin.add_view(myview)
     admin.add_view(userview)
@@ -18,6 +19,10 @@ def add_views(app):
     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')

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

@@ -1,6 +1,6 @@
 import random
 import datetime
-from flask_exts.proxies import current_usercenter
+from flask_exts.proxies import _usercenter
 from .models import db
 from .models.author import Author
 from .models.author import AVAILABLE_USER_TYPES
@@ -9,14 +9,25 @@ from .models.post import Post
 from .models.tree import Tree
 from .models.keyword import Keyword
 from .models.user import MyUser
+from .models.location_image import ImageType
 
 
 def build_user_admin():
-    u, _ = current_usercenter.create_user(
+    u, _ = _usercenter.create_user(
         username="admin", password="admin", email="admin@example.com"
     )
-    r, _ = current_usercenter.create_role(name="admin")
-    current_usercenter.user_add_role(u, r)
+    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():
@@ -225,5 +236,6 @@ def build_sample_db():
     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.2 → flask_exts-0.2.3}/examples/demo/make_app.py

@@ -2,6 +2,11 @@ import os.path as op
 from flask import Flask
 from flask_exts import Manager
 
+class MyManager(Manager):
+    def get_admin_class(self):
+        from flask_exts.admin.admin import Admin
+        return Admin
+
 
 def get_sqlite_path():
     app_dir = op.realpath(op.dirname(__file__))
@@ -10,26 +15,21 @@ def get_sqlite_path():
 
 
 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"]
-    # JWT
-    app.config["JWT_SECRET_KEY"] = "SECRET_KEY"
-    app.config["JWT_HASH"] = "HS256"
-    # app.config["ADMIN_ACCESS_ENABLED"] = False
     init_app(app)
-
     return app
 
 
 def init_app(app: Flask):
-
-    manager = Manager()
+    manager = MyManager()
     manager.init_app(app)
 
     from .models import init_models
@@ -40,6 +40,15 @@ def init_app(app: Flask):
 
     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

flask_exts-0.2.2/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.2 → 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.2/examples/sqla-custom-inline-forms/views/image_view.py → flask_exts-0.2.3/examples/demo/views/location_image_view.py

@@ -3,12 +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.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
@@ -60,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

{flask_exts-0.2.2 → flask_exts-0.2.3}/examples/fileadmin/make_app.py

@@ -9,7 +9,7 @@ def create_app():
     app = Flask(__name__)
     app.config["SECRET_KEY"] = "dev"
     app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
-    app.config["ADMIN_ACCESS_ENABLED"] = False
+
     init_app(app)
     return app
 
@@ -22,11 +22,5 @@ def init_app(app: Flask):
         # db.drop_all()
         db.create_all()
 
-    # Flask views
-    @app.route("/")
-    def index():
-
-        return '<a href="/admin/">Click me to get to Admin!</a>'
-
-    admin = app.extensions["manager"].admins[0]
+    admin = manager.admins[0]
     admin.add_view(file_view)

flask_exts-0.2.3/examples/instance/config.py

@@ -0,0 +1,3 @@
+# JWT
+JWT_SECRET_KEY = "SECRET_KEY"
+JWT_HASH = "HS256"

{flask_exts-0.2.2 → flask_exts-0.2.3}/examples/rediscli.py

@@ -5,7 +5,7 @@ from flask_exts.views.rediscli_view import RedisCli
 
 app = Flask(__name__)
 app.config["SECRET_KEY"] = "dev"
-app.config["ADMIN_ACCESS_ENABLED"] =False
+
 # Manager init
 manager = Manager()
 manager.init_app(app)

flask_exts-0.2.3/examples/simple.py

@@ -0,0 +1,27 @@
+# simple.py
+
+from flask import Flask
+from flask_exts import Manager
+from flask_exts.admin import expose
+from flask_exts.admin import BaseView
+from flask_exts.views.index_view import IndexView
+
+
+class MockView(BaseView):
+    @expose("/")
+    def index(self):
+        return "Success!"
+
+
+app = Flask(__name__)
+app.config["SECRET_KEY"] = "dev"
+manager = Manager()
+manager.init_app(app)
+# Register the index view
+manager.admin.add_view(IndexView(), is_menu=False)
+# Register a mock view
+manager.admin.add_view(MockView())
+
+
+if __name__ == "__main__":
+    app.run(debug=True)

flask_exts-0.2.3/src/flask_exts/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.2.3"

{flask_exts-0.2.2 → flask_exts-0.2.3}/src/flask_exts/admin/__init__.py

@@ -1,3 +1,2 @@
-from .admin import Admin
 from .view import BaseView
 from .view import expose

flask_exts-0.2.3/src/flask_exts/admin/admin.py

@@ -0,0 +1,15 @@
+from .base_admin import BaseAdmin
+from ..utils.authorize import authorize_allow
+class Admin(BaseAdmin):
+
+    def allow(self, *args, **kwargs):
+         return authorize_allow(*args, **kwargs)
+    
+    def init_views(self):
+        from ..views.index_view import IndexView
+        from ..views.user_view import UserView
+        index_view = IndexView()
+        self.add_view(index_view, is_menu=False)
+
+        user_view = UserView()
+        self.add_view(user_view, is_menu=False)

flask_exts-0.2.2/src/flask_exts/admin/admin.py → flask_exts-0.2.3/src/flask_exts/admin/base_admin.py

@@ -3,20 +3,25 @@ from flask import url_for
 from .menu import Menu
 
 
-class Admin:
+class BaseAdmin:
     """
     Collection of the admin views. Also manages menu structure.
     """
 
-    def __init__(
-        self,
-        app=None,
-        name="Admin",
-        url="/admin",
-        endpoint="admin",
-        template_folder=None,
-        static_folder=None,
-    ):
+    def __init__(self, app=None):
+        self.app = app
+        self.name = self.get_admin_name()
+        self.url = self.get_admin_url()
+        self.endpoint = self.get_admin_endpoint()
+        self.template_folder = self.get_admin_template_folder()
+        self.static_folder = self.get_admin_static_folder()
+        self._views = {}
+        self.menu = Menu(self)
+        self.init_views()
+        if app is not None:
+            self.init_app(app)
+
+    def init_app(self, app):
         """
         Constructor.
 
@@ -31,18 +36,32 @@ class Admin:
             a single Flask application, you have to set a unique endpoint name for each instance.
 
         """
-        self._access_callback = None
         self.app = app
-        self.name = name
-        self.endpoint = endpoint
-        self.url = url
-        if not self.url.startswith("/"):
+
+        # Register views
+        for v in self._views.values():
+            app.register_blueprint(v.create_blueprint())
+
+    def get_admin_name(self):
+        name = "Admin"
+        return name
+
+    def get_admin_url(self):
+        url = "/admin"
+        if not url.startswith("/"):
             raise ValueError("admin.url must startswith /")
-        self.template_folder = template_folder or "../templates"
-        self.static_folder = static_folder or "../static"
-        self._views = []
-        self.menu = Menu(self)
+        return url
+
+    def get_admin_endpoint(self):
+        return "admin"
 
+    def get_admin_template_folder(self):
+        template_folder = "../templates"
+        return template_folder
+
+    def get_admin_static_folder(self):
+        static_folder = "../static"
+        return static_folder
 
     def add_view(self, view, is_menu=True, category=None):
         """
@@ -54,8 +73,13 @@ class Admin:
         # attach self(admin) to view
         view.admin = self
 
-        # Add to views
-        self._views.append(view)
+        # Add to _views
+        view_name = view.name.lower().replace(" ", "_")
+
+        if view_name in self._views:
+            raise ValueError(f"View with name {view.name} already exists")
+
+        self._views[view_name] = view
 
         # If app was provided in constructor, register view with Flask app
         if self.app is not None:
@@ -66,9 +90,7 @@ class Admin:
 
     def get_url(self, endpoint, **kwargs):
         """
-        Generate URL for the endpoint. If you want to customize URL generation
-        logic (persist some query string argument, for example), this is
-        right place to do it.
+        Generate URL for the endpoint.
 
         :param endpoint:
             Flask endpoint name
@@ -77,6 +99,15 @@ class Admin:
         """
         return url_for(endpoint, **kwargs)
 
+    def allow(self, *args, **kwargs):
+        return True
+
+    def init_views(self):
+        """
+        Initialize views. This method can be overridden in subclasses to add custom views.
+        """
+        pass
+
     def render(self, template, **kwargs):
         """
         Render template
@@ -86,32 +117,9 @@ class Admin:
         :param kwargs:
             Template arguments
         """
-        # Store self as admin
+        # Add admin instance to kwargs
         kwargs["admin"] = self
-        # Expose get_url helper
+        # Add URL generation method to kwargs
         kwargs["get_url"] = self.get_url
 
         return render_template(template, **kwargs)
-
-    def init_app(self, app):
-        """
-        Register all views with the Flask application.
-
-        :param app:
-            Flask application instance
-        """
-        self.app = app
-
-        # Register views
-        for view in self._views:
-            app.register_blueprint(view.create_blueprint())
-
-    def access(self, *args, **kwargs):
-        if self._access_callback:
-            return self._access_callback(*args, **kwargs)
-        else:
-            return True
-
-    def set_access_callback(self, callback):
-        self._access_callback = callback
-        return

{flask_exts-0.2.2 → flask_exts-0.2.3}/src/flask_exts/admin/model/form.py

@@ -3,9 +3,9 @@ import warnings
 from wtforms.fields import HiddenField
 from wtforms.fields.core import UnboundField
 from wtforms.validators import InputRequired
-from ...forms.widgets import XEditableWidget
-from ...forms.form import BaseForm
-from ...forms.rules import RuleSet
+from ...template.widgets import XEditableWidget
+from ...template.form.base_form import BaseForm
+from ...template.rules import RuleSet
 
 
 def converts(*args):

{flask_exts-0.2.2 → flask_exts-0.2.3}/src/flask_exts/admin/model/view.py

@@ -32,11 +32,11 @@ from ..view import BaseView
 from ..actions import ActionsMixin
 from .. import row_action
 from ..view import expose
-from ...forms.form import BaseForm
-from ...forms import FormOpts
-from ...forms.rules import RuleSet
-from ...forms.utils import get_form_data
-from ...forms.utils import validate_form_on_submit
+from ...template.form.base_form import BaseForm
+from ...template.form.form_opts import FormOpts
+from ...template.rules import RuleSet
+from ...template.form.utils import get_form_data
+from ...template.form.utils import validate_form_on_submit
 from ...utils import flash_errors
 from ...utils import get_redirect_target
 from ...utils import rec_getattr
@@ -703,7 +703,7 @@ class BaseModelView(BaseView, ActionsMixin):
 
         Here's simple example which illustrates how to use::
 
-            from flask_exts.forms.form import rules
+            from .forms.form import rules
 
             class MyModelView(ModelView):
                 form_rules = [
@@ -799,7 +799,7 @@ class BaseModelView(BaseView, ActionsMixin):
         :param menu_class_name:
             Optional class name for the menu item.
         :param menu_icon_type:
-            Optional icon. 
+            Optional icon.
         :param menu_icon_value:
             Icon name or URL.
         """
@@ -819,7 +819,6 @@ class BaseModelView(BaseView, ActionsMixin):
             menu_icon_value=menu_icon_value,
         )
 
-
         # Actions
         self.init_actions()
 
@@ -1429,7 +1428,6 @@ class BaseModelView(BaseView, ActionsMixin):
 
         return missing_fields
 
-
     def _validate_form_class(self, ruleset, form_class, remove_missing=True):
         form_fields = []
         for name, obj in form_class.__dict__.items():
@@ -1557,7 +1555,7 @@ class BaseModelView(BaseView, ActionsMixin):
             flash(exc, "error")
             return True
 
-        if current_app.config.get("FLASK_EXTS_RAISE_ON_VIEW_EXCEPTION"):
+        if current_app.config.get("RAISE_ON_VIEW_EXCEPTION"):
             raise
 
         return False