lino 24.9.3__py3-none-any.whl → 24.10.0__py3-none-any.whl

lino/core/fields.py

@@ -321,6 +321,14 @@ class FakeField(object):
                 raise Exception("{} has no attribute {}".format(self, k))
             setattr(self, k, v)
 
+    def __repr__(self):
+        # copied from django Field
+        path = "%s.%s" % (self.__class__.__module__, self.__class__.__qualname__)
+        name = getattr(self, "name", None)
+        if name is not None:
+            return "<%s: %s>" % (path, name)
+        return "<%s>" % path
+
     def is_enabled(self, lh):
         """
         Overridden by mti.EnableChild
@@ -553,10 +561,10 @@ class VirtualField(FakeField):
     (because they inherit from that class).
     """
 
-    simple_elem = False
-    """
-    Used in :meth:`get_field_options` to set :term:`front end` rendering options.
-    """
+    # simple_elem = False
+    # """
+    # Used in :meth:`get_field_options` to set :term:`front end` rendering options.
+    # """
 
     def __init__(self, return_type, get=return_none, **kwargs):
         """
@@ -571,7 +579,7 @@ class VirtualField(FakeField):
         self.return_type = return_type  # a Django Field instance
         self.get = get
 
-        self.simple_elem = kwargs.get("simple_elem", self.simple_elem)
+        # self.simple_elem = kwargs.get("simple_elem", self.simple_elem)
 
         # if isinstance(return_type, FakeField):
         #     sortable_by = return_type.sortable_by
@@ -1209,6 +1217,12 @@ class TableRow(object):
 
     _lino_default_table = None
     _widget_options = {}
+    extra_display_modes = None
+    """
+    A set of extra display modes to make available on actors that use this model.
+
+    See :ref:`dg.dd.table.extra_display_modes`.
+    """
 
     pk = None
 
@@ -1355,7 +1369,7 @@ class TableRow(object):
         return tostring(self.as_summary_item(ar, **kwargs))
 
     def as_story_item(self, ar, **kwargs):
-        kwargs.update(display_mode="story")
+        kwargs.update(display_mode=constants.DISPLAY_MODE_STORY)
         return mark_safe("".join(self.as_page(ar, **kwargs)))
 
     def as_page(self, ar, **kwargs):

lino/core/kernel.py

@@ -877,12 +877,12 @@ class Kernel(object):
 
         if isinstance(h, tables.TableHandle):
             he = set(h.actor.hidden_columns | h.actor.hidden_elements)
-            ll = layouts.ColumnsLayout(
+            gl = layouts.ColumnsLayout(
                 h.actor.get_column_names(ar), h.actor, hidden_elements=he
             )
-            h.list_layout = ll.get_layout_handle()
+            h.grid_layout = gl.get_layout_handle()
         else:
-            h.list_layout = None
+            h.grid_layout = None
 
         if h.actor.params_layout:
             h.params_layout_handle = h.actor.make_params_layout_handle()

lino/core/model.py

@@ -937,6 +937,7 @@ LINO_MODEL_ATTRIBS = (
     "save_watched_instance",
     "save_existing_instance",
     "_widget_options",
+    "extra_display_modes",
     "set_widget_options",
     "get_widget_options",
     "get_chooser_for_field",

lino/core/renderer.py

@@ -197,7 +197,7 @@ class HtmlRenderer(Renderer):
         import rstgen
 
         if display_mode == constants.DISPLAY_MODE_CARDS:
-            layout = ar.actor.card_layout or actor.list_layout
+            layout = ar.actor.card_layout or ar.actor.list_layout
             lh = layout.get_layout_handle()
         else:
             lh = ar.bound_action.get_layout_handel()
@@ -275,14 +275,18 @@ class HtmlRenderer(Renderer):
         Silently ignores the parameters `stripped` and `header_links`
         since for HTML these options have no meaning.
         """
-        # print("20231227")
         if display_mode is None:
             display_mode = ar.actor.get_display_mode()
-        # yield E.p(display_mode)
-        if not nosummary:
-            if display_mode == constants.DISPLAY_MODE_SUMMARY:
-                yield ar.actor.get_table_summary(ar.master_instance, ar)
-                return
+            if nosummary and display_mode == constants.DISPLAY_MODE_SUMMARY:
+                display_mode = constants.DISPLAY_MODE_GRID
+        else:
+            assert display_mode in ar.actor.extra_display_modes | constants.BASIC_DISPLAY_MODES
+            if nosummary:
+                raise Exception("Both nosummary and display_mode were specified")
+
+        if display_mode == constants.DISPLAY_MODE_SUMMARY:
+            yield ar.actor.get_table_summary(ar.master_instance, ar)
+            return
 
         if header_level is not None:
             k = "h" + str(header_level)
@@ -294,6 +298,10 @@ class HtmlRenderer(Renderer):
             yield ar.actor.get_table_as_list(ar.master_instance, ar)
             return
 
+        if display_mode == constants.DISPLAY_MODE_STORY:
+            yield ar.actor.get_table_story(ar.master_instance, ar)
+            return
+
         yield ar.table2xhtml(**kwargs)
 
         # if show_toolbar:
@@ -810,7 +818,7 @@ class TextRenderer(HtmlRenderer):
         stripped=True,
         show_urls=False,
         display_mode=None,
-        **kwargs,
+        **kwargs
     ):
         """
         Render the given table request as reStructuredText to stdout.  See
@@ -819,19 +827,24 @@ class TextRenderer(HtmlRenderer):
         self.show_urls = show_urls
         if display_mode is None:
             display_mode = ar.actor.get_display_mode()
-            # display_mode = [dmi[1] for dmi in ar.actor.display_mode if dmi[0] is None][0]
-        # if ar.actor.master is not None and not nosummary:
+            if nosummary and display_mode == constants.DISPLAY_MODE_SUMMARY:
+                display_mode = constants.DISPLAY_MODE_GRID
+        else:
+            if display_mode not in ar.actor.extra_display_modes | constants.BASIC_DISPLAY_MODES:
+                raise Exception(f"Invalid display mode {display_mode} for {ar.actor}")
+            if nosummary:
+                raise Exception("Both nosummary and display_mode were specified")
+        # print(f"20240929 {nosummary} {display_mode} {ar}")
         # yield "20240506 {}".format(ar)
-        if not nosummary:
-            if display_mode == constants.DISPLAY_MODE_SUMMARY:
-                s = to_rst(
-                    ar.actor.get_table_summary(ar.master_instance, ar),
-                    stripped=stripped,
-                )
-                if stripped:
-                    s = s.strip()
-                yield s
-                return
+        if display_mode == constants.DISPLAY_MODE_SUMMARY:
+            s = to_rst(
+                ar.actor.get_table_summary(ar.master_instance, ar),
+                stripped=stripped,
+            )
+            if stripped:
+                s = s.strip()
+            yield s
+            return
 
         if display_mode == constants.DISPLAY_MODE_CARDS:
             for row in ar.sliced_data_iterator:

lino/core/requests.py

@@ -400,7 +400,7 @@ class BaseRequest(object):
             try:
                 master = ContentType.objects.get(pk=master_type).model_class()
             except ContentType.DoesNotExist:
-                raise exceptions.BadRequest("Invalid master_type {}".format(master_type))
+                raise exceptions.BadRequest("Invalid master_type {}".format(master_type)) from None
         self.master = master
 
         if self.master is not None and self.master_instance is None:
@@ -635,12 +635,14 @@ class BaseRequest(object):
         self.selected_rows = []
         for pk in selected_pks:
             if pk and pk != "-99998" and pk != "-99999":
-                obj = self.get_row_by_pk(pk)
-                if obj is None:
-                    raise exceptions.ObjectDoesNotExist(
-                        "Invalid primary key {0} for {1}".format(pk, self.actor)
-                    )
-                self.selected_rows.append(obj)
+                self.selected_rows.append(self.get_row_by_pk(pk))
+        # try:
+        #     for pk in selected_pks:
+        #         if pk and pk != "-99998" and pk != "-99999":
+        #             self.selected_rows.append(self.get_row_by_pk(pk))
+        # except ObjectDoesNotExist as e:
+        #     raise exceptions.BadRequest(
+        #         "Invalid primary key {0} for {1} ({2})".format(pk, self.actor, e)) from None
         # self.selected_rows = filter(lambda x: x, self.selected_rows)
         # note: ticket #523 was because the GET contained an empty pk ("&sr=")
 
@@ -662,11 +664,11 @@ class BaseRequest(object):
             return False
         if not self.bound_action.action.select_rows:
             return True
-        # raise Exception("20160814 {}".format(self.bound_action))
         for obj in self.selected_rows:
             # obj = self.selected_rows[0]
             state = self.bound_action.actor.get_row_state(obj)
             if not self.bound_action.get_row_permission(self, obj, state):
+                # raise Exception(f"20241001 {self.bound_action}")
                 return False
         return True
         # obj = state = None
@@ -1079,17 +1081,16 @@ class BaseRequest(object):
                     set to ``((None, DISPLAY_MODE_SUMMARY), )``,
                     force rendering it as a table.
 
-        :display_mode: override the table's :attr:`display_mode
-                       <lino.core.tables.AbstractTable.display_mode>`.
+        :display_mode: override the table's default display_mode specified by
+                       :attr:`default_display_modes <lino.core.tables.AbstractTable.default_display_modes>`.
 
                        Unlike `nosummary` this can be used to ask a summary for
                        a table that would not show as summary by default.
                        Instead of saying `nosummary=True` you can say
-                       `display_mode=((None, DISPLAY_MODE_TABLE), )` or
-                       `display_mode=((None, DISPLAY_MODE_HTML), )` (The
-                       display modes DISPLAY_MODE_TABLE and DISPLAY_MODE_HTML
-                       have the same result in a printed document or in a
-                       tested spec).
+                       `display_mode=DISPLAY_MODE_GRID` or
+                       `display_mode=DISPLAY_MODE_HTML` (The display
+                       modes DISPLAY_MODE_GRID and DISPLAY_MODE_HTML have the
+                       same result in a printed document or in a tested spec).
 
         :header_level: show also the table header (using specified level)
 
@@ -1427,9 +1428,7 @@ class BaseRequest(object):
         if ar.actor.parameters:
             rec.update(
                 param_values=ar.actor.params_layout.params_store.pv2dict(
-                    ar, ar.param_values
-                )
-            )
+                    ar, ar.param_values))
 
         return rec
 

lino/core/site.py

@@ -2061,7 +2061,7 @@ class Site(object):
         ):
             yield "social_django.middleware.SocialAuthExceptionMiddleware"
 
-        if True:
+        if False:  # removed 20240921, see #5755 (Should we remove AjaxExceptionResponse?)
             yield "lino.utils.ajax.AjaxExceptionResponse"
 
         if self.use_security_features:

lino/core/store.py

@@ -1192,7 +1192,7 @@ class Store(BaseStore):
         # temporary dict used by collect_fields and add_field_for
         # self.df2sf = {}
         self.all_fields = []
-        self.list_fields = []
+        self.grid_fields = []
         self.detail_fields = []
         self.card_fields = []
         self.item_fields = []
@@ -1202,11 +1202,11 @@ class Store(BaseStore):
             if not isinstance(sf, StoreField):
                 raise Exception("20210623 {} is not a StoreField".format(sf))
             self.all_fields.append(sf)
-            self.list_fields.append(sf)
+            self.grid_fields.append(sf)
             self.detail_fields.append(sf)
 
         if not issubclass(rh.actor, frames.Frame):
-            self.collect_fields(self.list_fields, rh.get_list_layout())
+            self.collect_fields(self.grid_fields, rh.get_grid_layout())
 
         form = rh.actor.detail_layout
         if form:
@@ -1235,7 +1235,7 @@ class Store(BaseStore):
         if self.pk is not None:
             self.pk_index = 0
             found = False
-            for fld in self.list_fields:
+            for fld in self.grid_fields:
                 """
                 Django's Field.__cmp__() does::
 
@@ -1251,8 +1251,8 @@ class Store(BaseStore):
                 self.pk_index += fld.list_values_count
             if not found:
                 raise Exception(
-                    "Primary key %r not found in list_fields %s"
-                    % (self.pk, [f.field for f in self.list_fields])
+                    "Primary key %r not found in grid_fields %s"
+                    % (self.pk, [f.field for f in self.grid_fields])
                 )
 
         actor_editable = True  # not rh.actor.hide_editing(None)
@@ -1273,14 +1273,14 @@ class Store(BaseStore):
             f for f in self.all_fields if not isinstance(f, VirtStoreField)
         ] + [f for f in self.all_fields if isinstance(f, VirtStoreField)]
         self.all_fields = tuple(self.all_fields)
-        self.list_fields = tuple(self.list_fields)
+        self.grid_fields = tuple(self.grid_fields)
         self.detail_fields = tuple(self.detail_fields)
         self.card_fields = tuple(self.card_fields)
         self.item_fields = tuple(self.item_fields)
 
     def collect_fields(self, fields, *layouts):
         """`fields` is a pointer to either `self.detail_fields` or
-        `self.list_fields`.  Each of these must contain a primary key
+        `self.grid_fields`.  Each of these must contain a primary key
         field.
 
         """
@@ -1370,7 +1370,7 @@ class Store(BaseStore):
 
     def column_names(self):
         l = []
-        for fld in self.list_fields:
+        for fld in self.grid_fields:
             l += fld.column_names()
         return l
 
@@ -1390,10 +1390,10 @@ class Store(BaseStore):
         # logger.info("20120107 Store %s row2list(%s)", self.report.model, dd.obj2str(row))
         l = []
         if isinstance(row, PhantomRow):
-            for fld in self.list_fields:
+            for fld in self.grid_fields:
                 fld.value2list(ar, None, l, row)
         else:
-            for fld in self.list_fields:
+            for fld in self.grid_fields:
                 if fld.delayed_value:
                     # self.actor.collect_extra_fields(fld)
                     v = DelayedValue(ar, fld.name, row)

lino/core/tablerequest.py

@@ -472,7 +472,7 @@ class TableRequest(ActionRequest):
         tble.attrib.update(self.renderer.tableattrs)
         tble.attrib.setdefault("name", self.bound_action.full_name())
 
-        grid = ar.ah.list_layout.main
+        grid = ar.ah.grid_layout.main
         # from lino.core.widgets import GridWidget
         # if not isinstance(grid, GridWidget):
         #     raise Exception("20160529 %r is not a GridElement", grid)
@@ -549,14 +549,14 @@ class TableRequest(ActionRequest):
                 ah = ar.actor.get_handle()
                 for i, cn in enumerate(columns):
                     col = None
-                    for e in ah.list_layout.main.columns:
+                    for e in ah.grid_layout.main.columns:
                         if e.name == cn:
                             col = e
                             break
                     if col is None:
                         raise Exception(
                             "No column named %r in %s"
-                            % (cn, ar.ah.list_layout.main.columns)
+                            % (cn, ar.ah.grid_layout.main.columns)
                         )
                     if not hiddens[i]:
                         fields.append(col)
@@ -570,8 +570,8 @@ class TableRequest(ActionRequest):
                 else:
                     ah = ar.actor.get_request_handle(ar)
 
-                    columns = ah.list_layout.main.columns
-                    # print(20160530, ah, columns, ah.list_layout.main)
+                    columns = ah.grid_layout.main.columns
+                    # print(20160530, ah, columns, ah.grid_layout.main)
 
                 # render them so that babelfields in hidden_languages
                 # get hidden:

lino/core/tables.py

@@ -1,5 +1,5 @@
 # -*- coding: UTF-8 -*-
-# Copyright 2009-2023 Rumma & Ko Ltd
+# Copyright 2009-2024 Rumma & Ko Ltd
 # License: GNU Affero General Public License v3 (see file COPYING for details)
 """Defines the classes :class:`AbstractTable` and
 :class:`VirtualTable`.
@@ -15,6 +15,7 @@ from django.db import models
 from django.db.utils import OperationalError, ProgrammingError
 from django.conf import settings
 from django.utils.translation import gettext_lazy as _
+from django.core.exceptions import BadRequest
 
 from lino.core import actors
 from lino.core import actions
@@ -114,7 +115,7 @@ class TableHandle(object):
     def setup_layouts(self):
         if self._layouts is not None:
             return
-        self._layouts = [self.list_layout]
+        self._layouts = [self.grid_layout]
 
     def get_actor_url(self, *args, **kw):
         return settings.SITE.kernel.get_actor_url(self.actor, *args, **kw)
@@ -122,12 +123,12 @@ class TableHandle(object):
     def submit_elems(self):
         return []
 
-    def get_list_layout(self):
+    def get_grid_layout(self):
         self.setup_layouts()
         return self._layouts[0]
 
     def get_columns(self):
-        lh = self.get_list_layout()
+        lh = self.get_grid_layout()
         # ~ print 20110315, layout._main.columns
         return lh.main.columns
 
@@ -315,32 +316,44 @@ class AbstractTable(actors.Actor):
     Usually such a warning means that there is something wrong.
     """
 
-    display_mode = (
-        (70, constants.DISPLAY_MODE_SUMMARY),
-        (None, constants.DISPLAY_MODE_TABLE),
-    )
+    default_display_modes = {
+        70: constants.DISPLAY_MODE_SUMMARY,
+        None: constants.DISPLAY_MODE_GRID
+    }
     """
-    A tuple of `(width, display_mode)` items used to select a :term:`display
-    mode` depending on the available width (in characters) on the client.
+    Which :term:`display mode` to use in a :term:`slave panel`,
+    depending on available width.
 
-    The last item should have a width of `None`.
-
-    See also :meth:`get_display_mode` and :ref:`dev.format`.
+    See :ref:`dg.table.default_display_modes`.
     """
 
     @classmethod
-    def get_display_mode(cls, available_width=None):
-        """Given the available width, return the :term:`display mode` to use."""
-        current_choice = (0, None)
-        for dmi in cls.display_mode:
-            if available_width is not None:
-                if dmi[0] is None and current_choice[0] == 0:
-                    current_choice = (0, dmi[1])
-                elif available_width > dmi[0] > current_choice[0]:
-                    current_choice = dmi
-            elif dmi[0] is None:
-                return dmi[1]
-        return current_choice[1]
+    # def get_display_mode(cls, available_width=None):
+    def get_display_mode(cls):
+        """Return the fallback :term:`display mode` to use."""
+        return cls.default_display_modes[None]
+        # rv = cls.default_display_modes[None]
+        # if available_width is not None:
+        #     found = None
+        #     for w, v in cls.default_display_modes.items():
+        #         if w is not None and w <= available_width:
+        #             if found is None:
+        #                 found = w
+        #                 rv = v
+        #             elif found > w:
+        #                 found = w
+        #                 rv = v
+        # return rv
+        # current_choice = (0, None)
+        # for dmi in cls.display_mode:
+        #     if available_width is not None:
+        #         if dmi[0] is None and current_choice[0] == 0:
+        #             current_choice = (0, dmi[1])
+        #         elif available_width > dmi[0] > current_choice[0]:
+        #             current_choice = dmi
+        #     elif dmi[0] is None:
+        #         return dmi[1]
+        # return current_choice[1]
 
     max_render_depth = 2
     """
@@ -613,6 +626,7 @@ method in order to sort the rows of the queryset.
                     logger.warning(msg)
                     # raise Exception(msg)
                     # raise PermissionDenied(msg)
+                    # raise BadRequest(msg)
                     # master_instance = None
                     return  # cannot add rows to this table
             kw[self.master_field.name] = master_instance

lino/mixins/dupable.py

@@ -266,7 +266,7 @@ DupableChecker.activate()
 class SimilarObjects(dd.VirtualTable):
     """Shows the other objects that are similar to this one."""
 
-    display_mode = ((None, constants.DISPLAY_MODE_SUMMARY),)
+    default_display_modes = {None: constants.DISPLAY_MODE_SUMMARY}
     master = dd.Model
     abstract = True
 

lino/modlib/checkdata/models.py

@@ -180,7 +180,7 @@ class MessagesByOwner(Messages):
 
     master_key = "owner"
     column_names = "message checker user #fixable *"
-    display_mode = ((None, constants.DISPLAY_MODE_SUMMARY),)
+    default_display_modes = {None: constants.DISPLAY_MODE_SUMMARY}
 
 
 # This was the first use case of a slave table with something else than a model

lino/modlib/comments/mixins.py

@@ -51,7 +51,7 @@ class AddCommentField(dd.VirtualField):
     """
 
     editable = True
-    simple_elem = True
+    # simple_elem = True
 
     def __init__(self, slave_table):
         t = models.TextField(_("Add comment"), blank=True)
@@ -94,7 +94,7 @@ class Commentable(MemoReferrable):
 
     create_comment_template = _("Created new {model} {obj}.")
 
-    add_comment = AddCommentField("comments.CommentsByRFC")
+    # add_comment = AddCommentField("comments.CommentsByRFC")
 
     def on_commented(self, comment, ar, cw):
         pass