flask-construct-ui 0.12.1__tar.gz → 0.12.2__tar.gz

{flask_construct_ui-0.12.1 → flask_construct_ui-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flask-construct-ui
-Version: 0.12.1
+Version: 0.12.2
 Summary: A UI toolkit for Flask with CRUD and component features.
 Author-email: Olof Tjerngren <olof@tjerngren.net>
 License-Expression: LGPL-3.0-or-later

{flask_construct_ui-0.12.1 → flask_construct_ui-0.12.2}/flask_construct_ui/grid.py

@@ -36,6 +36,8 @@ import decimal
 import enum
 from typing import Any
 
+import markupsafe
+
 from . import schema as schema_mod
 from .data import query as data_query
 from .forms import validate_form_data
@@ -365,6 +367,13 @@ def cell_text(field, name, row):
     """The text a cell displays. Always plain text — never markup: a cell
     holds user data, and rendering it as markup would be stored XSS on every
     page that embeds the grid."""
+    if field.has_display_filter():
+        value = field.display_value(name, row, "grid")
+        if isinstance(value, markupsafe.Markup):
+            # A filter's markup is meant for HTML surfaces; a grid cell keeps
+            # only its text.
+            return value.striptags()
+        return "" if value is None else str(value)
     if field.field_type == "bool":
         return "✓" if getattr(row, name, None) else ""
     value = field.format_value(name, row)

{flask_construct_ui-0.12.1 → flask_construct_ui-0.12.2}/flask_construct_ui/schema.py

@@ -3,6 +3,27 @@ import datetime
 from .validation import ValidationError, parse_rule
 
 
+class DisplayContext:
+    """What a display filter gets alongside the value it is formatting.
+
+    One object rather than more positional arguments, so later additions
+    don't break filters apps have already written.
+
+    ``surface`` says where the value is being shown: ``"list"`` (the CRUD
+    list), ``"related"`` (a related-records tab), ``"view"`` (a read-only
+    field on the view or edit page), ``"inline"`` (a row of a list field) or
+    ``"grid"`` (a data grid cell, which is plain text only).
+    """
+
+    __slots__ = ("row", "name", "field", "surface")
+
+    def __init__(self, row, name, field, surface):
+        self.row = row
+        self.name = name
+        self.field = field
+        self.surface = surface
+
+
 class SchemaField:
     def __init__(self, field_type, name, **kwargs):
         self.field_type = field_type
@@ -26,6 +47,8 @@ class SchemaField:
         # only replaces the generic "Enter <field>" hint and vanishes on input.
         self.placeholder = kwargs.get("placeholder", None)
         self.help = kwargs.get("help", None)
+        # Display-only filter, ``fn(value, ctx)`` — see ``display_value``.
+        self.display = kwargs.get("display", None)
         self.kwargs = kwargs
         matches = kwargs.get("matches", None)
         self._matches_fn = None
@@ -61,8 +84,52 @@ class SchemaField:
         return 'required aria-required="true"' if self.required else ""
 
     def format_value(self, field, row):
+        """The stored value, as a form control or editor is filled with it.
+
+        This feeds ``value="…"`` attributes as well as read-only text, so it
+        must never return markup. To change only how a value *reads*, use a
+        display filter — see ``display_value``.
+        """
         return getattr(row, field)
 
+    def _display_filter(self):
+        if self.display is not None:
+            return self.display
+        from flask import has_app_context, current_app
+
+        if has_app_context():
+            filters = current_app.config.get("CONSTRUCT_DISPLAY_FILTERS") or {}
+            return filters.get(self.field_type)
+        return None
+
+    def has_display_filter(self):
+        """Whether ``display_value`` differs from ``format_value`` here.
+
+        Templates check this before their built-in per-type rendering (check
+        icons, badges, …), so a filter can restyle any field type, while
+        fields without one render exactly as before.
+        """
+        if type(self).display_value is not SchemaField.display_value:
+            return True
+        return self._display_filter() is not None
+
+    def display_value(self, field, row, surface="list"):
+        """The value as it is shown — never typed — in lists, related tabs,
+        read-only views and grid cells.
+
+        Resolved, most specific first: the field's ``display=`` callable, the
+        app's ``CONSTRUCT_DISPLAY_FILTERS[field_type]``, then ``format_value``
+        unchanged. A filter is called as ``fn(value, ctx)`` with the
+        ``format_value`` result and a :class:`DisplayContext`. It may return
+        ``markupsafe.Markup`` for intentional HTML; anything else is escaped.
+        Subclasses may override this for full control.
+        """
+        value = self.format_value(field, row)
+        fn = self._display_filter()
+        if fn is None:
+            return value
+        return fn(value, DisplayContext(row, field, self, surface))
+
     def parse_value(self, value):
         return value
 

{flask_construct_ui-0.12.1 → flask_construct_ui-0.12.2}/flask_construct_ui/static/css/whitelabel.css

@@ -820,6 +820,12 @@ a:hover {
   padding: var(--fcu-table-cell-padding-y) var(--fcu-table-cell-padding-x);
   border-bottom: 1px solid var(--fcu-border);
 }
+/* List cells carry fcu-cell--<field_type> and data-field="<name>", so an app
+   can style a column without a display filter. A date breaking at its hyphens
+   in a narrow column reads as two values. */
+.fcu-cell--date, .fcu-cell--datetime {
+  white-space: nowrap;
+}
 .fcu-table th {
   background-color: var(--fcu-table-header-bg);
   font-weight: var(--fcu-font-weight-semibold);