WuttaWeb 0.20.0__tar.gz → 0.20.2__tar.gz

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to wuttaweb will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v0.20.2 (2025-01-14)
+
+### Fix
+
+- improve support for composite `model_key` in MasterView
+- let content header text be a bit longer
+- add optional `target` attr for GridAction
+- add `render_date()` method for grids
+
+## v0.20.1 (2025-01-13)
+
+### Fix
+
+- expose setting to choose menu handler, in appinfo/configure
+- use prop key instead of column name, for master view model key
+- add grid filters specific to numeric, integer types
+- use default value for config settings
+
 ## v0.20.0 (2025-01-11)
 
 ### Feat

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.20.0
+Version: 0.20.2
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -39,7 +39,7 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.20.0
+Requires-Dist: wuttjamaican[db]>=0.20.1
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.20.0"
+version = "0.20.2"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -44,7 +44,7 @@ dependencies = [
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.20.0",
+        "WuttJamaican[db]>=0.20.1",
         "zope.sqlalchemy>=1.5",
 ]
 
@@ -70,6 +70,9 @@ wuttaweb = "wuttaweb.conf:WuttaWebConfigExtension"
 [project.entry-points."wutta.typer_imports"]
 wuttaweb = "wuttaweb.cli"
 
+[project.entry-points."wutta.web.menus"]
+wuttaweb = "wuttaweb.menus:MenuHandler"
+
 
 [project.urls]
 Homepage = "https://wuttaproject.org/"

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/grids/base.py

@@ -602,6 +602,7 @@ class Grid:
         * ``'batch_id'`` -> :meth:`render_batch_id()`
         * ``'boolean'`` -> :meth:`render_boolean()`
         * ``'currency'`` -> :meth:`render_currency()`
+        * ``'date'`` -> :meth:`render_date()`
         * ``'datetime'`` -> :meth:`render_datetime()`
         * ``'quantity'`` -> :meth:`render_quantity()`
 
@@ -611,6 +612,7 @@ class Grid:
             'batch_id': self.render_batch_id,
             'boolean': self.render_boolean,
             'currency': self.render_currency,
+            'date': self.render_date,
             'datetime': self.render_datetime,
             'quantity': self.render_quantity,
         }
@@ -631,11 +633,13 @@ class Grid:
         data type implies a default renderer.  This is only possible
         if :attr:`model_class` is set to a SQLAlchemy mapped class.
 
-        This only looks for a couple of data types, and configures as
+        This only looks for a few data types, and configures as
         follows:
 
         * :class:`sqlalchemy:sqlalchemy.types.Boolean` ->
           :meth:`render_boolean()`
+        * :class:`sqlalchemy:sqlalchemy.types.Date` ->
+          :meth:`render_date()`
         * :class:`sqlalchemy:sqlalchemy.types.DateTime` ->
           :meth:`render_datetime()`
         """
@@ -651,7 +655,9 @@ class Grid:
                 prop = getattr(attr, 'prop', None)
                 if prop and isinstance(prop, orm.ColumnProperty):
                     column = prop.columns[0]
-                    if isinstance(column.type, sa.DateTime):
+                    if isinstance(column.type, sa.Date):
+                        self.set_renderer(key, self.render_date)
+                    elif isinstance(column.type, sa.DateTime):
                         self.set_renderer(key, self.render_datetime)
                     elif isinstance(column.type, sa.Boolean):
                         self.set_renderer(key, self.render_boolean)
@@ -1820,7 +1826,7 @@ class Grid:
         This may be used automatically per
         :meth:`set_default_renderers()` or you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_boolean)
+            grid.set_renderer('foo', 'boolean')
         """
         return self.app.render_boolean(value)
 
@@ -1839,6 +1845,22 @@ class Grid:
         """
         return self.app.render_currency(value, **kwargs)
 
+    def render_date(self, obj, key, value):
+        """
+        Column renderer for :class:`python:datetime.date` values.
+
+        This calls
+        :meth:`~wuttjamaican:wuttjamaican.app.AppHandler.render_date()`
+        for the return value.
+
+        This may be used automatically per
+        :meth:`set_default_renderers()` or you can use it explicitly::
+
+            grid.set_renderer('foo', 'date')
+        """
+        dt = getattr(obj, key)
+        return self.app.render_date(dt)
+
     def render_datetime(self, obj, key, value):
         """
         Column renderer for :class:`python:datetime.datetime` values.
@@ -1850,7 +1872,7 @@ class Grid:
         This may be used automatically per
         :meth:`set_default_renderers()` or you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_datetime)
+            grid.set_renderer('foo', 'datetime')
         """
         dt = getattr(obj, key)
         return self.app.render_datetime(dt)
@@ -1865,7 +1887,7 @@ class Grid:
 
         This is not used automatically but you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_quantity)
+            grid.set_renderer('foo', 'quantity')
         """
         return self.app.render_quantity(value)
 
@@ -2258,6 +2280,10 @@ class GridAction:
 
        See also :meth:`get_url()`.
 
+    .. attribute:: target
+
+       Optional ``target`` attribute for the ``<a>`` tag.
+
     .. attribute:: icon
 
        Name of icon to be shown for the action link.
@@ -2275,6 +2301,7 @@ class GridAction:
             key,
             label=None,
             url=None,
+            target=None,
             icon=None,
             link_class=None,
     ):
@@ -2283,6 +2310,7 @@ class GridAction:
         self.app = self.config.get_app()
         self.key = key
         self.url = url
+        self.target = target
         self.label = label or self.app.make_title(key)
         self.icon = icon or key
         self.link_class = link_class or ''

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/grids/filters.py

@@ -465,6 +465,33 @@ class StringAlchemyFilter(AlchemyFilter):
             sa.and_(*criteria)))
 
 
+class NumericAlchemyFilter(AlchemyFilter):
+    """
+    SQLAlchemy filter option for a numeric data column.
+
+    Subclass of :class:`AlchemyFilter`.
+    """
+    default_verbs = ['equal', 'not_equal',
+                     'greater_than', 'greater_equal',
+                     'less_than', 'less_equal']
+
+
+class IntegerAlchemyFilter(NumericAlchemyFilter):
+    """
+    SQLAlchemy filter option for an integer data column.
+
+    Subclass of :class:`NumericAlchemyFilter`.
+    """
+
+    def coerce_value(self, value):
+        """ """
+        if value:
+            try:
+                return int(value)
+            except:
+                pass
+
+
 class BooleanAlchemyFilter(AlchemyFilter):
     """
     SQLAlchemy filter option for a boolean data column.
@@ -568,6 +595,8 @@ default_sqlalchemy_filters = {
     None: AlchemyFilter,
     sa.String: StringAlchemyFilter,
     sa.Text: StringAlchemyFilter,
+    sa.Numeric: NumericAlchemyFilter,
+    sa.Integer: IntegerAlchemyFilter,
     sa.Boolean: BooleanAlchemyFilter,
     sa.Date: DateAlchemyFilter,
 }

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/handler.py

@@ -24,7 +24,10 @@
 Web Handler
 """
 
+import warnings
+
 from wuttjamaican.app import GenericHandler
+from wuttjamaican.util import load_entry_points
 
 from wuttaweb import static, forms, grids
 
@@ -106,22 +109,87 @@ class WebHandler(GenericHandler):
 
     def get_menu_handler(self, **kwargs):
         """
-        Get the configured "menu" handler for the web app.
+        Get the configured :term:`menu handler` for the web app.
 
         Specify a custom handler in your config file like this:
 
         .. code-block:: ini
 
            [wutta.web]
-           menus.handler_spec = poser.web.menus:PoserMenuHandler
+           menus.handler.spec = poser.web.menus:PoserMenuHandler
 
         :returns: Instance of :class:`~wuttaweb.menus.MenuHandler`.
         """
-        if not hasattr(self, 'menu_handler'):
-            spec = self.config.get(f'{self.appname}.web.menus.handler_spec',
-                                   default='wuttaweb.menus:MenuHandler')
-            self.menu_handler = self.app.load_object(spec)(self.config)
-        return self.menu_handler
+        spec = self.config.get(f'{self.appname}.web.menus.handler.spec')
+        if not spec:
+            spec = self.config.get(f'{self.appname}.web.menus.handler_spec')
+            if spec:
+                warnings.warn(f"setting '{self.appname}.web.menus.handler_spec' is deprecated; "
+                              f"please use '{self.appname}.web.menus.handler_spec' instead",
+                              DeprecationWarning)
+            else:
+                spec = self.config.get(f'{self.appname}.web.menus.handler.default_spec',
+                                       default='wuttaweb.menus:MenuHandler')
+        factory = self.app.load_object(spec)
+        return factory(self.config)
+
+    def get_menu_handler_specs(self, default=None):
+        """
+        Get the :term:`spec` strings for all available :term:`menu
+        handlers <menu handler>`.  See also
+        :meth:`get_menu_handler()`.
+
+        :param default: Default spec string(s) to include, even if not
+           registered.  Can be a string or list of strings.
+
+        :returns: List of menu handler spec strings.
+
+        This will gather available spec strings from the following:
+
+        First, the ``default`` as provided by caller.
+
+        Second, the default spec from config, if set; for example:
+
+        .. code-block:: ini
+
+           [wutta.web]
+           menus.handler.default_spec = poser.web.menus:PoserMenuHandler
+
+        Third, each spec registered via entry points.  For instance in
+        ``pyproject.toml``:
+
+        .. code-block:: toml
+
+           [project.entry-points."wutta.web.menus"]
+           poser = "poser.web.menus:PoserMenuHandler"
+
+        The final list will be "sorted" according to the above, with
+        the latter registered handlers being sorted alphabetically.
+        """
+        handlers = []
+
+        # defaults from caller
+        if isinstance(default, str):
+            handlers.append(default)
+        elif default:
+            handlers.extend(default)
+
+        # configured default, if applicable
+        default = self.config.get(f'{self.config.appname}.web.menus.handler.default_spec')
+        if default and default not in handlers:
+            handlers.append(default)
+
+        # registered via entry points
+        registered = []
+        for Handler in load_entry_points(f'{self.appname}.web.menus').values():
+            spec = Handler.get_spec()
+            if spec not in handlers:
+                registered.append(spec)
+        if registered:
+            registered.sort()
+            handlers.extend(registered)
+
+        return handlers
 
     def make_form(self, request, **kwargs):
         """

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/templates/appinfo/configure.mako

@@ -41,6 +41,21 @@
       </b-checkbox>
     </b-field>
 
+    <b-field label="Menu Handler">
+      <input type="hidden"
+             name="${app.appname}.web.menus.handler.spec"
+             :value="simpleSettings['${app.appname}.web.menus.handler.spec']" />
+      <b-select v-model="simpleSettings['${app.appname}.web.menus.handler.spec']"
+                @input="settingsNeedSaved = true">
+        <option :value="null">(use default)</option>
+        <option v-for="handler in menuHandlers"
+                :key="handler.spec"
+                :value="handler.spec">
+          {{ handler.spec }}
+        </option>
+      </b-select>
+    </b-field>
+
   </div>
 
   <h3 class="block is-size-3">User/Auth</h3>
@@ -241,6 +256,8 @@
   ${parent.modify_vue_vars()}
   <script>
 
+    ThisPageData.menuHandlers = ${json.dumps(menu_handlers)|n}
+
     ThisPageData.weblibs = ${json.dumps(weblibs or [])|n}
 
     ThisPageData.editWebLibraryShowDialog = false

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/templates/base.mako

@@ -155,7 +155,7 @@
     }
 
     #content-title h1 {
-        max-width: 80%;
+        max-width: 85%;
         overflow: hidden;
         padding-left: 0.5rem;
         text-overflow: ellipsis;

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/templates/grids/vue_template.mako

@@ -180,6 +180,9 @@
             % for action in grid.actions:
                 <a v-if="props.row._action_url_${action.key}"
                    :href="props.row._action_url_${action.key}"
+                   % if action.target:
+                       target="${action.target}"
+                   % endif
                    class="${action.link_class}">
                   ${action.render_icon_and_label()}
                 </a>

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/views/master.py

@@ -1224,7 +1224,7 @@ class MasterView(View):
                 elif simple.get('type') is bool:
                     value = self.config.get_bool(name, default=simple.get('default', False))
                 else:
-                    value = self.config.get(name)
+                    value = self.config.get(name, default=simple.get('default'))
 
                 normalized[name] = value
 
@@ -2176,6 +2176,28 @@ class MasterView(View):
         """
         return str(instance) or "(no title)"
 
+    def get_action_route_kwargs(self, obj):
+        """
+        Get a dict of route kwargs for the given object.
+
+        This is called from :meth:`get_action_url()` and must return
+        kwargs suitable for use with ``request.route_url()``.
+
+        In practice this should return a dict which has keys for each
+        field from :meth:`get_model_key()` and values which come from
+        the object.
+
+        :param obj: Model instance object.
+
+        :returns: The dict of route kwargs for the object.
+        """
+        try:
+            return dict([(key, obj[key])
+                         for key in self.get_model_key()])
+        except TypeError:
+            return dict([(key, getattr(obj, key))
+                         for key in self.get_model_key()])
+
     def get_action_url(self, action, obj, **kwargs):
         """
         Generate an "action" URL for the given model instance.
@@ -2183,22 +2205,21 @@ class MasterView(View):
         This is a shortcut which generates a route name based on
         :meth:`get_route_prefix()` and the ``action`` param.
 
-        It returns the URL based on generated route name and object's
-        model key values.
+        It calls :meth:`get_action_route_kwargs()` and then passes
+        those along with route name to ``request.route_url()``, and
+        returns the result.
 
         :param action: String name for the action, which corresponds
            to part of some named route, e.g. ``'view'`` or ``'edit'``.
 
         :param obj: Model instance object.
+
+        :param \**kwargs: Additional kwargs to be passed to
+           ``request.route_url()``, if needed.
         """
-        route_prefix = self.get_route_prefix()
-        try:
-            kw = dict([(key, obj[key])
-                       for key in self.get_model_key()])
-        except TypeError:
-            kw = dict([(key, getattr(obj, key))
-                       for key in self.get_model_key()])
+        kw = self.get_action_route_kwargs(obj)
         kw.update(kwargs)
+        route_prefix = self.get_route_prefix()
         return self.request.route_url(f'{route_prefix}.{action}', **kw)
 
     def get_action_url_view(self, obj, i):
@@ -2707,6 +2728,9 @@ class MasterView(View):
         represents a Wutta-based SQLAlchemy model, the return value
         for this method is: ``('uuid',)``
 
+        Any class mapped via SQLAlchemy should be supported
+        automatically, the keys are determined from class inspection.
+
         But there is no "sane" default for other scenarios, in which
         case subclass should define :attr:`model_key`.  If the model
         key cannot be determined, raises ``AttributeError``.
@@ -2721,8 +2745,12 @@ class MasterView(View):
 
         model_class = cls.get_model_class()
         if model_class:
-            mapper = sa.inspect(model_class)
-            return tuple([column.key for column in mapper.primary_key])
+            # nb. we want the primary key but must avoid column names
+            # in case mapped class uses different prop keys
+            inspector = sa.inspect(model_class)
+            keys = [col.name for col in inspector.primary_key]
+            return tuple([prop.key for prop in inspector.column_attrs
+                          if all([col.name in keys for col in prop.columns])])
 
         raise AttributeError(f"you must define model_key for view class: {cls}")
 

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/src/wuttaweb/views/settings.py

@@ -129,6 +129,10 @@ class AppInfoView(MasterView):
             {'name': f'{self.config.appname}.node_title'},
             {'name': f'{self.config.appname}.production',
              'type': bool},
+            {'name': f'{self.config.appname}.web.menus.handler.spec'},
+            # nb. this is deprecated; we define so it is auto-deleted
+            # when we replace with newer setting
+            {'name': f'{self.config.appname}.web.menus.handler_spec'},
 
             # user/auth
             {'name': 'wuttaweb.home_redirect_to_login',
@@ -164,11 +168,15 @@ class AppInfoView(MasterView):
 
     def configure_get_context(self, **kwargs):
         """ """
-
-        # normal context
         context = super().configure_get_context(**kwargs)
 
-        # we will add `weblibs` to context, based on config values
+        # add registered menu handlers
+        web = self.app.get_web_handler()
+        handlers = web.get_menu_handler_specs()
+        handlers = [{'spec': spec} for spec in handlers]
+        context['menu_handlers'] = handlers
+
+        # add `weblibs` to context, based on config values
         weblibs = self.get_weblibs()
         for key in weblibs:
             title = weblibs[key]
@@ -192,8 +200,8 @@ class AppInfoView(MasterView):
                 'live_url': get_liburl(self.request, key,
                                        prefix=self.weblib_config_prefix),
             }
-
         context['weblibs'] = list(weblibs.values())
+
         return context
 
 

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/tests/grids/test_base.py

@@ -213,7 +213,7 @@ class TestGrid(WebTestCase):
         obj = MagicMock(foo=42.00)
         self.assertEqual(grid.renderers['foo'](obj, 'foo', 42.00), '42')
 
-    def test_set_default_renderer(self):
+    def test_set_default_renderers(self):
         model = self.app.model
 
         # no defaults for "plain" schema
@@ -249,6 +249,18 @@ class TestGrid(WebTestCase):
         self.assertIn('executing', grid.renderers)
         self.assertIs(grid.renderers['executing'], myrender)
 
+        # nb. as of writing we have no Date columns in default schema,
+        # so must invent one to test that type
+        class SomeFoolery(model.Base):
+            __tablename__ = 'somefoolery'
+            id = sa.Column(sa.Integer(), primary_key=True)
+            created = sa.Column(sa.Date())
+
+        # renderer set for date mapped field
+        grid = self.make_grid(model_class=SomeFoolery)
+        self.assertIn('created', grid.renderers)
+        self.assertIsNot(grid.renderers['created'], myrender)
+
     def test_linked_columns(self):
         grid = self.make_grid(columns=['foo', 'bar'])
         self.assertEqual(grid.linked_columns, [])
@@ -1415,6 +1427,20 @@ class TestGrid(WebTestCase):
         # zero is *not* empty string (with this renderer)
         self.assertEqual(grid.render_quantity(obj, 'foo', 0), "0")
 
+    def test_render_date(self):
+        grid = self.make_grid(columns=['foo', 'bar'])
+
+        # null
+        obj = MagicMock(dt=None)
+        result = grid.render_date(obj, 'dt', None)
+        self.assertIsNone(result)
+
+        # typical
+        dt = datetime.date(2025, 1, 13)
+        obj = MagicMock(dt=dt)
+        result = grid.render_date(obj, 'dt', str(dt))
+        self.assertEqual(result, '2025-01-13')
+
     def test_render_datetime(self):
         grid = self.make_grid(columns=['foo', 'bar'])
 

{wuttaweb-0.20.0 → wuttaweb-0.20.2}/tests/grids/test_filters.py

@@ -326,6 +326,30 @@ class TestStringAlchemyFilter(WebTestCase):
         self.assertEqual(filtered_query.count(), 6)
 
 
+class TestIntegerAlchemyFilter(WebTestCase):
+
+    def make_filter(self, model_property, **kwargs):
+        factory = kwargs.pop('factory', mod.IntegerAlchemyFilter)
+        kwargs['model_property'] = model_property
+        return factory(self.request, model_property.key, **kwargs)
+
+    def test_coerce_value(self):
+        model = self.app.model
+        filtr = self.make_filter(model.Upgrade.exit_code)
+
+        # null
+        self.assertIsNone(filtr.coerce_value(None))
+        self.assertIsNone(filtr.coerce_value(''))
+
+        # typical
+        self.assertEqual(filtr.coerce_value('42'), 42)
+        self.assertEqual(filtr.coerce_value('-42'), -42)
+
+        # invalid
+        self.assertIsNone(filtr.coerce_value('42.12'))
+        self.assertIsNone(filtr.coerce_value('bogus'))
+
+
 class TestBooleanAlchemyFilter(WebTestCase):
 
     def setUp(self):