Flask-Exts 0.1.2__tar.gz → 0.1.4__tar.gz

flask_exts-0.1.4/.readthedocs.yaml

@@ -0,0 +1,39 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+

{flask_exts-0.1.2 → flask_exts-0.1.4}/CHANGES.rst

@@ -1,3 +1,17 @@
+v0.1.4
+------
+
+Unreleased
+
+- form
+
+v0.1.3
+------
+
+Released 2024-03-25
+
+- babel support
+
 v0.1.2
 ------
 

{flask_exts-0.1.2 → flask_exts-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Flask-Exts
-Version: 0.1.2
+Version: 0.1.4
 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
@@ -42,10 +42,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
 Requires-Dist: flask-babel>=4.0
-Requires-Dist: flask-migrate>=4.0
 Requires-Dist: flask-sqlalchemy>=3.0
 Requires-Dist: flask>=3.0
-Requires-Dist: python-dotenv>=1.0
+Requires-Dist: pillow>=10.0
 Requires-Dist: wtforms>=3.0
 Description-Content-Type: text/x-rst
 
@@ -75,26 +74,3 @@ Install and update using pip:
 
     $ pip install -U Flask-Exts
 
-Developing
------------
-
-.. code-block:: console
-
-    $ pip install -e .
-
-Test
-----
-Tests are run with `pytest <https://pytest.org/>`_.
-To run the tests, from the project directory:
-
-.. code-block:: console
-
-    $ pip install -r requirements/test.in
-    $ pytest
-
-Docs
-----
-
-.. code-block:: console
-
-    $ pip install -r docs/requirements.txt

{flask_exts-0.1.2 → flask_exts-0.1.4}/README.rst

@@ -24,26 +24,3 @@ Install and update using pip:
 
     $ pip install -U Flask-Exts
 
-Developing
------------
-
-.. code-block:: console
-
-    $ pip install -e .
-
-Test
-----
-Tests are run with `pytest <https://pytest.org/>`_.
-To run the tests, from the project directory:
-
-.. code-block:: console
-
-    $ pip install -r requirements/test.in
-    $ pytest
-
-Docs
-----
-
-.. code-block:: console
-
-    $ pip install -r docs/requirements.txt

flask_exts-0.1.4/babel.cfg

@@ -0,0 +1,5 @@
+# Python
+[python: **.py]
+# Jinja2
+[jinja2: **/templates/**.html]
+encoding = utf-8

flask_exts-0.1.4/docs/develop.rst

@@ -0,0 +1,43 @@
+Develop
+=======
+
+Install
+-------
+
+.. code-block:: console
+
+    $ pip install -e .
+
+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 admin
+    $ 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
+
+    $ python -m build
+

flask_exts-0.1.4/docs/field.rst

@@ -0,0 +1,33 @@
+======
+field
+======
+
+.. module:: flask_exts.form.fields.upload
+
+The FileUploadField class
+-----------------------------
+
+.. class:: FileUploadField
+
+    Example usage::
+
+        from flask_exts.form.form.base_form import BaseForm
+        from flask_exts.form.fields.upload import FileUploadField
+
+        class TestForm(BaseForm):
+            upload = FileUploadField("Upload", base_path=path)
+
+The FileUploadField class
+-----------------------------
+
+.. class:: ImageUploadField
+
+    Example usage::
+
+        from flask_exts.form.fields.upload import ImageUploadField
+
+        class TestForm(BaseForm):
+            upload = ImageUploadField(
+                "Upload", base_path=path, thumbnail_size=(100, 100, True)
+            )
+

flask_exts-0.1.4/docs/form.rst

@@ -0,0 +1,9 @@
+=====
+form
+=====
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   field

{flask_exts-0.1.2 → flask_exts-0.1.4}/docs/index.rst

@@ -14,6 +14,9 @@ Welcome to Flask-Exts's documentation!
 
    usage
    api
+   form
+   develop
+   translation
    changes
 
 Indices and tables

flask_exts-0.1.4/docs/translation.rst

@@ -0,0 +1,55 @@
+Translations
+============
+
+src
+---
+
+pybabel::
+
+    # extract messages from source files and generate a POT file
+    pybabel extract -F babel.cfg -o src/flask_exts/translations/admin.pot src/
+
+    # create new message catalogs from a POT file
+    pybabel init -i src/flask_exts/translations/admin.pot -d src/flask_exts/translations -D admin -l en
+    pybabel init -i src/flask_exts/translations/admin.pot -d src/flask_exts/translations -D admin -l zh_CN
+
+    # update existing message catalogs from a POT file
+    pybabel update -i src/flask_exts/translations/admin.pot -d src/flask_exts/translations -D admin 
+
+    # edit
+    open the '.po' file
+
+    # compile message catalogs to MO files
+
+    $ pybabel compile -d src/flask_exts/translations -D admin 
+
+
+tests
+-----
+
+pybabel::
+
+
+    cd tests/
+
+    # extract messages from source files and generate a POT file
+    pybabel extract -o translations/messages.pot .
+
+    # create new message catalogs from a POT file
+    pybabel init -i translations/messages.pot -d translations -l en
+    pybabel init -i translations/messages.pot -d translations -l zh_CN
+
+    # update existing message catalogs from a POT file
+    pybabel update -i translations/messages.pot -d translations
+
+    # edit
+    open the '.po' file
+
+    # compile message catalogs to MO files
+
+    pybabel compile -d translations
+
+
+
+
+

{flask_exts-0.1.2 → flask_exts-0.1.4}/pyproject.toml

@@ -30,8 +30,7 @@ dependencies = [
     "WTForms>=3.0",
     "flask-babel>=4.0",
     "Flask-SQLAlchemy>=3.0",
-    "Flask-Migrate>=4.0",
-    "python-dotenv>=1.0",
+    "pillow>=10.0",
 ]
 
 [project.urls]

flask_exts-0.1.4/src/flask_exts/__about__.py

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

flask_exts-0.1.4/src/flask_exts/__init__.py

@@ -0,0 +1 @@
+from .manager import Manager

flask_exts-0.1.4/src/flask_exts/babel/__init__.py

@@ -0,0 +1 @@
+from .admin_babel import gettext, ngettext, lazy_gettext

flask_exts-0.1.4/src/flask_exts/babel/admin_babel.py

@@ -0,0 +1,14 @@
+from flask_babel import Domain
+from .. import translations
+
+class AdminDomain(Domain):
+    def __init__(self):
+        super().__init__(translations.__path__[0], domain="admin")
+
+
+admin_domain = AdminDomain()
+
+gettext = admin_domain.gettext
+ngettext = admin_domain.ngettext
+lazy_gettext = admin_domain.lazy_gettext
+

flask_exts-0.1.4/src/flask_exts/babel/babel_setting.py

@@ -0,0 +1,41 @@
+from flask import request
+from flask import session
+from flask import current_app
+from flask_babel import Babel
+
+babel = Babel()
+
+
+def locale_selector():
+    if not request:
+        return
+    # save lang to session if lang exists in args
+    if request.args.get("lang"):
+        session["lang"] = request.args.get("lang")
+    # from session
+    if session.get("lang"):
+        session_lang = session.get("lang")
+        return session_lang
+    # try to guess the language from the user accept header the browser transmits.
+    if current_app.config.get("BABEL_ACCEPT_LANGUAGES"):
+        accept_languages = current_app.config["BABEL_ACCEPT_LANGUAGES"].split(";")
+        accept_language = request.accept_languages.best_match(accept_languages)
+        return accept_language
+
+
+def timezone_selector():
+    # save timezone to session if timezone exists in args
+    if request.args.get("timezone"):
+        session["timezone"] = request.args.get("timezone")
+    # from session
+    if session.get("timezone"):
+        return session.get("timezone")
+    # from app.config
+    if current_app.config.get("BABEL_DEFAULT_TIMEZONE"):
+        return current_app.config.get("BABEL_DEFAULT_TIMEZONE")
+
+
+def flask_babel_init_app(app):
+    babel.init_app(
+        app, locale_selector=locale_selector, timezone_selector=timezone_selector
+    )

flask_exts-0.1.4/src/flask_exts/babel/babel_text.py

@@ -0,0 +1,2 @@
+from .admin_babel import gettext
+gettext("Home")

flask_exts-0.1.4/src/flask_exts/form/__init__.py

@@ -0,0 +1,3 @@
+from .form import *
+from .fields import *
+from .widgets import *

flask_exts-0.1.4/src/flask_exts/form/babel.py

@@ -0,0 +1 @@
+from ..babel import gettext, ngettext

flask_exts-0.1.4/src/flask_exts/form/fields/datetime.py

@@ -0,0 +1,102 @@
+import time
+import datetime
+from wtforms import fields as wtforms_fields
+from ..widgets.datetime import DateTimePickerWidget
+from ..widgets.datetime import TimePickerWidget
+from ..babel import gettext
+
+
+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(TimeField, self).__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(gettext("Invalid time format"))
+            else:
+                self.data = None

flask_exts-0.1.4/src/flask_exts/form/fields/file.py

@@ -0,0 +1,29 @@
+from werkzeug.datastructures import FileStorage
+from wtforms import fields as wtforms_fields
+
+
+class FileField(wtforms_fields.FileField):
+    """Werkzeug-aware subclass of :class:`wtforms.fields.FileField`."""
+
+    def process_formdata(self, valuelist):
+        valuelist = (x for x in valuelist if isinstance(x, FileStorage) and x)
+        data = next(valuelist, None)
+
+        if data is not None:
+            self.data = data
+        else:
+            self.raw_data = ()
+
+
+class MultipleFileField(wtforms_fields.MultipleFileField):
+    """Werkzeug-aware subclass of :class:`wtforms.fields.MultipleFileField`.
+    """
+
+    def process_formdata(self, valuelist):
+        valuelist = (x for x in valuelist if isinstance(x, FileStorage) and x)
+        data = list(valuelist) or None
+
+        if data is not None:
+            self.data = data
+        else:
+            self.raw_data = ()

flask_exts-0.1.4/src/flask_exts/form/fields/json.py

@@ -0,0 +1,21 @@
+import json
+from wtforms.fields import TextAreaField
+from ..babel import gettext
+
+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'))
+                raise ValueError(gettext("Invalid JSON"))
+
+    def _value(self):
+        if self.data:
+            return json.dumps(self.data, ensure_ascii=False)
+        else:
+            return ""

flask_exts-0.1.4/src/flask_exts/form/fields/recaptcha.py

@@ -0,0 +1,14 @@
+from wtforms.fields import Field
+from ..widgets.recaptcha import RecaptchaWidget
+from ..validators.recaptcha import Recaptcha
+
+
+class RecaptchaField(Field):
+    widget = RecaptchaWidget()
+
+    # error message if recaptcha validation fails
+    recaptcha_error = None
+
+    def __init__(self, label="", validators=None, **kwargs):
+        validators = validators or [Recaptcha()]
+        super().__init__(label, validators, **kwargs)

flask_exts-0.1.4/src/flask_exts/form/fields/select.py

@@ -0,0 +1,123 @@
+import re
+from wtforms import fields as wtforms_fields
+from ..widgets.select import Select2Widget
+from ..widgets.select import Select2TagsWidget
+
+
+class Select2Field(wtforms_fields.SelectField):
+    """
+    `Select2 <https://github.com/ivaynberg/select2>`_ styled select widget.
+
+    You must include select2.js, form-x.x.x.js and select2 stylesheet for it to
+    work.
+    """
+
+    widget = Select2Widget()
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        coerce=str,
+        choices=None,
+        allow_blank=False,
+        blank_text=None,
+        **kwargs
+    ):
+        super(Select2Field, self).__init__(label, validators, coerce, choices, **kwargs)
+        self.allow_blank = allow_blank
+        self.blank_text = blank_text or " "
+
+    def iter_choices(self):
+        if self.allow_blank:
+            yield ("__None", self.blank_text, self.data is None)
+
+        for choice in self.choices:
+            if isinstance(choice, tuple):
+                yield (choice[0], choice[1], self.coerce(choice[0]) == self.data)
+            else:
+                yield (
+                    choice.value,
+                    choice.name,
+                    self.coerce(choice.value) == self.data,
+                )
+
+    def process_data(self, value):
+        if value is None:
+            self.data = None
+        else:
+            try:
+                self.data = self.coerce(value)
+            except (ValueError, TypeError):
+                self.data = None
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            if valuelist[0] == "__None":
+                self.data = None
+            else:
+                try:
+                    self.data = self.coerce(valuelist[0])
+                except ValueError:
+                    raise ValueError(self.gettext("Invalid Choice: could not coerce"))
+
+    def pre_validate(self, form):
+        if self.allow_blank and self.data is None:
+            return
+
+        super(Select2Field, self).pre_validate(form)
+
+
+class Select2TagsField(wtforms_fields.StringField):
+    """`Select2 <http://ivaynberg.github.com/select2/#tags>`_ styled text field.
+    You must include select2.js, form-x.x.x.js and select2 stylesheet for it to work.
+    """
+
+    widget = Select2TagsWidget()
+    _strip_regex = re.compile(
+        r"#\d+(?:(,)|\s$)"
+    )  # e.g., 'tag#123, anothertag#425 ' => 'tag, anothertag'
+
+    def __init__(
+        self,
+        label=None,
+        validators=None,
+        save_as_list=False,
+        coerce=str,
+        allow_duplicates=False,
+        **kwargs
+    ):
+        """Initialization
+
+        :param save_as_list:
+            If `True` then populate ``obj`` using list else string
+        :param allow_duplicates
+            If `True` then duplicate tags are allowed in the field.
+        """
+        self.save_as_list = save_as_list
+        self.allow_duplicates = allow_duplicates
+        self.coerce = coerce
+
+        super(Select2TagsField, self).__init__(label, validators, **kwargs)
+
+    def process_formdata(self, valuelist):
+        if valuelist:
+            entrylist = valuelist[0]
+            if self.allow_duplicates and entrylist.endswith(" "):
+                # This means this is an allowed duplicate (see form.js, `createSearchChoice`), so its ID was modified.
+                # Hence, we need to restore the original IDs.
+                entrylist = re.sub(self._strip_regex, "\\1", entrylist)
+            if self.save_as_list:
+                self.data = [
+                    self.coerce(v.strip()) for v in entrylist.split(",") if v.strip()
+                ]
+            else:
+                self.data = self.coerce(entrylist)
+
+    def _value(self):
+        if isinstance(self.data, (list, tuple)):
+            return ",".join(v for v in self.data)
+        elif self.data:
+            return self.data
+        else:
+            return ""

flask_exts-0.1.4/src/flask_exts/form/fields/taglist.py

@@ -0,0 +1,10 @@
+from wtforms import fields as wtforms_fields
+
+
+class TagListField(wtforms_fields.StringField):
+    def process_formdata(self, valuelist):
+        if valuelist:
+            self.data = [x.strip() for x in valuelist[0].split(",")]
+
+    def _value(self):
+        return ",".join(self.data) if self.data is not None else ""