Flask-Exts 0.1.9__tar.gz → 0.2.0__tar.gz

{flask_exts-0.1.9 → flask_exts-0.2.0}/CHANGES.rst

@@ -1,3 +1,10 @@
+v0.2.0
+------
+
+Released 2025-01-07
+
+- update templates.macros
+
 v0.1.9
 ------
 
@@ -17,7 +24,7 @@ v0.1.7
 
 Released 2024-10-13
 
-- add theme for templating
+- add theme for template
 - admin view framework
 
 v0.1.6
@@ -28,7 +35,6 @@ Released 2024-09-14
 - merge translations of wtforms, flask_exts and app into flask_babel.get_translations()
 - update FileField and ImageField
 - add url for template.static
-- use namespace ns.bootstrap to control bootstrap's css and js
 
 v0.1.5
 ------

{flask_exts-0.1.9 → flask_exts-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: Flask-Exts
-Version: 0.1.9
+Version: 0.2.0
 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
@@ -28,6 +28,7 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
+License-File: LICENSE.rst
 Keywords: admin,babel,flask,form,sql,widget
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Web Environment
@@ -44,7 +45,6 @@ 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: python-plugins>=0.2
 Requires-Dist: wtforms>=3.0
 Description-Content-Type: text/x-rst
 

flask_exts-0.1.9/docs/usage.rst → flask_exts-0.2.0/docs/configure.rst

@@ -1,17 +1,6 @@
-=====
-Usage
-=====
-
-.. _installation:
-
-Installation
-==============
-
-To use Flask-Exts, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install flask-exts
+==========
+Configure
+==========
 
 Configuration
 ==============
@@ -23,16 +12,8 @@ Configuration
                            Default is ``None``.
 ``BABEL_DEFAULT_TIMEZONE`` Set to ``Asia/Shanghai`` to babel's default timezone.
                            Default is ``None``.
-``JQUERY_JS_URL``          Set to ``jquery js url`` to active ``jquery``.
-                           Default is in ``template.static``.
-``BOOTSTRAP_CSS_URL``      Set to ``bootstrap css url`` to active ``bootstrap css``.
-                           Default is in ``template.static``.
-``BOOTSTRAP_JS_URL``       Set to ``bootstrap js url`` to active ``bootstrap js``.
-                           Default is in ``template.static``.
-``ICON_SPRITE_URL``        Set to ``icon url`` to active ``icon``.
-                           Default is in ``template.static``.
-``CSRF_ENABLED``           Set to ``True`` to enable form's CSRF .
-                           Default is ``False``.
+``CSRF_ENABLED``           Set to ``False`` to enable form's CSRF .
+                           Default is ``True``.
 ``CSRF_SECRET_KEY``        Random data for generating secure tokens.
                            If this is not set then ``SECRET_KEY`` is used.
 ``CSRF_FIELD_NAME``        Name of the form field and session key that holds the CSRF token.
@@ -42,7 +23,7 @@ Configuration
 ``TEMPLATE_ENABLED``       Set to ``False`` to disable templating extension.
                            Default is ``True``.
 ``TEMPLATE_THEME``         Set to ``theme`` to create custom theme                           
-                           Default is ``templating.theme.DefaultTheme()``
+                           Default is ``template.theme.BootstrapTheme(4)``
 ``USER_ENABLED``           Set to ``False`` to disable ``User`` support. 
                            Default is ``True``. 
 ``USER_CENTER``            set to ``user center`` to create custom user_center
@@ -51,14 +32,3 @@ Configuration
                            Default is ``True``. 
 ========================== =====================================================================
 
-Examples
-===========
-
-``python simple.py`` to run a simple example.
-
-.. literalinclude:: ../examples/simple.py
-  :language: python
-
-More examples, please click :doc:`examples`.
-
-

flask_exts-0.1.9/docs/translation.rst → flask_exts-0.2.0/docs/develop.rst

@@ -1,10 +1,56 @@
-Translations
-============
+=======
+Develop
+=======
 
-src
----
+Install
+=======
 
-pybabel::
+.. code-block:: console
+
+    $ pip install -e .
+    $ pip install -r requirements/develop.in
+
+Test
+====
+Tests are run with `pytest <https://pytest.org/>`_.
+To run the tests, from the project directory:
+
+.. code-block:: console
+
+    # requirements
+    $ pip install -r requirements/test.in    
+
+    # update translation
+    $ pybabel compile -d src/flask_exts/translations -D messages
+    $ pybabel compile -d tests/translations
+    
+    # test
+    $ pytest
+
+Docs
+====
+
+.. code-block:: console
+
+    $ pip install -r docs/requirements.txt
+    $ cd docs
+    $ make html
+
+Publish
+=======
+
+.. code-block:: console
+
+    $ pip install -r requirements/build.in
+    $ python -m build
+
+Translation
+=============
+
+pybabel
+-------------
+
+.. code-block:: console
 
     # extract messages from source files and generate a POT file
     pybabel extract -F babel.cfg -o babel/messages.pot src/
@@ -27,7 +73,7 @@ pybabel::
 tests
 -----
 
-pybabel::
+.. code-block:: console
 
 
     cd tests/
@@ -47,9 +93,4 @@ pybabel::
 
     # compile message catalogs to MO files
 
-    pybabel compile -d translations
-
-
-
-
-
+    pybabel compile -d translations

{flask_exts-0.1.9 → flask_exts-0.2.0}/docs/index.rst

@@ -8,16 +8,33 @@ Welcome to Flask-Exts's documentation!
 
 **Flask-Exts** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
 
+.. _installation:
+
+Installation
+==============
+
+To use Flask-Exts, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install flask-exts
+
+Examples
+===========
+
+``python simple.py`` to run a simple example.
+
+.. literalinclude:: ../examples/simple.py
+  :language: python
+
+More examples, please click :doc:`examples`.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   usage
-   api
-   forms
-   templating
+   configure
    develop
-   translation
    examples
    changes
 

{flask_exts-0.1.9 → flask_exts-0.2.0}/examples/README.rst

@@ -2,7 +2,7 @@
 Examples
 ========================
 
-Install
+Download
 =========
 
 Type these commands in the terminal:
@@ -14,12 +14,14 @@ Type these commands in the terminal:
     $ python3 -m venv venv
     $ source venv/bin/activate
     $ pip install flask-exts
-    
 
 Run the examples
 ===============================
 
-Type the command in the terminal:
+Type the command in the terminal, then go to http://localhost:5000.
+
+Start
+----------
 
 simple 
 ---------
@@ -30,8 +32,6 @@ run only one file.
 
     $ python simple.py
 
-Now go to http://localhost:5000.
-
 demo
 -----------------
 
@@ -41,14 +41,6 @@ With sqlite db.
     
     $ flask --app demo run --debug --port=5000
 
-
-fileadmin
------------------
-
-.. code-block:: bash
-    
-    $ flask --app admin/fileadmin run
-
 Bootstrap 4
 -----------------
 
@@ -63,5 +55,9 @@ Bootstrap 5
     
     $ flask --app bootstrap5/app.py run
 
+fileadmin
+-----------------
 
-
+.. code-block:: bash
+    
+    $ flask --app admin/fileadmin run

{flask_exts-0.1.9 → flask_exts-0.2.0}/examples/bootstrap4/app.py

@@ -6,7 +6,7 @@ from wtforms.validators import DataRequired, Length, Regexp
 from wtforms.fields import *
 from flask_sqlalchemy import SQLAlchemy
 from flask_exts.forms.form import FlaskForm
-from python_plugins.forms.fields.switch import SwitchField
+from flask_exts.forms.fields import SwitchField
 from flask_exts import Manager
 
 manager = Manager()

{flask_exts-0.1.9 → flask_exts-0.2.0}/examples/bootstrap5/app.py

@@ -7,11 +7,11 @@ from wtforms.fields import *
 from flask_sqlalchemy import SQLAlchemy
 
 from flask_exts.forms.form import FlaskForm
-from python_plugins.forms.fields.switch import SwitchField
+from flask_exts.forms.fields import SwitchField
 from flask_exts import Manager
-from flask_exts.templating.theme import DefaultTheme
+from flask_exts.template.theme import BootstrapTheme
 
-theme = DefaultTheme(bootstrap_version=5)
+theme = BootstrapTheme(version=5)
 
 manager = Manager()
 app = Flask(__name__)

{flask_exts-0.1.9 → flask_exts-0.2.0}/examples/demo/make_app.py

@@ -1,11 +1,10 @@
 import os.path
 from flask import Flask
-from flask import render_template
 from flask_exts import Manager
 from flask_exts.admin import Admin
 from .models import db
 from .user_center import UserCenter
-from .views.index_view import myview
+from .views.my_view import myview
 
 
 def get_sqlite_path():
@@ -15,9 +14,6 @@ def get_sqlite_path():
 
 
 def build_sample_db(app):
-    import string
-    import random
-
     # db.drop_all()
     db.create_all()
     user_center = app.config["USER_CENTER"]
@@ -48,7 +44,7 @@ def init_app(app: Flask):
 
     admin = Admin(name="Demo")
     admin.init_app(app)
-    admin.add_view(myview,is_menu=False)
+    admin.add_view(myview)
 
     if not os.path.exists(app.config["DATABASE_FILE"]):
         with app.app_context():

{flask_exts-0.1.9/examples/demo/templates → flask_exts-0.2.0/examples/demo/templates/my}/index.html

@@ -1,6 +1,6 @@
 {% extends 'admin/master.html' %}
 {% block main %}
 <div>
-    Demo:Flask-Exts
+    Demo:my:index
 </div>
 {% endblock %}

{flask_exts-0.1.9 → flask_exts-0.2.0}/examples/demo/user_center.py

@@ -1,5 +1,5 @@
 from werkzeug.security import generate_password_hash, check_password_hash
-from flask_exts.users.user_center import DefaultUserCenter
+from flask_exts.users.default_usercenter import DefaultUserCenter
 from .models import db,select
 from .models.user import User
 

flask_exts-0.1.9/examples/demo/views/index_view.py → flask_exts-0.2.0/examples/demo/views/my_view.py

@@ -5,6 +5,6 @@ from flask_exts.admin import BaseView
 class MyView(BaseView):
     @expose("/")
     def index(self):
-        return self.render("index.html")
+        return self.render("my/index.html")
     
-myview = MyView(name="Home",url="/") 
+myview = MyView(name="MyView") 

{flask_exts-0.1.9 → flask_exts-0.2.0}/pyproject.toml

@@ -31,7 +31,6 @@ dependencies = [
     "flask-babel>=4.0",
     "Flask-SQLAlchemy>=3.0",
     "Flask-Login>=0.6",
-    "Python-Plugins>=0.2",
 ]
 
 [project.urls]

flask_exts-0.2.0/src/flask_exts/__about__.py

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

{flask_exts-0.1.9 → flask_exts-0.2.0}/src/flask_exts/admin/file_admin/base_file_admin.py

@@ -3,16 +3,16 @@ import platform
 import re
 from operator import itemgetter
 from datetime import datetime
-from flask_babel import gettext,lazy_gettext
+from flask_babel import gettext, lazy_gettext
 from flask import flash, redirect, abort, request
 from wtforms import fields, validators
 from werkzeug.utils import secure_filename
 from ..view import BaseView
 from ..wraps import expose
 from ..actions import action, ActionsMixin
-from ...forms.form import FlaskForm as BaseForm
+from ...forms.form import BaseForm
 from ...utils import flash_errors
-from ...utils.form import validate_form_on_submit
+
 
 class BaseFileAdmin(BaseView, ActionsMixin):
     can_upload = True
@@ -466,7 +466,7 @@ class BaseFileAdmin(BaseView, ActionsMixin):
         :param form:
             Form to validate
         """
-        return validate_form_on_submit(form)
+        return form.validate_on_submit()
 
     def _get_dir_url(self, endpoint, path=None, **kwargs):
         """

{flask_exts-0.1.9 → flask_exts-0.2.0}/src/flask_exts/admin/views/user_view.py

@@ -7,7 +7,6 @@ from flask_login import current_user
 from flask_login import login_user
 from flask_login import logout_user
 from flask_login import login_required
-from ...utils.form import validate_form_on_submit
 from ..wraps import expose
 from ..view import BaseView
 from flask import current_app
@@ -51,7 +50,7 @@ class UserView(BaseView):
 
     @property
     def usercenter(self):
-        return current_app.extensions["usercenter"]
+        return current_app.extensions["user"]
 
     def get_login_form_class(self):
         return self.usercenter.login_form_class
@@ -93,10 +92,11 @@ class UserView(BaseView):
         if current_user.is_authenticated:
             return redirect(url_for(".index"))
         form = self.get_login_form_class()()
-        if validate_form_on_submit(form):
+        if form.validate_on_submit():
             (user, error) = self.validate_login_and_get_user(form)
             if user is None:
-                flash(error)
+                flash(error,'error')
+                # form.username.errors.append(error)
             else:
                 if hasattr(form, "remember_me"):
                     login_user(user, remember=form.remember_me.data)
@@ -113,7 +113,7 @@ class UserView(BaseView):
         if current_user.is_authenticated:
             return redirect(url_for(".index"))
         form = self.get_register_form_class()()
-        if validate_form_on_submit(form):
+        if form.validate_on_submit():
             (user, error) = self.validate_register_and_create_user(form)
             if user is None:
                 flash(error)

flask_exts-0.2.0/src/flask_exts/forms/fields/__init__.py

@@ -0,0 +1,4 @@
+from .json import JSONField
+from .datetime import DateTimeField
+from .file import FileField, ImageField
+from .switch import SwitchField

flask_exts-0.2.0/src/flask_exts/forms/fields/datetime.py

@@ -0,0 +1,100 @@
+import time
+import datetime
+import wtforms.fields
+from ..widgets.datetime import DateTimePickerWidget
+from ..widgets.datetime import TimePickerWidget
+
+class DateTimeField(wtforms.fields.DateTimeField):
+    """
+    Allows modifying the datetime format of a DateTimeField using form_args.
+    """
+
+    widget = DateTimePickerWidget()
+
+    def __init__(self, label=None, validators=None, format=None, **kwargs):
+        """Constructor
+
+        :param label:
+            Label
+        :param validators:
+            Field validators
+        :param format:
+            Format for text to date conversion. Defaults to '%Y-%m-%d %H:%M:%S'
+        :param kwargs:
+            Any additional parameters
+        """
+        super().__init__(
+            label, validators, format or "%Y-%m-%d %H:%M:%S", **kwargs
+        )
+
+
+class TimeField(wtforms.fields.Field):
+    """
+    A text field which stores a `datetime.time` object.
+    Accepts time string in multiple formats: 20:10, 20:10:00, 10:00 am, 9:30pm, etc.
+    """
+
+    widget = TimePickerWidget()
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        formats=None,
+        default_format=None,
+        widget_format=None,
+        **kwargs
+    ):
+        """
+        Constructor
+
+        :param label:
+            Label
+        :param validators:
+            Field validators
+        :param formats:
+            Supported time formats, as a enumerable.
+        :param default_format:
+            Default time format. Defaults to '%H:%M:%S'
+        :param kwargs:
+            Any additional parameters
+        """
+        super().__init__(label, validators, **kwargs)
+
+        self.formats = formats or (
+            "%H:%M:%S",
+            "%H:%M",
+            "%I:%M:%S%p",
+            "%I:%M%p",
+            "%I:%M:%S %p",
+            "%I:%M %p",
+        )
+
+        self.default_format = default_format or "%H:%M:%S"
+
+    def _value(self):
+        if self.raw_data:
+            return " ".join(self.raw_data)
+        elif self.data is not None:
+            return self.data.strftime(self.default_format)
+        else:
+            return ""
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            date_str = " ".join(valuelist)
+
+            if date_str.strip():
+                for format in self.formats:
+                    try:
+                        timetuple = time.strptime(date_str, format)
+                        self.data = datetime.time(
+                            timetuple.tm_hour, timetuple.tm_min, timetuple.tm_sec
+                        )
+                        return
+                    except ValueError:
+                        pass
+
+                raise ValueError(self.gettext("Invalid time format"))
+            else:
+                self.data = None

flask_exts-0.2.0/src/flask_exts/forms/fields/json.py

@@ -0,0 +1,19 @@
+import json
+from wtforms.fields import TextAreaField
+
+class JSONField(TextAreaField):
+    def process_formdata(self, valuelist):
+        if valuelist:
+            if not valuelist[0]:
+                self.data = None
+                return
+            try:
+                self.data = json.loads(valuelist[0])
+            except ValueError:
+                raise ValueError(self.gettext("Invalid JSON"))
+
+    def _value(self):
+        if self.data:
+            return json.dumps(self.data, ensure_ascii=False)
+        else:
+            return ""