clinicedc 2.0.39__py3-none-any.whl → 2.0.41__py3-none-any.whl

edc_dashboard/url_config.py

@@ -17,25 +17,44 @@ if TYPE_CHECKING:
     class View(UrlRequestContextMixin, BaseView): ...
 
 
+class UrlConfigError(Exception):
+    pass
+
+
 class UrlConfig:
+    """A class to generate url_patterns for edc DashboardViews,
+    ListBoardViews and SubjectReviewDashboardView.
+
+    * registers the url_with_namespace to `url_names`
+    * The pretty url uses the `url_names_key` less the '_url' suffix
+    * the url pattern name is the same as the given `url_names_key`
+
+    """
+
     def __init__(
         self,
         *,
-        url_name: str,
+        url_names_key: str,
         namespace: str,
         view_class: type[View | UrlRequestContextMixin],
-        label: str,
         identifier_label: str,
         identifier_pattern: str,
     ):
+        if not url_names_key.endswith("_url"):
+            raise UrlConfigError(
+                f"Invalid `url_names_key`. Must end with '_url'. Got {url_names_key}."
+            )
+        self.url_pattern_name = url_names_key
+        self.url_pretty_label = url_names_key.replace("_url", "")
+        self.view_class = view_class
         self.identifier_label = identifier_label
         self.identifier_pattern = identifier_pattern
-        self.label = label
-        self.url_name = url_name
-        self.view_class = view_class
 
-        # register {urlname, namespace:urlname} with url_names
-        url_names.register(url=self.url_name, namespace=namespace)
+        # register with url_names dictionary / registry
+        url_names.register(
+            key=url_names_key,
+            url_with_namespace=f"{namespace}:{self.url_pattern_name}",
+        )
 
     @property
     def dashboard_urls(self) -> list[URLPattern]:
@@ -49,13 +68,13 @@ class UrlConfig:
                 r"(?P<visit_code>\w+)/"
                 r"(?P<unscheduled>\w+)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/"
@@ -64,13 +83,13 @@ class UrlConfig:
                 r"(?P<schedule_name>\w+)/"
                 r"(?P<visit_code>\w+)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/"
@@ -79,14 +98,14 @@ class UrlConfig:
                 r"(?P<scanning>\d)/"
                 r"(?P<error>\d)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                         uuid_pattern=UUID_PATTERN.pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/"
@@ -94,52 +113,52 @@ class UrlConfig:
                 "(?P<appointment>{uuid_pattern})/"
                 r"(?P<reason>\w+)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                         uuid_pattern=UUID_PATTERN.pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/"
                 "(?P<{identifier_label}>{identifier_pattern})/"
                 "(?P<appointment>{uuid_pattern})/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                         uuid_pattern=UUID_PATTERN.pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/"
                 "(?P<{identifier_label}>{identifier_pattern})/"
                 r"(?P<schedule_name>\w+)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/(?P<{identifier_label}>{identifier_pattern})/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
         ]
 
@@ -154,34 +173,34 @@ class UrlConfig:
                 "{label}/(?P<{identifier_label}>{identifier_pattern})/"
                 r"(?P<page>\d+)/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
                 "{label}/(?P<{identifier_label}>{identifier_pattern})/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
-                r"{label}/(?P<page>\d+)/".format(**dict(label=self.label)),
+                r"{label}/(?P<page>\d+)/".format(**dict(label=self.url_pretty_label)),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
             re_path(
-                r"{label}/".format(**dict(label=self.label)),
+                r"{label}/".format(**dict(label=self.url_pretty_label)),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             ),
         ]
 
@@ -192,14 +211,14 @@ class UrlConfig:
                 "{label}/(?P<{identifier_label}>{identifier_pattern})/"
                 "(?P<appointment>{uuid_pattern})/".format(
                     **dict(
-                        label=self.label,
+                        label=self.url_pretty_label,
                         identifier_label=self.identifier_label,
                         identifier_pattern=self.identifier_pattern,
                         uuid_pattern=UUID_PATTERN.pattern,
                     )
                 ),
                 self.view_class.as_view(),
-                name=self.url_name,
+                name=self.url_pattern_name,
             )
         ]
         url_patterns.extend(self.listboard_urls)

edc_dashboard/url_names.py

@@ -16,35 +16,41 @@ class UrlNames:
     registry: dict[str, str] = field(default_factory=dict)
 
     def register(
-        self, name: str | None = None, url: str | None = None, namespace: str | None = None
+        self,
+        key: str,
+        namespace: str | None = None,
+        url: str | None = None,
+        url_with_namespace: str | None = None,
     ) -> None:
-        name = name or url
-        complete_url = f"{namespace}:{url}" if namespace else url
-        if name in self.registry:
-            raise AlreadyRegistered(f"Url already registered. Got {complete_url}.")
-        self.registry.update({name: complete_url})
+        url_with_namespace = url_with_namespace or f"{namespace}:{url}"
+        if key in self.registry:
+            raise AlreadyRegistered(
+                "Url already registered with url_names. "
+                f"See {key}:{self.registry[key]}. Got {url_with_namespace}."
+            )
+        self.registry.update({key: url_with_namespace})
 
     def register_from_dict(self, **urldata: str) -> None:
-        for name, complete_url in urldata.items():
+        for key, url_with_namespace in urldata.items():
             try:
-                namespace, url = complete_url.split(":")
+                namespace, url = url_with_namespace.split(":")
             except ValueError:
-                namespace, url = complete_url, None
-            self.register(name=name, url=url, namespace=namespace)
+                namespace, url = url_with_namespace, None
+            self.register(key, namespace, url=url)
 
     def all(self) -> dict[str, str]:
         return self.registry
 
-    def get(self, name: str) -> str:
-        if name not in self.registry:
+    def get(self, key: str) -> str:
+        if key not in self.registry:
             raise InvalidDashboardUrlName(
-                f"Invalid dashboard url name. Expected one of {self.registry.keys()}. "
-                f"Got '{name}'."
+                f"Invalid key for url_names. Expected one of {self.registry.keys()}. "
+                f"Got '{key}'."
             )
-        return self.registry.get(name)
+        return self.registry.get(key)
 
-    def get_or_raise(self, name: str) -> str:
-        return self.get(name)
+    def get_or_raise(self, key: str) -> str:
+        return self.get(key)
 
 
 url_names = UrlNames()

edc_dashboard/utils.py

@@ -5,14 +5,14 @@ from django.conf import settings
 from django.template.loader import select_template
 
 
-class EdcTemplateDoesNotExist(Exception):
+class EdcTemplateDoesNotExist(Exception):  # noqa: N818
     pass
 
 
 def get_index_page() -> int:
     index_page = getattr(settings, "INDEX_PAGE", None)
     if not index_page:
-        warn("Settings attribute not set. See settings.INDEX_PAGE")
+        warn("Settings attribute not set. See settings.INDEX_PAGE", stacklevel=2)
     return getattr(settings, "INDEX_PAGE", None)
 
 
@@ -44,8 +44,8 @@ def select_edc_template(relative_path, default_app_label):
     default_path = default_app_label
     return select_template(
         [
-            os.path.join(local_path, relative_path),
-            os.path.join(default_path, relative_path),
+            str(os.path.join(local_path, relative_path)),  # noqa: PTH118
+            str(os.path.join(default_path, relative_path)),  # noqa: PTH118
         ]
     )
 

edc_dashboard/view_mixins/template_request_context_mixin.py

@@ -1,6 +1,3 @@
-from typing import Any
-
-
 class TemplateRequestContextError(Exception):
     pass
 
@@ -13,10 +10,10 @@ class TemplateRequestContextMixin:
             return [self.get_template_from_context(self.listboard_template)]
     """
 
-    def get_context_data(self, **kwargs) -> dict[str, Any]:
-        """Adds template data to context."""
-        kwargs.update(self.request.template_data)
-        return super().get_context_data(**kwargs)
+    # def get_context_data(self, **kwargs) -> dict[str, Any]:
+    #     """Adds template data to context."""
+    #     kwargs.update(self.request.template_data)
+    #     return super().get_context_data(**kwargs)
 
     def get_template_from_context(self, key=None):
         """Returns a template_name from request.context_data."""
@@ -26,5 +23,5 @@ class TemplateRequestContextMixin:
             raise TemplateRequestContextError(
                 f"Template name not defined in request context data. "
                 f"Expected one of {list(self.request.template_data.keys())}. Got {e}. "
-            )
+            ) from e
         return template_name

edc_dashboard/view_mixins/url_request_context_mixin.py

@@ -6,7 +6,6 @@ from edc_protocol.research_protocol_config import ResearchProtocolConfig
 from edc_utils.text import convert_from_camel
 
 from ..url_config import UrlConfig
-from ..url_names import InvalidDashboardUrlName, url_names
 
 if TYPE_CHECKING:
     from django.urls import URLPattern
@@ -23,45 +22,58 @@ class UrlRequestContextMixin:
     urlconfig_label = None
     url_name = None
 
-    @classmethod
-    def get_urlname(cls):
-        return cls.url_name
+    # @classmethod
+    # def get_urlname(cls):
+    #     return cls.url_name
 
     @classmethod
     def urls(
         cls,
         *,
-        label: str,
-        identifier_pattern: str,
-        namespace: str | None = None,
+        namespace: str,
+        url_names_key: str,
         identifier_label: str | None = None,
+        identifier_pattern: str | None = None,
     ) -> list[URLPattern]:
-        label = (
-            label
+        """Returns a list of url patterns generated by UrlConfig.
+
+        Each url pattern has the same name; `cls.url_name`.
+        """
+        url_names_key = (
+            url_names_key
             or cls.urlconfig_label
             or convert_from_camel(cls.__name__.replace("view", "")).lower()
         )
         urlconfig = UrlConfig(
-            url_name=cls.get_urlname(),
-            namespace=namespace,
             view_class=cls,
-            label=label,
+            namespace=namespace,
+            url_names_key=url_names_key,
             identifier_label=identifier_label or cls.urlconfig_identifier_label,
             identifier_pattern=identifier_pattern or cls.urlconfig_identifier_pattern,
         )
+        if cls.urlconfig_getattr not in [
+            "dashboard_urls",
+            "listboard_urls",
+            "review_listboard_urls",
+        ]:
+            raise UrlRequestContextError(
+                f"Invalid urlconfig attr. Got {cls.urlconfig_getattr}."
+            )
         return getattr(urlconfig, cls.urlconfig_getattr)
 
-    @staticmethod
-    def add_url_to_context(new_key=None, existing_key=None) -> dict[str, str]:
-        """Add url as new_key to the context using the value
-        of the existing_key from request.context_data.
-        """
-        try:
-            url_data = {new_key: url_names.get(existing_key)}
-        except InvalidDashboardUrlName as e:
-            raise UrlRequestContextError(
-                f"Url name not defined in url_names. "
-                f"Expected one of {url_names.registry}. Got {e}. "
-                f"Hint: check if dashboard middleware is loaded."
-            ) from e
-        return url_data
+    # @staticmethod
+    # def add_url_to_context(new_key=None, existing_key=None) -> dict[str, str]:
+    #     """Add url as new_key to the context using the value
+    #     of the existing_key from request.context_data.
+    #     """
+    #     if new_key != existing_key:
+    #         try:
+    #             url_data = {new_key: url_names.get(existing_key)}
+    #         except InvalidDashboardUrlName as e:
+    #             raise UrlRequestContextError(
+    #                 f"Url name not defined in url_names. "
+    #                 f"Expected one of {url_names.registry}. Got {e}. "
+    #                 f"Hint: check if dashboard middleware is loaded."
+    #             ) from e
+    #         return url_data
+    #     return {existing_key: url_names.get(existing_key)}

edc_dashboard/views/administration_view.py

@@ -1,5 +1,5 @@
+from django.conf import settings
 from django.views.generic import TemplateView
-
 from edc_navbar import NavbarViewMixin
 
 from ..view_mixins import AdministrationViewMixin, EdcViewMixin
@@ -7,4 +7,4 @@ from ..view_mixins import AdministrationViewMixin, EdcViewMixin
 
 class AdministrationView(EdcViewMixin, NavbarViewMixin, AdministrationViewMixin, TemplateView):
     navbar_selected_item = "administration"
-    navbar_name = "default"  # settings.APP_NAME
+    navbar_name = getattr(settings, "APP_NAME", "default")

edc_dashboard/views/dashboard_view.py

@@ -8,7 +8,7 @@ from ..view_mixins import TemplateRequestContextMixin, UrlRequestContextMixin
 
 
 class DashboardView(UrlRequestContextMixin, TemplateRequestContextMixin, TemplateView):
-    dashboard_url_name = None
+    dashboard_url_name = None  # see url_names dictionary
     dashboard_template = None  # may be None if `dashboard_template_name` is defined
     dashboard_template_name = None  # may be None if `dashboard_template` is defined
 
@@ -31,15 +31,10 @@ class DashboardView(UrlRequestContextMixin, TemplateRequestContextMixin, Templat
         return url_names.get(self.dashboard_url_name)
 
     def get_template_names(self):
-        if self.dashboard_template_name:
-            return [self.dashboard_template_name]
-        return [self.get_template_from_context(self.dashboard_template)]
+        if self.dashboard_template:
+            return [self.dashboard_template]
+        return [self.get_template_from_context(self.dashboard_template_name)]
 
     def get_context_data(self, **kwargs) -> dict[str, Any]:
-        kwargs.update(
-            **self.add_url_to_context(
-                new_key="dashboard_url_name",
-                existing_key=self.dashboard_url_name,
-            )
-        )
+        kwargs.update(**{self.dashboard_url_name: url_names.get(self.dashboard_url_name)})
         return super().get_context_data(**kwargs)

edc_data_manager/handlers/handlers.py

@@ -1,3 +1,8 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import TYPE_CHECKING
+
 import arrow
 from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist
@@ -15,6 +20,12 @@ from edc_visit_tracking.utils import (
 from ..constants import AUTO_RESOLVED
 from ..models import DataQuery
 
+if TYPE_CHECKING:
+    from edc_registration.models import RegisteredSubject
+    from edc_visit_schedule.visit_schedule import VisitSchedule
+
+    from ..models import QueryRule
+
 
 class QueryRuleHandlerError(Exception):
     pass
@@ -57,11 +68,12 @@ class QueryRuleHandler:
 
     def __init__(
         self,
-        query_rule_obj=None,
-        registered_subject=None,
-        visit_schedule_obj=None,
-        visit_code_sequence=None,
-        now=None,
+        *,
+        query_rule_obj: QueryRule,
+        registered_subject: RegisteredSubject,
+        visit_schedule_obj: VisitSchedule,
+        now: datetime,
+        visit_code_sequence: int | None = None,
     ):
         self._field_values = {}
         self._model_obj = None

edc_data_manager/migrations/0043_alter_historicalqueryrule_comment_and_more.py

@@ -0,0 +1,51 @@
+# Generated by Django 5.2.7 on 2025-10-24 04:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("edc_data_manager", "0042_alter_datadictionary_revision_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="historicalqueryrule",
+            name="comment",
+            field=models.TextField(blank=True, default=""),
+        ),
+        migrations.AlterField(
+            model_name="historicalqueryrule",
+            name="query_text",
+            field=models.TextField(
+                blank=True,
+                default="",
+                help_text="Generic query text for auto-generated queries.",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="historicalqueryrule",
+            name="reference_model",
+            field=models.CharField(default="", editable=False, max_length=150),
+        ),
+        migrations.AlterField(
+            model_name="queryrule",
+            name="comment",
+            field=models.TextField(blank=True, default=""),
+        ),
+        migrations.AlterField(
+            model_name="queryrule",
+            name="query_text",
+            field=models.TextField(
+                blank=True,
+                default="",
+                help_text="Generic query text for auto-generated queries.",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="queryrule",
+            name="reference_model",
+            field=models.CharField(default="", editable=False, max_length=150),
+        ),
+    ]

edc_data_manager/models/query_rule.py

@@ -7,7 +7,7 @@ from django.db import models
 from django.db.models.deletion import PROTECT
 from django.template.loader import render_to_string
 
-from edc_constants.constants import NORMAL
+from edc_constants.constants import NORMAL, NULL_STRING
 from edc_model.models import BaseUuidModel, HistoricalRecords
 from edc_visit_schedule.constants import DAYS, HOURS, MONTHS, WEEKS
 
@@ -31,7 +31,7 @@ class QueryRuleManager(models.Manager):
 def get_rule_handler_choices(model_name=None):
     choices = []
     for rule_handler in site_data_manager.get_rule_handlers(model_name=model_name):
-        choices.append((rule_handler.name, rule_handler.display_name))
+        choices.append((rule_handler.name, rule_handler.display_name))  # noqa: PERF401
     return tuple(choices) or (
         (DEFAULT_RULE_HANDLER, DEFAULT_RULE_HANDLER.replace("_", " ").title()),
     )
@@ -105,7 +105,7 @@ class QueryRule(BaseUuidModel):
 
     title = models.CharField(max_length=150, unique=True)
 
-    reference_model = models.CharField(max_length=150, null=True, editable=False)
+    reference_model = models.CharField(max_length=150, default=NULL_STRING, editable=False)
 
     sender = models.ForeignKey(
         DataManagerUser,
@@ -152,7 +152,7 @@ class QueryRule(BaseUuidModel):
 
     query_text = models.TextField(
         help_text="Generic query text for auto-generated queries.",
-        null=True,
+        default=NULL_STRING,
         blank=True,
     )
 
@@ -192,7 +192,7 @@ class QueryRule(BaseUuidModel):
 
     reference = models.CharField(max_length=36, default=uuid4, unique=True)
 
-    comment = models.TextField(null=True, blank=True)
+    comment = models.TextField(default=NULL_STRING, blank=True)
 
     objects = QueryRuleManager()
 
@@ -209,13 +209,13 @@ class QueryRule(BaseUuidModel):
     def natural_key(self):
         return (self.title,)
 
-    natural_key.dependencies = [
+    natural_key.dependencies = (
         "edc_data_manager.CrfDataDictionary",
         "edc_data_manager.DataManagerUser",
         "edc_data_manager.QueryUser",
         "edc_data_manager.queryvisitschedule",
         "edc_data_manager.RequisitionPanel",
-    ]
+    )
 
     @property
     def rendered_query_text(self) -> str:

edc_data_manager/navbar_item.py

@@ -5,5 +5,5 @@ dm_navbar_item = NavbarItem(
     title="Data Management",
     label="DM",
     codename="edc_data_manager.nav_data_manager_section",
-    url_name="edc_data_manager:home_url",
+    url_with_namespace="edc_data_manager:home_url",
 )

edc_data_manager/rule/query_rule_wrapper.py

@@ -87,7 +87,7 @@ class QueryRuleWrapper:
         return getattr(
             self.subject_identifiers,
             "all",
-            lambda: [{"subject_identifier": s for s in self.subject_identifiers}],
+            lambda: [{"subject_identifier": s} for s in self.subject_identifiers],
         )
 
     @staticmethod

edc_data_manager/rule/rule_runner.py

@@ -21,7 +21,7 @@ class RuleRunner:
     def __init__(
         self,
         query_rule_obj: QueryRule = None,
-        now: datetime = None,
+        now: datetime | None = None,
         verbose: bool | None = None,
     ):
         self.query_rule_obj = query_rule_obj  # query rule model instance
@@ -55,11 +55,11 @@ class RuleRunner:
 
     def run_one(
         self,
-        subject_identifier: str = None,
-        visit_schedule_name: str = None,
-        schedule_name: str = None,
-        visit_code: str = None,
-        timepoint: Decimal = None,
+        subject_identifier: str,
+        visit_schedule_name: str,
+        schedule_name: str,
+        visit_code: str,
+        timepoint: Decimal,
     ):
         visit_schedule_obj = QueryVisitSchedule.objects.get(
             visit_schedule_name=visit_schedule_name,