clinicedc 2.0.38__py3-none-any.whl → 2.0.40__py3-none-any.whl

edc_metadata/metadata_rules/rule.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import contextlib
+from collections.abc import Callable
 from typing import TYPE_CHECKING
 
 from edc_appointment.constants import MISSED_APPT
@@ -28,9 +29,9 @@ class Rule:
 
     def __init__(
         self,
-        predicate: P | PF | callable | str = None,
-        consequence: str = None,
-        alternative: str = None,
+        predicate: P | PF | Callable | str,
+        consequence: str,
+        alternative: str,
     ) -> None:
         self.predicate = predicate
         self.consequence = consequence

edc_metadata/metadata_rules/rule_group.py

@@ -11,7 +11,7 @@ class RuleGroupError(Exception):
     pass
 
 
-class TargetModelConflict(Exception):
+class TargetModelConflict(Exception):  # noqa: N818
     pass
 
 
@@ -61,7 +61,7 @@ class RuleGroup:
                         )
 
     @classmethod
-    def _lookup_model(cls, model: str = None, category: str = None) -> Any:
+    def _lookup_model(cls, model: str, category: str) -> Any:
         sys.stdout.write(f"  ( ) {model}\r")
         model_cls = None
         try:

edc_metadata/metadata_rules/rule_group_meta_options.py

@@ -42,13 +42,13 @@ class RuleGroupMetaOptions:
         # source model
         self.source_model = self.options.get("source_model")
         if self.source_model:
-            if len(self.source_model.split(".")) != 2:
+            if len(self.source_model.split(".")) != 2:  # noqa: PLR2004
                 self.source_model = f"{self.app_label}.{self.source_model}"
             self.options.update(source_model=self.source_model)
         # related visit model
         self.related_visit_model = self.options.get("related_visit_model")
         if self.related_visit_model:
-            if len(self.related_visit_model.split(".")) != 2:
+            if len(self.related_visit_model.split(".")) != 2:  # noqa: PLR2004
                 raise RuleGroupMetaError(
                     "Invalid _meta attr. Expected _meta.related_visit_model to be in "
                     f"label_lower format. Got '{self.related_visit_model}'. See {group_name}."

edc_metadata/metadata_rules/rule_group_metaclass.py

@@ -51,7 +51,7 @@ class RuleGroupMetaclass(type):
         return super().__new__(mcs, name, bases, attrs)
 
     @classmethod
-    def __get_rules(mcs, name: str, attrs: dict, meta: Any) -> tuple:
+    def __get_rules(mcs, name: str, attrs: dict, meta: Any) -> tuple:  # noqa: N804
         """Returns a list of rules after updating each rule's attrs
         with values from Meta.
 
@@ -59,28 +59,27 @@ class RuleGroupMetaclass(type):
         """
         rules = []
         for key, value in attrs.items():
-            if not key.startswith("_"):
-                if isinstance(value, Rule):
-                    rule = value
-                    rule.name = key
-                    rule.group = name
-                    if isinstance(rule.predicate, (str,)):
-                        predicates = getattr(meta, "predicates", None)
-                        if not predicates:
-                            raise RuleGroupError(
-                                "RuleGroup Meta attr `predicates` may not be `None` if a "
-                                "rule.predicate in the RuleGroup is a string. "
-                                f"See {attrs.get('__qualname__')}."
-                            )
-                        rule.predicate = getattr(meta.predicates, rule.predicate)
-                    for k, v in meta.options.items():
-                        setattr(rule, k, v)
-                    rule.target_models = mcs.__get_target_models(rule, meta)
-                    rules.append(rule)
+            if not key.startswith("_") and isinstance(value, Rule):
+                rule = value
+                rule.name = key
+                rule.group = name
+                if isinstance(rule.predicate, (str,)):
+                    predicates = getattr(meta, "predicates", None)
+                    if not predicates:
+                        raise RuleGroupError(
+                            "RuleGroup Meta attr `predicates` may not be `None` if a "
+                            "rule.predicate in the RuleGroup is a string. "
+                            f"See {attrs.get('__qualname__')}."
+                        )
+                    rule.predicate = getattr(meta.predicates, rule.predicate)
+                for k, v in meta.options.items():
+                    setattr(rule, k, v)
+                rule.target_models = mcs.__get_target_models(rule, meta)
+                rules.append(rule)
         return tuple(rules)
 
     @classmethod
-    def __get_target_models(mcs, rule: Any, meta: Any) -> Any:
+    def __get_target_models(mcs, rule: Any, meta: Any) -> Any:  # noqa: N804
         """Returns target models as a list of label_lowers.
 
         Target models are the models whose metadata is acted upon.
@@ -90,7 +89,7 @@ class RuleGroupMetaclass(type):
         """
         target_models = []
         for target_model in rule.target_models:
-            if len(target_model.split(".")) != 2:
-                target_model = f"{meta.app_label}.{target_model}"
+            if len(target_model.split(".")) != 2:  # noqa: PLR2004
+                target_model = f"{meta.app_label}.{target_model}"  # noqa: PLW2901
             target_models.append(target_model)
         return target_models

edc_metadata/metadata_rules/site.py

@@ -9,7 +9,7 @@ from django.utils.module_loading import import_module, module_has_submodule
 style = color_style()
 
 
-class SiteMetadataRulesAlreadyRegistered(Exception):
+class SiteMetadataRulesAlreadyRegistered(Exception):  # noqa: N818
     pass
 
 

edc_metadata/metadata_updater.py

@@ -31,8 +31,9 @@ class MetadataUpdater(SourceModelMetadataMixin):
 
     def __init__(
         self,
-        related_visit: RelatedVisitModel = None,
-        source_model: str = None,
+        *,
+        related_visit: RelatedVisitModel,
+        source_model: str,
         allow_create: bool | None = None,
     ):
         super().__init__(source_model, related_visit)
@@ -46,7 +47,7 @@ class MetadataUpdater(SourceModelMetadataMixin):
             f"source_model={self.source_model})"
         )
 
-    def get_and_update(self, entry_status: str = None) -> CrfMetadata | RequisitionMetadata:
+    def get_and_update(self, entry_status: str) -> CrfMetadata | RequisitionMetadata:
         metadata_obj = self.metadata_handler.metadata_obj
         if entry_status != KEYED and self.source_model_obj_exists:
             entry_status = KEYED

edc_metadata/model_mixins/creates/creates_metadata_model_mixin.py

@@ -43,10 +43,9 @@ class CreatesMetadataModelMixin(RelatedVisitProtocol, models.Model):
 
         Also called by post_save signal after metadata is updated.
         """
-        metadata_rule_evaluator = self.metadata_rule_evaluator_cls(
+        return self.metadata_rule_evaluator_cls(
             related_visit=self, allow_create=allow_create
-        )
-        metadata_rule_evaluator.evaluate_rules()
+        ).evaluate_rules()
 
     @property
     def metadata_query_options(self) -> dict[str, Any]:
@@ -54,14 +53,13 @@ class CreatesMetadataModelMixin(RelatedVisitProtocol, models.Model):
         the related_visit.
         """
         visit: Visit = self.visits.get(self.appointment.visit_code)
-        options = dict(
+        return dict(
             visit_schedule_name=self.appointment.visit_schedule_name,
             schedule_name=self.appointment.schedule_name,
             visit_code=visit.code,
             visit_code_sequence=self.appointment.visit_code_sequence,
             timepoint=self.appointment.timepoint,
         )
-        return options
 
     @property
     def crf_metadata(self):

edc_metadata/model_mixins/updates/updates_metadata_model_mixin.py

@@ -42,7 +42,7 @@ class UpdatesMetadataModelMixin(models.Model):
     metadata_updater_cls = MetadataUpdater
     metadata_category: str = CRF
 
-    def metadata_update(self: CrfModel | RequisitionModel, entry_status: str = None) -> None:
+    def metadata_update(self: CrfModel | RequisitionModel, entry_status: str) -> None:
         """Updates metatadata."""
         self.metadata_updater.get_and_update(entry_status=entry_status)
 

edc_metadata/next_form_getter.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import contextlib
 from typing import TYPE_CHECKING
 
 from django.apps import apps as django_apps
@@ -10,6 +11,7 @@ from .metadata import CrfMetadataGetter, RequisitionMetadataGetter
 
 if TYPE_CHECKING:
     from edc_appointment.models import Appointment
+    from edc_model.utils import CrfLikeModel
     from edc_visit_schedule.visit import Crf, Requisition, Visit
 
     from .metadata import MetadataGetter
@@ -22,10 +24,10 @@ class NextFormGetter:
 
     def __init__(
         self,
-        model_obj=None,
-        appointment: Appointment = None,
-        model: str = None,
-        panel_name: str = None,
+        model_obj: CrfLikeModel | None = None,
+        appointment: Appointment | None = None,
+        model: str | None = None,
+        panel_name: str | None = None,
     ):
         self._getter = None
         self._next_metadata_obj = None
@@ -58,7 +60,7 @@ class NextFormGetter:
         """
         if not self._model_obj:
             model_cls = django_apps.get_model(self.model)
-            try:
+            with contextlib.suppress(ObjectDoesNotExist):
                 self._model_obj = model_cls.objects.get(
                     **{
                         f"{model_cls.related_visit_model_attr()}__appointment": (
@@ -66,8 +68,6 @@ class NextFormGetter:
                         )
                     }
                 )
-            except ObjectDoesNotExist:
-                pass
         return self._model_obj
 
     @property
@@ -94,23 +94,19 @@ class NextFormGetter:
 
     @property
     def next_panel(self) -> str | None:
-        if not self._next_panel:
-            if self.next_metadata_obj:
-                try:
-                    self._next_panel = self.next_metadata_obj.panel_name
-                except AttributeError:
-                    pass
+        if not self._next_panel and self.next_metadata_obj:
+            with contextlib.suppress(AttributeError):
+                self._next_panel = self.next_metadata_obj.panel_name
         return self._next_panel
 
     @property
     def panel_name(self) -> str | None:
         """Returns a panel_name or None."""
-        if not self._panel_name:
-            if self.model_obj:
-                try:
-                    self._panel_name = self.model_obj.panel.name
-                except AttributeError:
-                    self._panel_name = None
+        if not self._panel_name and self.model_obj:
+            try:
+                self._panel_name = self.model_obj.panel.name
+            except AttributeError:
+                self._panel_name = None
         return self._panel_name
 
     @property

edc_metadata/offline_models.py

@@ -8,6 +8,6 @@ offline_models = []
 app_config = django_apps.get_app_config("edc_metadata")
 for model in app_config.get_models():
     if not issubclass(model, ListModelMixin):
-        offline_models.append(model._meta.label_lower)
+        offline_models.append(model._meta.label_lower)  # noqa: PERF401
 
 site_offline_models.register(offline_models, OfflineModel)

edc_metadata/requisition/requisition_metadata_handler.py

@@ -21,24 +21,24 @@ class RequisitionMetadataHandler(MetadataHandler):
         super().__init__(**kwargs)
         self.panel = panel
 
-    def _create(self, exception_msg: str | None = None) -> RequisitionMetadata:
+    def _create(self) -> RequisitionMetadata:
         """Returns a created RequisitionMetadata model instance for this
         requisition.
         """
         metadata_obj = None
         try:
-            requisition_object = [
+            requisition_object = next(
                 requisition
                 for requisition in self.creator.related_visit.visit.all_requisitions
                 if requisition.panel.name == self.panel.name
-            ][0]
-        except IndexError as e:
+            )
+        except StopIteration as e:
             if self.related_visit.reason != MISSED_VISIT:
                 raise MetadataHandlerError(
                     "Panel not found. Not in visit.all_requisitions. "
                     f"Panel `{self.panel}` at `{self.creator.related_visit.visit}`. "
                     f"Got {e}. Check your visit schedule."
-                )
+                ) from e
         else:
             metadata_obj = self.creator.create_requisition(requisition_object)
         return metadata_obj

edc_metadata/update_metadata_on_schedule_change.py

@@ -33,13 +33,11 @@ class UpdateMetadataOnScheduleChange:
                 f"value for field '{self.fieldname}'.\n"
                 f"Old value='{self.old_value}', New value='{self.new_value}'.\n"
             )
-            for name, model_cls in self.models.items():
+            for model_cls in self.models.values():
                 count = model_cls.objects.filter(**{self.fieldname: self.old_value}).count()
                 sys.stdout.write(f"{model_cls._meta.label_lower}. {count} records found.\n")
             sys.stdout.write(
-                style.ERROR(
-                    "No records have been updated. \n" "Set --dry-run=False to update.\n"
-                )
+                style.ERROR("No records have been updated. \nSet --dry-run=False to update.\n")
             )
         else:
             sys.stdout.write(style.SUCCESS("Updating... \n"))

edc_metadata/utils.py

@@ -39,7 +39,7 @@ if TYPE_CHECKING:
         schedule_name: str
 
 
-class HasKeyedMetadata(Exception):
+class HasKeyedMetadata(Exception):  # noqa: N818
     pass
 
 

edc_model/models/signals.py

@@ -1,4 +1,7 @@
+import contextlib
+
 from django import dispatch
+from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import expressions
 from simple_history import signals
 
@@ -17,12 +20,14 @@ def remove_f_expressions(sender, instance, history_instance, **kwargs) -> None:
     """
     f_expression_fields = []
     for field in history_instance._meta.fields:
-        field_value = getattr(history_instance, field.name)
+        with contextlib.suppress(ObjectDoesNotExist):
+            field_value = getattr(history_instance, field.name)
         if isinstance(field_value, expressions.BaseExpression):
             f_expression_fields.append(field.name)
 
     if f_expression_fields:
         instance.refresh_from_db()
         for field_name in f_expression_fields:
-            field_value = getattr(instance, field_name)
+            with contextlib.suppress(ObjectDoesNotExist):
+                field_value = getattr(instance, field_name)
             setattr(history_instance, field_name, field_value)

edc_model_admin/mixins/model_admin_redirect_on_delete_mixin.py

@@ -6,7 +6,6 @@ from django.contrib import messages
 from django.http.response import HttpResponseRedirect
 from django.urls import reverse
 from django.utils.encoding import force_str
-
 from edc_dashboard.url_names import InvalidDashboardUrlName, url_names
 
 
@@ -75,8 +74,10 @@ class ModelAdminRedirectOnDeleteMixin:
         """Overridden to redirect to `post_url_on_delete`, if not None."""
         if self.post_url_on_delete:
             opts = self.model._meta
-            msg = (f'The {force_str(opts.verbose_name)} "{force_str(obj_display)}" '
-                   'was deleted successfully.')
+            msg = (
+                f'The {force_str(opts.verbose_name)} "{force_str(obj_display)}" '
+                "was deleted successfully."
+            )
             messages.add_message(request, messages.SUCCESS, msg)
             return HttpResponseRedirect(self.post_url_on_delete)
         return super().response_delete(request, obj_display, obj_id)

edc_navbar/apps.py

@@ -1,5 +1,4 @@
 from django.apps import AppConfig as DjangoAppConfig
-from django.conf import settings
 from django.core.management.color import color_style
 
 style = color_style()
@@ -9,4 +8,3 @@ class AppConfig(DjangoAppConfig):
     name = "edc_navbar"
     verbose_name = "Edc Navbar"
     register_default_navbar = True
-    default_navbar_name = getattr(settings, "DEFAULT_NAVBAR_NAME", "default")

edc_navbar/navbar.py

@@ -30,7 +30,7 @@ class Navbar:
     def get(self, name: str) -> NavbarItem | None:
         try:
             navbar_item = next(nb for nb in self.navbar_items if nb.name == name)
-        except IndexError:
+        except StopIteration:
             navbar_item = None
         return navbar_item
 

edc_navbar/navbar_item.py

@@ -6,7 +6,6 @@ from typing import TYPE_CHECKING
 from django.core.management.color import color_style
 from django.urls import NoReverseMatch
 from django.urls.base import reverse
-
 from edc_dashboard.url_names import InvalidDashboardUrlName, url_names
 
 if TYPE_CHECKING:
@@ -23,10 +22,13 @@ class NavbarItem:
     title: str = field(default=None)
     label: str | None = field(default=None)
     codename: str = field(default=None)
-    url_name: str = field(default=None)
-    no_url_namespace: bool = field(default=None)
+    url_names_key: str | None = field(
+        default=None
+    )  # must be valid key in url_names dictionary
+    url_with_namespace: str | None = field(default=None)
+    url_without_namespace: str | None = field(default=None)
     fa_icon: str | None = field(default=None)
-    disabled: str = field(default="disabled")
+    disabled: str | None = field(default="disabled")
 
     active: bool = field(default=None)
 
@@ -37,24 +39,35 @@ class NavbarItem:
 
     def __post_init__(self):
         self.title = self.title or self.label or self.name.title()  # the anchor title
+        if self.url_with_namespace and ":" not in self.url_with_namespace:
+            raise InvalidDashboardUrlName(
+                f"Invalid url_with_namespace. Got {self.url_with_namespace}"
+            )
 
     def get_url(self, raise_exception: bool | None = None) -> str | None:
+        url = (
+            self.url_without_namespace
+            or self.url_with_namespace
+            or url_names.get(self.url_names_key)
+        )
         try:
-            url = reverse(self.real_url_name)
-        except NoReverseMatch:
-            url = None
+            url = reverse(url)
+        except NoReverseMatch as e:
             if raise_exception:
-                raise
+                errmsg = (
+                    f"Reverse for Navbar url not found. Tried {url}. "
+                    f"See NavbarItem(name={self.name}"
+                )
+                if self.url_without_namespace == url:
+                    errmsg = f"{errmsg}, url_without_namespace={self.url_without_namespace})."
+                elif self.url_with_namespace == url:
+                    errmsg = f"{errmsg}, url_with_namespace={self.url_with_namespace})."
+                elif url_names.get(self.url_names_key) == url:
+                    errmsg = f"{errmsg}, url_names_key={self.url_names_key})."
+                raise NoReverseMatch(errmsg) from e
+            url = None
         return url
 
-    @property
-    def real_url_name(self) -> str:
-        try:
-            url_name = url_names.get(self.url_name)
-        except InvalidDashboardUrlName:
-            url_name = self.url_name.split(":")[1] if self.no_url_namespace else self.url_name
-        return url_name
-
     def set_disabled(self, user: User | None = None):
         if user and user.has_perm(self.codename):
             self.disabled = ""

edc_navbar/navbars.py

@@ -1,20 +1,17 @@
-from django.apps import apps as django_apps
-
 from .navbar import Navbar
 from .navbar_item import NavbarItem
 from .site_navbars import site_navbars
+from .utils import get_default_navbar_name, get_register_default_navbar
 
-app_config = django_apps.get_app_config("edc_navbar")
-
-if app_config.register_default_navbar:
-    default_navbar = Navbar(name=app_config.default_navbar_name)
+if get_register_default_navbar():
+    default_navbar = Navbar(name=get_default_navbar_name())
 
     default_navbar.register(
         NavbarItem(
             name="home",
             title="Home",
             fa_icon="fa-home",
-            url_name="home_url",
+            url_without_namespace="home_url",
             codename="edc_navbar.nav_home",
         )
     )
@@ -25,19 +22,9 @@ if app_config.register_default_navbar:
             title="Administration",
             fa_icon="fa-cog",
             codename="edc_navbar.nav_administration",
-            url_name="administration_url",
+            # url_names_key="administration",
+            url_without_namespace="administration_url",
         )
     )
 
-    # remove to use a form. See edc_navbar.html
-    # default_navbar.register(
-    #     NavbarItem(
-    #         name="logout",
-    #         title="Logout",
-    #         fa_icon="fa-sign-out-alt",
-    #         url_name="edc_auth_admin:logout",
-    #         codename="edc_navbar.nav_logout",
-    #     )
-    # )
-
     site_navbars.register(default_navbar)

edc_navbar/site_navbars.py

@@ -44,16 +44,16 @@ class NavbarCollection:
             navbar_name=name,
         )
 
-    def get_navbar(self, name: str = None, selected_item: str = None) -> Navbar:
+    def get_navbar(self, name: str, selected_item: str | None = None) -> Navbar:
         """Returns a selected navbar in the collection."""
         # does the navbar exist?
         try:
             navbar: Navbar = self.registry[name]
-        except KeyError:
+        except KeyError as e:
             raise NavbarError(
                 f"Navbar '{name}' does not exist. Expected one of "
                 f"{list(self.registry.keys())}. See {self!r}."
-            )
+            ) from e
         else:
             # does the navbar have items?
             if not navbar.navbar_items:
@@ -66,10 +66,9 @@ class NavbarCollection:
                 navbar.set_active(selected_item)
         return navbar
 
-    def show_user_permissions(self, username: str = None, navbar_name: str = None):
+    def show_user_permissions(self, username: str, navbar_name: str):
         user = django_apps.get_model("auth.user").objects.get(username=username)
-        navbar: Navbar = self.registry.get(navbar_name)
-        return navbar.show_user_permissions(user=user)
+        return self.registry.get(navbar_name).show_user_permissions(user=user)
 
     def show_user_codenames(self, username=None, navbar_name=None):
         user_permissions = self.show_user_permissions(username, navbar_name)
@@ -101,7 +100,7 @@ class NavbarCollection:
                     except ImportError as e:
                         site_navbars.registry = before_import_registry
                         if module_has_submodule(mod, module_name):
-                            raise NavbarError(e)
+                            raise NavbarError(e) from e
                 except ImportError:
                     pass
 

edc_navbar/system_checks.py

@@ -8,7 +8,7 @@ from edc_navbar import site_navbars
 def edc_navbar_checks(app_configs, **kwargs) -> list[CheckMessage]:
     errors = []
 
-    for navbar_name, navbar in site_navbars.registry.items():
+    for navbar in site_navbars.registry.values():
         for navbar_item in navbar.navbar_items:
             try:
                 app_label, codename = navbar_item.codename.split(".")
@@ -30,13 +30,6 @@ def edc_navbar_checks(app_configs, **kwargs) -> list[CheckMessage]:
                     errors.append(Error(msg, id="edc_navbar.E002"))
             try:
                 navbar_item.get_url(raise_exception=True)
-            except NoReverseMatch:
-                errors.append(
-                    Error(
-                        f"NoReverseMatch for url. Got '{navbar_item.real_url_name}'. "
-                        f"See {navbar_item.name}.",
-                        id="edc_navbar.E003",
-                    )
-                )
-
+            except NoReverseMatch as e:
+                errors.append(Error(str(e), id="edc_navbar.E003"))
     return errors

edc_navbar/utils.py

@@ -7,3 +7,17 @@ def get_autodiscover():
 
 def get_verify_on_load():
     return getattr(settings, "EDC_NAVBAR_VERIFY_ON_LOAD", "")
+
+
+def get_register_default_navbar():
+    return getattr(settings, "EDC_NAVBAR_REGISTER_DEFAULT_NAVBAR", True)
+
+
+def get_default_navbar_name():
+    """Returns the default navbar name.
+
+    For example: inte_dashboard for project INTE.
+    """
+    return getattr(
+        settings, "EDC_NAVBAR_DEFAULT_NAVBAR_NAME", f"{settings.APP_NAME}_dashboard".lower()
+    )