lino 25.2.2__py3-none-any.whl → 25.3.0__py3-none-any.whl

lino/__init__.py

@@ -26,7 +26,7 @@ defines no models, some template files, a series of :term:`django-admin commands
 
 """
 
-__version__ = '25.2.2'
+__version__ = '25.3.0'
 
 # import setuptools  # avoid UserWarning "Distutils was imported before Setuptools"?
 
@@ -64,14 +64,19 @@ import warnings
 
 warnings.filterwarnings(
     "error",
-    "DateTimeField .* received a naive datetime (.*) while time zone support is active.",
+    r"DateTimeField .* received a naive datetime (.*) while time zone support is active.",
     RuntimeWarning,
     "django.db.models.fields",
 )
 
+# TODO: Is it okay to ignore the followgin warning? It's because e.g.
+# lino.modlib.excerpts has a pre_analyze receiver set_excerpts_actions(), which
+# accesses the database to set actions before Lino analyzes the models. It
+# catches OperationalError & Co because --of course-- it fails e.g. for
+# admin-commands like "pm prep".
 warnings.filterwarnings(
     "ignore",
-    "Accessing the database during app initialization is discouraged\. To fix this warning, avoid executing queries in AppConfig\.ready\(\) or when your app modules are imported\.",
+    r"Accessing the database during app initialization is discouraged\. To fix this warning, avoid executing queries in AppConfig\.ready\(\) or when your app modules are imported\.",
     RuntimeWarning,
     "django.db.backends.utils",
 )

lino/api/dd.py

@@ -1,7 +1,15 @@
 # -*- coding: UTF-8 -*-
-# Copyright 2011-2023 Rumma & Ko Ltd
+# Copyright 2011-2025 Rumma & Ko Ltd
 # License: GNU Affero General Public License v3 (see file COPYING for details)
 
+# from lino.modlib.linod.choicelists import background_task, schedule_often, schedule_daily
+from lino.core.roles import SiteStaff, SiteUser, SiteAdmin, login_required
+from django.utils import translation
+from importlib import import_module
+from lino.modlib.system.choicelists import Genders, PeriodEvents, YesNo
+from lino.utils.mldbc.fields import BabelCharField, LanguageField
+from lino.utils.mldbc.fields import BabelTextField
+from lino.utils.format_date import fdl as dtosl
 from lino import logger
 
 # import logging ; logger = logging.getLogger(__name__)
@@ -96,7 +104,8 @@ from lino.core.fields import CharField
 from lino.core.utils import babelkw
 
 # from lino.core.utils import babelattr
-from lino.core.utils import babel_values  # alias for babelkw for backward compat
+# alias for babelkw for backward compat
+from lino.core.utils import babel_values
 
 from lino.utils.choosers import chooser, action_chooser
 
@@ -156,18 +165,11 @@ def fds(d):
 
 # backward compatibility
 dtos = fds
-from lino.utils.format_date import fdl as dtosl
 
 babelitem = settings.SITE.babelitem
 field2kw = settings.SITE.field2kw
 # urlkwargs = settings.SITE.urlkwargs
 
-from lino.utils.mldbc.fields import BabelTextField
-from lino.utils.mldbc.fields import BabelCharField, LanguageField
-
-from lino.modlib.system.choicelists import Genders, PeriodEvents, YesNo
-
-from importlib import import_module
 
 decfmt = settings.SITE.decfmt
 str2kw = settings.SITE.str2kw
@@ -199,35 +201,9 @@ babelattr = settings.SITE.babelattr
 plugins = settings.SITE.plugins
 format_currency = settings.SITE.format_currency
 
-from django.utils import translation
 
 get_language = translation.get_language
 
-from lino.core.roles import SiteStaff, SiteUser, SiteAdmin, login_required
-
-from lino.modlib.linod.choicelists import Procedures
-
-
-def background_task(**kwargs):
-    if "class_name" not in kwargs:
-        kwargs["class_name"] = "linod.SystemTask"
-
-    def decorator(func):
-        Procedures.add_item(func, **kwargs)
-        return func
-
-    return decorator
-
-
-def schedule_often(every=10, **kwargs):
-    kwargs.update(every_unit="secondly", every=every)
-    return background_task(**kwargs)
-
-
-def schedule_daily(**kwargs):
-    kwargs.update(every_unit="daily", every=1)
-    return background_task(**kwargs)
-
 
 def auto_height(n):
     """

lino/api/doctest.py

@@ -1,28 +1,45 @@
 # -*- coding: UTF-8 -*-
-# Copyright 2015-2024 Rumma & Ko Ltd
+# Copyright 2015-2025 Rumma & Ko Ltd
 # License: GNU Affero General Public License v3 (see file COPYING for details)
 """
-A selection of names to be used in tested documents.
+A selection of names to be used in tested documents as follows:
+
+>>> from lino.api.doctest import *
+
+This is by convention everything we want to have in the global namespace of a
+tested document. It includes
+
+- well-known Python standard modules like os, sys, datetime and collections.
+- A variable :data:`test_client`
+
 """
 
+import os
+import sys
+import datetime
+import collections
 import six  # TODO: remove here and then run all doctests
 import logging
 import sqlparse
+import json
+import textwrap
+
+from bs4 import BeautifulSoup
+from pprint import pprint, pformat
 from urllib.parse import urlencode
+
 import django
 django.setup()
+
 from lino.core.constants import *
 from lino.api.shell import *
 from django.utils import translation
 from django.utils.encoding import force_str
 from django.test import Client
 from django.db import connection, reset_queries as reset_sql_queries
-import json
-from bs4 import BeautifulSoup
-import textwrap
-from pprint import pprint, pformat
 
-from rstgen import table, ul
+import pytest
+# from rstgen import table, ul
 import rstgen
 from rstgen import attrtable
 from rstgen.utils import unindent, rmu, sixprint
@@ -49,10 +66,12 @@ from lino.core.actions import register_params
 from lino.core.layouts import BaseLayout
 
 test_client = Client()
-# naming it simply "client" caused conflict with a
-# `lino_welfare.pcsw.models.Client`
+"""An instance of :class:`django.test.Client`.
 
-import collections
+N.B. Naming it simply "client" caused conflict with a
+:class:`lino_welfare.pcsw.models.Client`
+
+"""
 
 HttpQuery = collections.namedtuple(
     "HttpQuery", ["username", "url_base", "json_fields", "expected_rows", "kwargs"]
@@ -293,7 +312,7 @@ def show_workflow(actions, all=False, language=None):
                         # required_roles
                     ]
                 )
-        print(table(cols, cells).strip())
+        print(rstgen.table(cols, cells).strip())
 
     if language:
         with translation.override(language):
@@ -363,7 +382,7 @@ def fields_help(model, fieldnames=None, columns=False, all=None):
 
     # return table(cols, cells).strip()
     items = ["{} ({}) : {}".format(row[1], row[0], row[2]) for row in cells]
-    return ul(items).strip()
+    return rstgen.ul(items).strip()
 
 
 def show_fields(*args, **kwargs):
@@ -552,7 +571,7 @@ def show_choicelist(cls):
     for i in cls.get_list_items():
         row = [i.value, i.name] + str2languages(i.text)
         rows.append(row)
-    print(table(headers, rows))
+    print(rstgen.table(headers, rows))
 
 
 def show_choicelists():
@@ -568,7 +587,7 @@ def show_choicelists():
             i.verbose_name_plural
         )
         rows.append(row)
-    print(table(headers, rows))
+    print(rstgen.table(headers, rows))
 
 
 def show_permissions(*args):
@@ -590,7 +609,7 @@ def show_translations(things, fmt, languages=None):
                 x, txt = fmt(thing)
                 cells.append(txt)
         rows.append(cells)
-    print(table(headers, rows))
+    print(rstgen.table(headers, rows))
 
 
 def show_model_translations(*models, **kwargs):
@@ -779,7 +798,7 @@ def show_change_watchers():
             rows.append(
                 [full_model_name(m), ws.master_key, " ".join(sorted(ws.ignored_fields))]
             )
-    print(table(headers, rows, max_width=40))
+    print(rstgen.table(headers, rows, max_width=40))
 
 def show_display_modes():
     """
@@ -796,4 +815,17 @@ def show_display_modes():
                     ("x" if dm in a.extra_display_modes else "")
                         for dm in dml]
             )
-    print(table(headers, rows))
+    print(rstgen.table(headers, rows))
+
+
+def checkdb(m, num):
+    """
+    Raise an exception if the database doesn't contain the specified number of
+    rows of the specified model.
+
+    This is for usage in :xfile:`startup.py` scripts.
+
+    """
+    if m.objects.count() != num:
+        raise Exception(
+            f"Model {m} should have {num} rows but has {m.objects.count()}")

lino/api/selenium.py

@@ -115,7 +115,7 @@ class Tour(object):
     error_message = None
     language = None
     languages = []
-    server_url = "http://127.0.0.1:8000/"
+    server_url = "http://127.0.0.1:8000"
     images_width = 90
 
     def __init__(

lino/core/actions.py

@@ -6,6 +6,19 @@ decorator, and some of the standard actions.  See :ref:`dev.actions`.
 
 """
 
+from .utils import InstanceAction
+from .utils import traverse_ddh_fklist
+from .utils import Parametrizable
+from .utils import navinfo
+from .utils import resolve_model
+from .utils import obj2unicode
+from .permissions import Permittable
+from lino.utils.choosers import check_for_chooser
+from lino.modlib.users.utils import get_user_profile
+from lino.core import keyboard
+from lino.core import fields
+from lino.core import layouts
+from lino.core import constants
 from lino import logger
 
 from django.utils.translation import gettext_lazy as _
@@ -20,21 +33,6 @@ from django.apps import apps
 
 get_models = apps.get_models
 
-from lino.core import constants
-from lino.core import layouts
-from lino.core import fields
-from lino.core import keyboard
-from lino.modlib.users.utils import get_user_profile
-from lino.utils.choosers import check_for_chooser
-
-from .permissions import Permittable
-from .utils import obj2unicode
-from .utils import resolve_model
-from .utils import navinfo
-from .utils import Parametrizable
-from .utils import traverse_ddh_fklist
-from .utils import InstanceAction
-
 
 def discover_choosers():
     logger.debug("Discovering choosers for database fields...")
@@ -55,7 +53,8 @@ def resolve_layout(cls, k, spec, layout_class, **options):
         else:
             layout_class = settings.SITE.models.resolve(spec)
             if layout_class is None:
-                raise Exception("Unresolved {} {!r} for {}".format(k, spec, cls))
+                raise Exception(
+                    "Unresolved {} {!r} for {}".format(k, spec, cls))
             return layout_class(None, cls, **options)
     elif isinstance(spec, layouts.Panel):
         options.update(spec.options)
@@ -69,7 +68,8 @@ def resolve_layout(cls, k, spec, layout_class, **options):
                 "{}.{}.{} must be a string, " "a Panel or an instance of {} (not {!r})"
             )
             raise Exception(
-                msg.format(cls.__module__, cls.__name__, k, layout_class.__name__, spec)
+                msg.format(cls.__module__, cls.__name__,
+                           k, layout_class.__name__, spec)
             )
         if spec._datasource is None:
             spec.set_datasource(cls)
@@ -163,7 +163,7 @@ class Action(Parametrizable, Permittable):
     _params_layout_class = layouts.ActionParamsLayout
 
     label = None
-    button_text = None
+    button_text: str = None
 
     button_color = None
     """
@@ -487,7 +487,8 @@ class Action(Parametrizable, Permittable):
 
         if self.icon_name:
             if self.icon_name not in constants.ICON_NAMES:
-                raise Exception("Unkonwn icon_name '{0}'".format(self.icon_name))
+                raise Exception(
+                    "Unkonwn icon_name '{0}'".format(self.icon_name))
 
         register_params(self)
 
@@ -496,7 +497,6 @@ class Action(Parametrizable, Permittable):
                 if not c in constants.WINDOW_TYPES:
                     raise Exception(f"Invalid window_type spec {c} in {self}")
 
-
     def __get__(self, instance, owner):
         """
         When a model has an action "foo", then getting an attribute
@@ -524,7 +524,8 @@ class Action(Parametrizable, Permittable):
                 name,
                 getattr(
                     forms,
-                    mapping.get(field.__class__.__name__, field.__class__.__name__),
+                    mapping.get(field.__class__.__name__,
+                                field.__class__.__name__),
                 )(),
             )
         return LinoForm
@@ -815,7 +816,7 @@ class ShowDetail(Action):
     help_text = _("Open a detail window on this record.")
     action_name = "detail"
     label = _("Detail")
-    icon_name = "application_form"
+    # icon_name = "application_form"
     ui5_icon_name = "sap-icon://detail-view"
     opens_a_window = True
     window_type = constants.WINDOW_TYPE_DETAIL
@@ -1415,7 +1416,8 @@ class DeleteSelected(MultipleRowAction):
             d.update(type=ar.actor.model._meta.verbose_name_plural)
             if len(objects) > 10:
                 objects = objects[:9] + ["..."]
-        msg = gettext("You are about to delete %(num)d %(type)s\n(%(targets)s)") % d
+        msg = gettext(
+            "You are about to delete %(num)d %(type)s\n(%(targets)s)") % d
 
         if len(cascaded_objects):
             lst = [

lino/core/actors.py

@@ -75,7 +75,8 @@ def discover():
     actors_list = []
     actors_dict = AttrDict()
 
-    logger.debug("actors.discover() : registering %d actors", len(actor_classes))
+    logger.debug("actors.discover() : registering %d actors",
+                 len(actor_classes))
     for cls in actor_classes:
         register_actor(cls)
     actor_classes = None
@@ -751,7 +752,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         if hasattr(cls, "display_mode"):
             # cls.default_display_modes = {k:v for k, v in cls.display_mode}
             # logger.info(f"{cls} uses deprecated `display_mode`, please convert to `default_display_modes`.")
-            raise ChangedAPI(f"{cls} must convert `display_mode` to `default_display_modes`")
+            raise ChangedAPI(
+                f"{cls} must convert `display_mode` to `default_display_modes`")
 
         master = getattr(cls, "master", None)
         if isinstance(master, str):
@@ -795,6 +797,9 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
                     # cls.extra_display_modes = cls.extra_display_modes | {v}
                     edm.add(v)
 
+        if cls.hide_navigator:
+            return
+
         if cls.card_layout is not None:
             edm.add(constants.DISPLAY_MODE_CARDS)
         if 'row_as_paragraph' in cls.__dict__:
@@ -805,7 +810,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
             if model.extra_display_modes is not None:
                 for v in model.extra_display_modes:
                     if v not in constants.DISPLAY_MODES:
-                        raise Exception(f"Invalid display mode {v} in {model}.extra_display_modes")
+                        raise Exception(
+                            f"Invalid extra_display_modes mode {v} in {model}")
                 edm |= model.extra_display_modes
             if 'as_paragraph' in model.__dict__:
                 edm.add(constants.DISPLAY_MODE_LIST)
@@ -1097,14 +1103,16 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
                 cls.delete_action = cls._bind_action(
                     "delete_action", DELETE_ACTION, True
                 )
-            cls.update_action = cls._bind_action("update_action", UPDATE_ACTION, True)
+            cls.update_action = cls._bind_action(
+                "update_action", UPDATE_ACTION, True)
             if cls.detail_layout:
                 cls.validate_form = cls._bind_action(
                     "validate_form", VALIDATE_FORM, True
                 )
 
         if is_string(cls.workflow_owner_field):
-            cls.workflow_owner_field = cls.get_data_elem(cls.workflow_owner_field)
+            cls.workflow_owner_field = cls.get_data_elem(
+                cls.workflow_owner_field)
         if is_string(cls.workflow_state_field):
             # if isinstance(cls.workflow_state_field, string_types):
             fld = cls.get_data_elem(cls.workflow_state_field)
@@ -1136,7 +1144,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         da = cls.get_default_action()
         if da is not None:
             if isinstance(da, actions.Action):
-                cls.default_action = cls._bind_action("default_action", da, True)
+                cls.default_action = cls._bind_action(
+                    "default_action", da, True)
             else:
                 cls.default_action = da
 
@@ -1300,7 +1309,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         if cls.model is None:
             return False
         if not isinstance(cls.model, type):
-            raise Exception("{}.model is {!r} (must be a class)".format(cls, cls.model))
+            raise Exception(
+                "{}.model is {!r} (must be a class)".format(cls, cls.model))
         return issubclass(cls.model, fields.TableRow)
 
     @classmethod
@@ -1417,13 +1427,15 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         return format_html("<div>{}</div>", text)
 
     @classmethod
-    def override_column_headers(self, ar, **kwargs):
+    def override_column_headers(self, ar, **headers):
         """A hook to dynamically override the column headers. This has no
         effect on a GridPanel, only in printed documents or plain
         html.
 
         """
-        return kwargs
+        if self.model is None:
+            return headers
+        return self.model.override_column_headers(ar, **headers)
 
     @classmethod
     def get_sum_text(self, ar, sums):
@@ -1494,11 +1506,13 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
                 else:
                     name = "main"
                 if name in kw:
-                    raise Exception("set_detail() got two definitions for %r." % name)
+                    raise Exception(
+                        "set_detail() got two definitions for %r." % name)
                 kw[name] = dtl
             else:
                 if not isinstance(dtl, lcl):
-                    msg = "{} is neither a string nor a layout".format(type(dtl))
+                    msg = "{} is neither a string nor a layout".format(
+                        type(dtl))
                     raise Exception(msg)
                 assert dtl._datasource is None
                 # added for 20120914c but it wasn't the problem
@@ -1557,7 +1571,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
             # disabled because UsersWithClients defines virtual fields
             # on connection_created
             if name in cls.virtual_fields:
-                raise Exception("Duplicate add_virtual_field() %s.%s" % (cls, name))
+                raise Exception(
+                    "Duplicate add_virtual_field() %s.%s" % (cls, name))
         # assert vf.model is None
         # if vf.model is not None:
         #     # inherit from parent actor
@@ -1896,7 +1911,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
     @classmethod
     def get_table_as_list(cls, obj, ar):
         # raise Exception("20240316")
-        sar = cls.request(parent=ar, master_instance=obj, is_on_main_actor=False)
+        sar = cls.request(parent=ar, master_instance=obj,
+                          is_on_main_actor=False)
         grp = Grouper(sar)
         html_text = grp.begin()
         for i, obj in enumerate(sar.data_iterator):
@@ -1930,7 +1946,8 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
 
     @classmethod
     def get_table_story(cls, obj, ar):
-        sar = cls.request(parent=ar, master_instance=obj, is_on_main_actor=False)
+        sar = cls.request(parent=ar, master_instance=obj,
+                          is_on_main_actor=False)
         html = SAFE_EMPTY
         for i, obj in enumerate(sar.data_iterator):
             if i == cls.preview_limit:
@@ -1948,17 +1965,27 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         return html
 
     @classmethod
-    def get_table_summary(cls, obj, ar=None):
+    def get_slave_summary(cls, obj, ar=None):
+        """
+        :param cls: Slave table
+        :param obj: Master instance
+        :param ar: Action request on master table
+        """
+        if ar is None:
+            return ''
+        sar = cls.request(parent=ar, master_instance=obj,
+                          is_on_main_actor=False)
+        return cls.get_table_summary(sar)
+
+    @classmethod
+    def get_table_summary(cls, ar):
         """
         Return the HTML `<div>` to be displayed by
         :class:`lino.core.elems.TableSummaryPanel`.
         It basically just calls :meth:`table_as_summary`.
 
         """
-        if ar is None:
-            return ''
-        sar = cls.request(parent=ar, master_instance=obj, is_on_main_actor=False)
-        p = cls.table_as_summary(sar)
+        p = cls.table_as_summary(ar)
         # assert_safe(p)  # temporary 20240506
         # print("20240712", p)
         # return format_html(DIVTPL, p)
@@ -1981,9 +2008,9 @@ class Actor(actions.Parametrizable, Permittable, metaclass=ActorMetaClass):
         """
         p = qs2summary(
             ar,
-            ar.data_iterator,
+            ar.sliced_data_iterator,
             separator=cls.summary_sep,
-            max_items=cls.preview_limit,
+            max_items=ar.limit or cls.preview_limit,
             wraptpl=None,
         )
         # assert isinstance(p, str)
@@ -2101,7 +2128,8 @@ def resolve_action(spec, action=None):
             a = spec.get_action_by_name(action)
             # ~ print 20121210, a
             if a is None:
-                raise Exception("{} has no action named '{}'".format(spec, action))
+                raise Exception(
+                    "{} has no action named '{}'".format(spec, action))
         else:
             a = spec.default_action
             # assert a is not None
@@ -2109,4 +2137,5 @@ def resolve_action(spec, action=None):
                 raise Exception("%r default_action is None?!" % spec)
         return a
 
-    raise Exception("Action spec %r returned invalid object %r" % (givenspec, spec))
+    raise Exception("Action spec %r returned invalid object %r" %
+                    (givenspec, spec))

lino/core/choicelists.py

@@ -36,9 +36,10 @@ VALUE_FIELD.attname = "value"
 
 # @deconstructible
 class Choice(fields.TableRow):
-    """A constant value whose unicode representation depends on the
-    current language at runtime.  Every item of a :class:`ChoiceList`
-    must be an instance of :class:`Choice` or a subclass thereof.
+    """
+    A constant value whose string representation depends on the current language
+    at runtime.  Every item of a :class:`ChoiceList` must be an instance of
+    :class:`Choice` or a subclass thereof.
 
     .. attribute:: choicelist
 
@@ -478,11 +479,11 @@ class ChoiceList(with_metaclass(ChoiceListMeta, tables.AbstractTable)):
 
     old2new = {}
     """
-    A dict which maps old values to their new values.
+    A dict that maps old values to their new values.
 
-    This dict is consulted when an unknown value is read from database
-    (e.g. during a migration).  If if contains a replacement for the
-    old value, Lino will return the choice with the new value.
+    This is consulted when an unknown value is read from database (e.g. during a
+    migration).  If it contains a replacement for the old value, Lino will
+    return the choice with the new value.
     """
 
     @classmethod
@@ -1050,7 +1051,8 @@ class MultiChoiceListField(ChoiceListField):
             return []
         if isinstance(value, list):
             return value
-        value = [self.choicelist.to_python(v) for v in value.split(self.delimiter_char)]
+        value = [self.choicelist.to_python(
+            v) for v in value.split(self.delimiter_char)]
         return value
 
     def get_prep_value(self, value):

lino/core/dbtables.py

@@ -266,7 +266,7 @@ class Table(AbstractTable):
                 yield self.detail_action.request(user=user)
 
     # @classmethod
-    # def elem_filename_root(cls,elem):
+    # def elem_get_printable_target_stem(cls,elem):
     # return elem._meta.app_label + '.' + elem.__class__.__name__ + '-' + str(elem.pk)
     @classmethod
     def get_detail_sets(self):