clinicedc 2.0.4__py3-none-any.whl → 2.0.5__py3-none-any.whl

edc_action_item/action.py

@@ -1,7 +1,8 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING, List, Optional, Type
+from contextlib import suppress
+from typing import TYPE_CHECKING
 
 from django.apps import apps as django_apps
 from django.conf import settings
@@ -27,6 +28,29 @@ logger = logging.getLogger(__name__)
 style = color_style()
 
 REFERENCE_MODEL_ERROR_CODE = "reference_model"
+ACTION_CLASS_MISMATCH = (
+    "Action class mismatch for given ActionItem. "
+    "{action_item_action_cls} incorrectly passed "
+    "to Action {action_cls}."
+)
+ACTION_GOT_UNLISTED_PARENT_ACTION_ITEM = (
+    "Action class received an unlisted parent_action_item. "
+    "Expected one of {parent_action_names}. "
+    "Got '{parent_action_cls_name}' "
+    "subject_identifier `{subject_identifier}`."
+    "See Action {action_cls}."
+)
+
+ACTION_EXPECTS_RELATED_ACTION_ITEM = (
+    "Action class expects a related_action_item. "
+    "related_reference_fk_attr=`{related_reference_fk_attr}`. "
+    "Got None for action based on action_item `{action_item}`. "
+    "See Action {action_cls}."
+)
+
+ACTION_ITEM_DOES_NOT_EXIST = "{err} Got action_identifier={action_identifier}."
+ACTION_ITEM_GET_OR_CREATE_FAILED = "Unable to get or create ActionItem. Got {opts}."
+ACTION_NAME_IS_NONE = "Action name cannot be None. See {action_cls}."
 
 
 class Action:
@@ -45,7 +69,7 @@ class Action:
     help_text: str = None
     instructions = None
     name: str = None
-    parent_action_names: Optional[List[str]] = None
+    parent_action_names: tuple[str] | None = None
     enforce_parent_action_names: bool = True
     priority: bool = None
     reference_model: str = None
@@ -63,23 +87,23 @@ class Action:
     action_type_model: str = "edc_action_item.actiontype"
     next_actions: list[str] | None = None  # a list of Action classes which may include 'self'
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         action_item: ActionItemStub = None,
         reference_obj: models.Model = None,
-        subject_identifier: str = None,
-        action_identifier: str = None,
-        parent_action_item: Optional[ActionItemStub] = None,
-        related_action_item: Optional[ActionItemStub] = None,
-        using: Optional[str] = None,
-        readonly: Optional[bool] = None,
+        subject_identifier: str | None = None,
+        action_identifier: str | None = None,
+        parent_action_item: ActionItemStub | None = None,
+        related_action_item: ActionItemStub | None = None,
+        using: str | None = None,
+        readonly: bool | None = None,
         skip_get_current_site: bool | None = None,
         site_id: int | None = None,
     ) -> None:
         self._action_item = action_item
         self._reference_obj = reference_obj
 
-        self.parent_action_names = self.parent_action_names or []
+        self.parent_action_names = self.parent_action_names or ()
 
         self.messages: dict = {}
 
@@ -94,9 +118,10 @@ class Action:
 
         if self.action_item.action_cls != self.__class__:
             raise ActionError(
-                f"Action class mismatch for given ActionItem. "
-                f"{self.action_item.action_cls} incorrectly passed "
-                f"to Action {self.__class__}",
+                ACTION_CLASS_MISMATCH.format(
+                    action_item_action_cls=self.action_item.action_cls,
+                    action_cls=self.__class__,
+                ),
                 code="class type mismatch",
             )
         self.action_identifier = self.action_item.action_identifier
@@ -112,18 +137,20 @@ class Action:
             and self.parent_action_item.action_cls.name not in self.parent_action_names
         ):
             raise ActionError(
-                f"Action class received an unlisted parent_action_item. "
-                f"Expected one of {self.parent_action_names}. "
-                f"Got '{self.parent_action_item.action_cls.name}' "
-                f"subject_identifier `{self.subject_identifier}`."
-                f"See Action {self.__class__}."
+                ACTION_GOT_UNLISTED_PARENT_ACTION_ITEM.format(
+                    parent_action_names=self.parent_action_names,
+                    parent_action_cls_name=self.parent_action_item.action_cls.name,
+                    subject_identifier=self.subject_identifier,
+                    action_cls=self.__class__,
+                )
             )
         if not self.related_action_item and self.related_reference_fk_attr:
             raise ActionError(
-                "Action class expects a related_action_item. "
-                f"related_reference_fk_attr=`{self.related_reference_fk_attr}`. "
-                f"Got None for action based on action_item `{self.action_item}`. "
-                f"See `{repr(self)}`"
+                ACTION_EXPECTS_RELATED_ACTION_ITEM.format(
+                    related_reference_fk_attr=self.related_reference_fk_attr,
+                    action_item=self.action_item,
+                    action_cls=self.__class__,
+                )
             )
 
         if self.reference_obj and not self.readonly:
@@ -157,19 +184,18 @@ class Action:
         The reference model instance "should" exist if
         action item exists and is CLOSED. If not, re-open.
         """
-        if not self._reference_obj:
-            if self.action_identifier:
-                try:
-                    self._reference_obj = (
-                        self.reference_model_cls()
-                        .objects.using(self.using)
-                        .get(action_identifier=self.action_identifier)
-                    )
-                except ObjectDoesNotExist:
-                    if self.action_item and self.action_item.status == CLOSED:
-                        self.action_item.status = OPEN
-                        self.action_item.save(update_fields=["status"], using=self.using)
-                        self.action_item.refresh_from_db()
+        if not self._reference_obj and self.action_identifier:
+            try:
+                self._reference_obj = (
+                    self.reference_model_cls()
+                    .objects.using(self.using)
+                    .get(action_identifier=self.action_identifier)
+                )
+            except ObjectDoesNotExist:
+                if self.action_item and self.action_item.status == CLOSED:
+                    self.action_item.status = OPEN
+                    self.action_item.save(update_fields=["status"], using=self.using)
+                    self.action_item.refresh_from_db()
         return self._reference_obj
 
     @property
@@ -188,8 +214,10 @@ class Action:
                     )
                 except ObjectDoesNotExist as e:
                     raise ObjectDoesNotExist(
-                        f"{e} Got action_identifier={self.action_identifier}."
-                    )
+                        ACTION_ITEM_DOES_NOT_EXIST.format(
+                            err=str(e), action_identifier=self.action_identifier
+                        )
+                    ) from e
             elif self.reference_obj:
                 self._action_item = self.reference_obj.action_item
             else:
@@ -221,10 +249,10 @@ class Action:
                     parent_action_item=self.parent_action_item,
                     related_action_item=self.related_action_item,
                 )
-                raise ActionError(f"Unable to get or create ActionItem. Got {opts}.")
+                raise ActionError(ACTION_ITEM_GET_OR_CREATE_FAILED.format(opts=opts))
         return self._action_item
 
-    def _create_new_action_item(self, subject_identifier: str = None, **opts):
+    def _create_new_action_item(self, subject_identifier: str | None = None, **opts):
         """Create a new action item.
 
         Called only after checking.
@@ -254,12 +282,12 @@ class Action:
             )
 
     @classmethod
-    def action_item_model_cls(cls) -> Type[ActionItem]:
+    def action_item_model_cls(cls) -> type[ActionItem]:
         """Returns the ActionItem model class."""
         return django_apps.get_model(cls.action_item_model)
 
     @classmethod
-    def action_type_model_cls(cls) -> Type[ActionType]:
+    def action_type_model_cls(cls) -> type[ActionType]:
         """Returns the ActionType model class."""
         return django_apps.get_model(cls.action_type_model)
 
@@ -282,14 +310,10 @@ class Action:
     def as_dict(cls) -> dict:
         """Returns select class attrs as a dictionary."""
         dct = {k: v for k, v in cls.__dict__.items() if not k.startswith("_")}
-        try:
+        with suppress(AttributeError):
             dct.update(reference_model=cls.get_reference_model().lower())
-        except AttributeError:
-            pass
-        try:
+        with suppress(AttributeError):
             dct.update(related_reference_model=cls.related_reference_model.lower())
-        except AttributeError:
-            pass
         dct.update(
             name=cls.name,
             display_name=cls.display_name,
@@ -305,7 +329,7 @@ class Action:
         )
         return dct
 
-    def get_next_actions(self) -> List[str]:
+    def get_next_actions(self) -> list[str]:
         """Returns a list of action classes to be created
         again by this model if the first has been closed on post_save.
         """
@@ -376,7 +400,7 @@ class Action:
                             self.reference_obj.action_identifier
                         )
                     )
-                    | models.Q(related_action_item=self.reference_obj.action_item)  # noqa
+                    | models.Q(related_action_item=self.reference_obj.action_item)
                 ),
                 status=CLOSED,
             )
@@ -445,12 +469,10 @@ class Action:
         Will not append if the ActionItem for the next action
         already exists.
         """
-        try:
+        with suppress(AttributeError):
             action_name = action_cls.name
-        except AttributeError:
-            pass
         if not action_name:
-            raise ActionError(f"Action name cannot be None. See {self}.")
+            raise ActionError(ACTION_NAME_IS_NONE.format(action_cls=self))
         next_actions = next_actions or []
         required = True if required is None else required
         opts = dict(
@@ -491,7 +513,7 @@ class Action:
             parent_action_item=parent_action_item,
             status=NEW,
         )
-        for index, obj in enumerate(
+        for index, obj in enumerate(  # noqa: B007
             self.action_item_model_cls().objects.using(self.using).filter(**opts)
         ):
             obj.delete(using=self.using)

edc_action_item/action_item_notification.py

@@ -1,5 +1,3 @@
-from typing import List
-
 from django.core.exceptions import ObjectDoesNotExist
 
 from edc_constants.constants import CLOSED, NEW, OPEN
@@ -35,7 +33,7 @@ class ActionItemNotification(Notification):
     notification_action_name: str = None
     # set by class user, list of field(s) from
     # the action_item.reference_obj
-    notification_fields: List[str] = []
+    notification_fields: list[str] = []
 
     # TODO: not sure what this does?
     notify_on_new: bool = False

edc_action_item/action_with_notification.py

@@ -1,4 +1,4 @@
-from typing import Type, cast
+from typing import cast
 
 from django.db import models
 
@@ -14,7 +14,7 @@ class ActionWithNotification(Action):
     notification_email_to: list[str] = None
     notification_display_name: str = None
     notification_fields: list[str] = None
-    notification_super_cls: Type[ActionItemNotification] = ActionItemNotification
+    notification_super_cls: type[ActionItemNotification] = ActionItemNotification
     notify_on_changed_reference_obj: models.Model = True
     notify_on_close: bool = False
     notify_on_new: bool = False
@@ -22,10 +22,10 @@ class ActionWithNotification(Action):
     notify_on_open: bool = False
 
     @classmethod
-    def notification_cls(cls) -> Type[ActionItemNotification]:
+    def notification_cls(cls) -> type[ActionItemNotification]:
         """Returns a subclass of ActionItemModelNotification."""
         return cast(
-            Type[ActionItemNotification],
+            type[ActionItemNotification],
             type(
                 f"{cls.__name__}Notification",
                 (cls.notification_super_cls,),

edc_action_item/create_action_item.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Type
+from typing import TYPE_CHECKING
 
 from django.core.exceptions import ObjectDoesNotExist
 
@@ -13,7 +13,7 @@ if TYPE_CHECKING:
 
 
 def create_action_item(
-    action_cls: Type[Action],
+    action_cls: type[Action],
     subject_identifier: str = None,
     action_identifier: str | None = None,
     related_action_item: ActionItem | None = None,

edc_action_item/create_or_update_action_type.py

@@ -27,7 +27,7 @@ def create_or_update_action_type(
     if options:
         fields = [f.name for f in action_type_model_cls._meta.get_fields() if f.name != "name"]
         for attr, value in options.items():
-            if attr in fields:
+            if attr in fields and value is not None:
                 opts.update({attr: value})
     try:
         action_type = action_type_model_cls.objects.get(name=name)

edc_action_item/data_fixers.py

@@ -64,7 +64,7 @@ def fix_null_action_item_fk(apps, app_label, models):
                     try:
                         obj.save()
                     except MultipleObjectsReturned:
-                        sys.stdout.write(f"Failed to resave {repr(obj)}")
+                        sys.stdout.write(f"Failed to resave {obj!r}")
 
 
 def fix_null_action_items(apps):
@@ -114,8 +114,7 @@ def fix_null_action_items(apps):
                     .update(related_action_item=related_action_item)
                 )
                 sys.stdout.write(
-                    f" setting related_action_items for "
-                    f"{related_action_item}. Got {updated}\n"
+                    f" setting related_action_items for {related_action_item}. Got {updated}\n"
                 )
 
 
@@ -157,7 +156,7 @@ def fix_null_related_action_items(apps):  # noqa
                     action_item.related_action_item = related_action_item
                     action_item.save()
                     if reference_obj:
-                        reference_obj.related_action_item = related_action_item  # noqa
+                        reference_obj.related_action_item = related_action_item
                         reference_obj.save()
             if (
                 action_item_cls.objects.filter(
@@ -239,7 +238,7 @@ def fix_duplicate_singleton_action_items(apps, name=None):
                     ).delete()
 
 
-def fix_null_related_action_items2(delete_orphans=None):  # noqa
+def fix_null_related_action_items2(delete_orphans=None):
     """Used for early action items where related_action_item
     was not set, e.g. v0.1.1
 

edc_action_item/delete_action_item.py

@@ -42,4 +42,3 @@ def delete_action_item(action_cls=None, subject_identifier=None, using=None):
             obj.delete(using=using)
     else:
         obj.delete(using=using)
-    return None

edc_action_item/modeladmin_mixins.py

@@ -1,10 +1,8 @@
-from typing import Tuple
-
 from .fieldsets import action_fields
 
 
 class ActionItemModelAdminMixin:
-    def get_readonly_fields(self, request, obj=None) -> Tuple[str, ...]:
+    def get_readonly_fields(self, request, obj=None) -> tuple[str, ...]:
         """
         Returns a list of readonly field names.
 
@@ -15,7 +13,7 @@ class ActionItemModelAdminMixin:
         fields += action_fields
         return tuple(f for f in fields if f != "action_identifier")
 
-    def get_search_fields(self, request) -> Tuple[str, ...]:
+    def get_search_fields(self, request) -> tuple[str, ...]:
         search_fields = super().get_search_fields(request)
         custom_fields = ("action_identifier",)
         if "subject_identifier" in [f.name for f in self.model._meta.fields]:

edc_action_item/modelform_mixins/modelform_mixins.py

@@ -29,7 +29,7 @@ class ActionItemModelFormMixin:
                 )
             except ActionError as e:
                 raise forms.ValidationError(
-                    f"{str(e.message)}. Please contact your data manager."
+                    f"{e.message!s}. Please contact your data manager."
                 )
         return cleaned_data
 

edc_action_item/models/action_item.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from datetime import datetime
-from typing import TYPE_CHECKING, Type
+from typing import TYPE_CHECKING
 
 from django.apps import apps as django_apps
 from django.core.exceptions import ObjectDoesNotExist
@@ -29,9 +29,27 @@ if TYPE_CHECKING:
 
     class PrnModel(BaseUuidModel):
         subject_identifier: str
-        ...  # noqa
+        ...
 
-    class CrfModel(CrfModelMixin): ...  # noqa
+    class CrfModel(CrfModelMixin): ...
+
+
+RELATED_ACTION_ITEM_DOES_NOT_EXIST = (
+    "Related ActionItem does not exist. Got {action_identifier}."
+)
+PARENT_ACTION_ITEM_DOES_NOT_EXIST = (
+    "Parent ActionItem does not exist. Got {action_identifier}."
+)
+INVALID_ACTION_ITEM_STATUS = (
+    "Invalid action item status. Reference model exists. "
+    "Got `{status}`. Perhaps catch this in the form"
+)
+
+INVALID_SUBJECT_IDENTIFIER = (
+    "Invalid subject identifier. Attempt to create {class_name} failed. "
+    "Subject does not exist in '{subject_identifier_model}'. "
+    "Got '{subject_identifier}'."
+)
 
 
 class CurrentSiteManager(BaseCurrentSiteManager):
@@ -82,17 +100,14 @@ class ActionItem(
 
     related_action_identifier = models.CharField(
         max_length=50,
-        null=True,
         blank=True,
         help_text=(
-            "May be left blank. e.g. action identifier from "
-            "source model that opened the item."
+            "May be left blank. e.g. action identifier from source model that opened the item."
         ),
     )
 
     parent_action_identifier = models.CharField(
         max_length=50,
-        null=True,
         blank=True,
         help_text=(
             "May be left blank. e.g. action identifier from "
@@ -103,7 +118,6 @@ class ActionItem(
     priority = models.CharField(
         max_length=25,
         choices=PRIORITY,
-        null=True,
         blank=True,
         help_text="Leave blank to use default for this action type.",
     )
@@ -128,13 +142,11 @@ class ActionItem(
 
     status = models.CharField(max_length=25, default=NEW, choices=ACTION_STATUS)
 
-    instructions = models.TextField(
-        null=True, blank=True, help_text="populated by action class"
-    )
+    instructions = models.TextField(blank=True, help_text="populated by action class")
 
     auto_created = models.BooleanField(default=False)
 
-    auto_created_comment = models.CharField(max_length=25, null=True, blank=True)
+    auto_created_comment = models.CharField(max_length=25, blank=True)
 
     objects = ActionItemManager()
 
@@ -168,29 +180,28 @@ class ActionItem(
                 subject_identifier_model_cls.objects.get(
                     subject_identifier=self.subject_identifier
                 )
-            except ObjectDoesNotExist:
+            except ObjectDoesNotExist as e:
                 raise SubjectDoesNotExist(
-                    f"Attempt to create {self.__class__.__name__} failed. "
-                    f"Invalid subject identifier. Subject does not exist "
-                    f"in '{self.subject_identifier_model}'. "
-                    f"Got '{self.subject_identifier}'."
-                )
+                    INVALID_SUBJECT_IDENTIFIER.format(
+                        class_name=self.__class__.__name__,
+                        subject_identifier_model=self.subject_identifier_model,
+                        subject_identifier=self.subject_identifier,
+                    )
+                ) from e
             self.priority = self.priority or self.action_type.priority
-        else:
-            if (
-                self.status in [NEW, CANCELLED]
-                and django_apps.get_model(self.reference_model)
-                .objects.filter(action_identifier=self.action_identifier)
-                .exists()
-            ):
-                raise ActionItemStatusError(
-                    "Invalid action item status. Reference model exists. "
-                    f"Got `{self.get_status_display()}`. Perhaps catch this in the form"
-                )
+        elif (
+            self.status in [NEW, CANCELLED]
+            and django_apps.get_model(self.reference_model)
+            .objects.filter(action_identifier=self.action_identifier)
+            .exists()
+        ):
+            raise ActionItemStatusError(
+                INVALID_ACTION_ITEM_STATUS.format(status=self.get_status_display())
+            )
         super().save(*args, **kwargs)
 
     def natural_key(self) -> tuple[str]:
-        return (self.action_identifier,)  # noqa
+        return (self.action_identifier,)
 
     @property
     def last_updated(self) -> datetime | str:
@@ -201,7 +212,7 @@ class ActionItem(
         return None if self.status == NEW else self.user_modified or self.user_created
 
     @property
-    def action_cls(self) -> Type[Action]:
+    def action_cls(self) -> type[Action]:
         """Returns the action_cls."""
         return site_action_items.get(self.action_type.name)
 
@@ -219,7 +230,7 @@ class ActionItem(
         return self.action_type.reference_model
 
     @property
-    def reference_model_cls(self) -> Type[PrnModel | CrfModel]:
+    def reference_model_cls(self) -> type[PrnModel | CrfModel]:
         return django_apps.get_model(self.action_type.reference_model)
 
     @property
@@ -230,7 +241,9 @@ class ActionItem(
     def parent_reference_obj(self) -> PrnModel | CrfModel:
         if not self.parent_action_item:
             raise ObjectDoesNotExist(
-                f"Parent ActionItem does not exist for {self.action_identifier}."
+                PARENT_ACTION_ITEM_DOES_NOT_EXIST.format(
+                    action_identifier=self.action_identifier
+                )
             )
         return self.parent_action_item.reference_obj
 
@@ -242,7 +255,9 @@ class ActionItem(
     def related_reference_obj(self) -> PrnModel | CrfModel:
         if not self.related_action_item:
             raise ObjectDoesNotExist(
-                f"Related ActionItem does not exist for {self.action_identifier}."
+                RELATED_ACTION_ITEM_DOES_NOT_EXIST.format(
+                    action_identifier=self.action_identifier
+                )
             )
         return self.related_action_item.reference_obj
 
@@ -266,9 +281,9 @@ class ActionItem(
         verbose_name = "Action Item"
         verbose_name_plural = "Action Items"
         indexes = (
-            BaseUuidModel.Meta.indexes
-            + NonUniqueSubjectIdentifierFieldMixin.Meta.indexes
-            + [
+            *BaseUuidModel.Meta.indexes,
+            *NonUniqueSubjectIdentifierFieldMixin.Meta.indexes,
+            *[
                 models.Index(
                     fields=[
                         "subject_identifier",
@@ -279,5 +294,5 @@ class ActionItem(
                         "report_datetime",
                     ],
                 ),
-            ]
+            ],
         )

edc_action_item/models/action_model_mixin.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Type
+from typing import TYPE_CHECKING, Any
 
 from django.db import models
 from django.db.models.deletion import PROTECT
@@ -53,6 +53,19 @@ class ActionNoManagersModelMixin(models.Model):
 
     action_item_reason = models.TextField(null=True, editable=False)
 
+    class Meta:
+        abstract = True
+        indexes = (
+            models.Index(
+                fields=[
+                    "action_identifier",
+                    "action_item",
+                    "related_action_item",
+                    "parent_action_item",
+                ]
+            ),
+        )
+
     def __str__(self) -> str:
         if self.action_identifier:
             return f"{self.action_identifier[-9:]}"
@@ -61,7 +74,7 @@ class ActionNoManagersModelMixin(models.Model):
     def save(self: Any, *args, **kwargs):
         # ensure action class is defined
         if not self.get_action_cls():
-            raise ActionClassNotDefined(f"Action class name not defined. See {repr(self)}")
+            raise ActionClassNotDefined(f"Action class name not defined. See {self!r}")
 
         # ensure subject_identifier
         if not self.subject_identifier:
@@ -98,13 +111,13 @@ class ActionNoManagersModelMixin(models.Model):
         super().save(*args, **kwargs)  # type: ignore
 
     def natural_key(self: Any) -> tuple:
-        return (self.action_identifier,)  # noqa
+        return (self.action_identifier,)
 
     # noinspection PyTypeHints
     natural_key.dependencies = ["edc_action_item.actionitem"]  # type:ignore
 
     @classmethod
-    def get_action_cls(cls) -> Type[Action]:
+    def get_action_cls(cls) -> type[Action]:
         return site_action_items.get(cls.action_name)
 
     @property
@@ -123,19 +136,6 @@ class ActionNoManagersModelMixin(models.Model):
         """Returns a shortened action_identifier"""
         return self.action_identifier[-9:]
 
-    class Meta:
-        abstract = True
-        indexes = [
-            models.Index(
-                fields=[
-                    "action_identifier",
-                    "action_item",
-                    "related_action_item",
-                    "parent_action_item",
-                ]
-            )
-        ]
-
 
 class ActionModelMixin(ActionNoManagersModelMixin):
     objects = ActionIdentifierModelManager()