clinicedc 2.0.6__py3-none-any.whl → 2.0.8__py3-none-any.whl

edc_appointment/utils.py

@@ -80,7 +80,7 @@ class AppointmentDateWindowPeriodGapError(Exception):
     pass
 
 
-class AppointmentAlreadyStarted(Exception):
+class AppointmentAlreadyStarted(Exception):  # noqa: N818
     pass
 
 
@@ -157,10 +157,9 @@ def raise_on_appt_may_not_be_missed(
 
 
 def get_appointment_form_meta_options() -> dict:
-    options = getattr(
+    return getattr(
         settings, "EDC_APPOINTMENT_FORM_META_OPTIONS", dict(labels={}, help_texts={})
     )
-    return options
 
 
 def get_appt_reason_choices() -> tuple[str, ...]:
@@ -516,11 +515,11 @@ def raise_on_appt_datetime_not_in_window(
         except ScheduledVisitWindowError as e:
             msg = str(e)
             msg.replace("Invalid datetime", "Invalid appointment datetime (S)")
-            raise AppointmentWindowError(msg)
+            raise AppointmentWindowError(msg) from e
         except UnScheduledVisitWindowError as e:
             msg = str(e)
             msg.replace("Invalid datetime", "Invalid appointment datetime (U)")
-            raise AppointmentWindowError(msg)
+            raise AppointmentWindowError(msg) from e
 
 
 def get_window_gap_days(appointment) -> int:
@@ -623,7 +622,7 @@ def get_appointment_by_datetime(
             raise_on_appt_datetime_not_in_window(
                 appointment, appt_datetime=suggested_appt_datetime
             )
-        except AppointmentWindowError:
+        except AppointmentWindowError as e:
             in_gap = appt_datetime_in_gap(appointment, suggested_appt_datetime)
             in_next_window_adjusted = appt_datetime_in_next_window_adjusted_for_gap(
                 appointment, suggested_appt_datetime
@@ -635,7 +634,7 @@ def get_appointment_by_datetime(
                 raise AppointmentDateWindowPeriodGapError(
                     f"Date falls in a `window period gap` between {appointment.visit_code} "
                     f"and {appointment.next.visit_code}. Got {dt}."
-                )
+                ) from e
             if (
                 in_gap
                 and in_next_window_adjusted
@@ -674,7 +673,7 @@ def reset_appointment(appointment: Appointment, **kwargs):
         appt_status=appointment._meta.get_field("appt_status").default,
         appt_timing=appointment._meta.get_field("appt_timing").default,
         appt_type=None,
-        appt_type_other=None,
+        appt_type_other="",
         appt_datetime=appointment.timepoint_datetime,
         comment="",
     )
@@ -705,7 +704,7 @@ def skip_appointment(appointment: Appointment, comment: str | None = None):
         appt_status=SKIPPED_APPT,
         appt_timing=NOT_APPLICABLE,
         appt_type=NOT_APPLICABLE,
-        comment=comment,
+        comment=comment or "",
     )
 
 
@@ -722,11 +721,6 @@ def get_unscheduled_appointment_url(appointment: Appointment = None) -> str:
         visit_code_sequence=appointment.visit_code_sequence + 1,
         timepoint=appointment.timepoint,
     )
-    # if appointment := (
-    #     appointment.__class__.objects.filter(visit_code_sequence__gt=0, **kwargs)
-    #     .order_by("visit_code_sequence")
-    #     .last()
-    # ):
     kwargs.update(visit_code_sequence=str(appointment.visit_code_sequence + 1))
     kwargs.update(redirect_url=dashboard_url)
     return reverse(unscheduled_appointment_url_name, kwargs=kwargs)
@@ -741,19 +735,18 @@ def update_appt_status_for_timepoint(related_visit: RelatedVisitModel) -> None:
         ):
             related_visit.appointment.appt_status = INCOMPLETE_APPT
             related_visit.appointment.save_base(update_fields=["appt_status"])
-    elif related_visit.appointment.appt_status == INCOMPLETE_APPT:
-        if (
-            not related_visit.metadata[CRF].filter(entry_status=REQUIRED).exists()
-            and not related_visit.metadata[REQUISITION].filter(entry_status=REQUIRED).exists()
-        ):
-            related_visit.appointment.appt_status = COMPLETE_APPT
-            related_visit.appointment.save_base(update_fields=["appt_status"])
+    elif related_visit.appointment.appt_status == INCOMPLETE_APPT and (
+        not related_visit.metadata[CRF].filter(entry_status=REQUIRED).exists()
+        and not related_visit.metadata[REQUISITION].filter(entry_status=REQUIRED).exists()
+    ):
+        related_visit.appointment.appt_status = COMPLETE_APPT
+        related_visit.appointment.save_base(update_fields=["appt_status"])
 
 
 def refresh_appointments(
-    subject_identifier: str = None,
-    visit_schedule_name: str = None,
-    schedule_name: str = None,
+    subject_identifier: str | None = None,
+    visit_schedule_name: str | None = None,
+    schedule_name: str | None = None,
     request: WSGIRequest | None = None,
     warn_only: bool | None = None,
 ) -> tuple[str, str]:
@@ -839,6 +832,8 @@ def validate_date_is_on_clinic_day(
             and calendar.weekday(appt_date.year, appt_date.month, appt_date.day)
             not in clinic_days
         ):
+
+            days_str = [day_abbr[d] for d in clinic_days]
             days_str = []
             for d in clinic_days:
                 days_str.append(day_abbr[d])

edc_appointment/view_utils/appointment_button.py

@@ -5,9 +5,9 @@ from typing import TYPE_CHECKING
 from uuid import UUID
 
 from django.apps import apps as django_apps
+from django.utils import timezone
 from django.utils.translation import gettext as _
 
-from edc_utils import get_utcnow
 from edc_view_utils.dashboard_model_button import DashboardModelButton
 from edc_view_utils.model_button import ADD
 
@@ -51,7 +51,7 @@ class AppointmentButton(DashboardModelButton):
         color = super().color
         if (
             self.model_obj
-            and self.model_obj.appt_datetime <= get_utcnow()
+            and self.model_obj.appt_datetime <= timezone.now()
             and not self.model_obj.related_visit
         ):
             color = self.colors[ADD]

edc_auth/admin/user_admin.py

@@ -15,7 +15,7 @@ from .user_profile_admin import UserProfileInline
 admin.site.unregister(User)
 
 
-def send_new_credentials_to_user_action(modeladmin, request, queryset):  # noqa
+def send_new_credentials_to_user_action(modeladmin, request, queryset):
     if request.user.has_perm("auth.change_user"):
         for obj in queryset:
             send_new_credentials_to_user(user=obj)

edc_auth/auth_objects/__init__.py

@@ -1,21 +1,3 @@
-from ..constants import (
-    ACCOUNT_MANAGER,
-    ACCOUNT_MANAGER_ROLE,
-    ADMINISTRATION,
-    AUDITOR,
-    AUDITOR_ROLE,
-    CELERY_MANAGER,
-    CLINIC,
-    CLINIC_SUPER,
-    CLINICIAN_ROLE,
-    CLINICIAN_SUPER_ROLE,
-    CUSTOM_ROLE,
-    EVERYONE,
-    NURSE_ROLE,
-    PII,
-    PII_VIEW,
-    STAFF_ROLE,
-)
 from .codenames import (
     account_manager,
     administration,
@@ -25,6 +7,6 @@ from .codenames import (
     clinic_super,
     everyone,
 )
-from .default_groups import default_groups
+from .default_groups import get_default_groups
 from .default_pii_models import default_pii_models
-from .default_roles import default_roles
+from .default_roles import get_default_roles

edc_auth/auth_objects/default_groups.py

@@ -11,14 +11,16 @@ from ..constants import (
 )
 from .codenames import account_manager, administration, celery_manager, everyone
 
-default_groups = {
-    ACCOUNT_MANAGER: account_manager,
-    ADMINISTRATION: administration,
-    AUDITOR: [],
-    CELERY_MANAGER: celery_manager,
-    CLINIC: [],
-    CLINIC_SUPER: [],
-    EVERYONE: everyone,
-    PII: [],
-    PII_VIEW: [],
-}
+
+def get_default_groups():
+    return {
+        ACCOUNT_MANAGER: account_manager,
+        ADMINISTRATION: administration,
+        AUDITOR: [],
+        CELERY_MANAGER: celery_manager,
+        CLINIC: [],
+        CLINIC_SUPER: [],
+        EVERYONE: everyone,
+        PII: [],
+        PII_VIEW: [],
+    }

edc_auth/auth_objects/default_roles.py

@@ -17,27 +17,29 @@ from ..constants import (
     STATISTICIAN,
 )
 
-# Format {ROLE_NAME: [GROUP_NAME, GROUP_NAME, ...]
-default_roles: dict[str, list[str]] = {
-    ACCOUNT_MANAGER_ROLE: [ACCOUNT_MANAGER],
-    AUDITOR_ROLE: [
-        AUDITOR,
-        PII_VIEW,
-    ],
-    CLINICIAN_ROLE: [
-        CLINIC,
-        PII,
-    ],
-    CLINICIAN_SUPER_ROLE: [
-        CLINIC_SUPER,
-        CLINIC,
-        PII,
-    ],
-    CUSTOM_ROLE: [],
-    NURSE_ROLE: [
-        CLINIC,
-        PII,
-    ],
-    STAFF_ROLE: [ADMINISTRATION, EVERYONE],
-    STATISTICIAN: [AUDITOR],
-}
+
+def get_default_roles() -> dict[str, list[str]]:
+    """Format {ROLE_NAME: [GROUP_NAME, GROUP_NAME, ...]"""
+    return {
+        ACCOUNT_MANAGER_ROLE: [ACCOUNT_MANAGER],
+        AUDITOR_ROLE: [
+            AUDITOR,
+            PII_VIEW,
+        ],
+        CLINICIAN_ROLE: [
+            CLINIC,
+            PII,
+        ],
+        CLINICIAN_SUPER_ROLE: [
+            CLINIC_SUPER,
+            CLINIC,
+            PII,
+        ],
+        CUSTOM_ROLE: [],
+        NURSE_ROLE: [
+            CLINIC,
+            PII,
+        ],
+        STAFF_ROLE: [ADMINISTRATION, EVERYONE],
+        STATISTICIAN: [AUDITOR],
+    }

edc_auth/auth_updater/auth_updater.py

@@ -9,6 +9,7 @@ from django.contrib.auth import get_user_model
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.management.color import color_style
 
+from ..constants import POST_UPDATE_FUNCS_KEY, PRE_UPDATE_FUNCS_KEY
 from ..site_auths import site_auths
 from .group_updater import GroupUpdater
 from .role_updater import RoleUpdater
@@ -17,6 +18,14 @@ style = color_style()
 
 
 class AuthUpdater:
+    """A class to update auth.Group, edc_auth.Role, auth.Permissions
+    models using the site_auth registry.
+
+    Called once on application startup. For example::
+
+        AuthUpdater(verbose=False, warn_only=True)
+    """
+
     group_updater_cls = GroupUpdater
     role_updater_cls = RoleUpdater
 
@@ -38,8 +47,10 @@ class AuthUpdater:
         )
         groups = groups or site_auths.groups
         pii_models = pii_models or site_auths.pii_models
-        post_update_funcs = post_update_funcs or site_auths.post_update_funcs
-        pre_update_funcs = pre_update_funcs or site_auths.pre_update_funcs
+        post_update_funcs = post_update_funcs or [f for f in site_auths.post_update_funcs]
+        site_auths.registry[POST_UPDATE_FUNCS_KEY] = []
+        pre_update_funcs = pre_update_funcs or [f for f in site_auths.pre_update_funcs]
+        site_auths.registry[PRE_UPDATE_FUNCS_KEY] = []
         roles = roles or site_auths.roles
         self.apps = apps
         if not self.edc_auth_skip_auth_updater:

edc_auth/auth_updater/group_updater.py

@@ -11,7 +11,7 @@ from django.core.exceptions import (
 )
 from django.core.management.color import color_style
 
-from ..auth_objects import PII, PII_VIEW
+from ..constants import PII, PII_VIEW
 from ..utils import make_view_only_group_permissions
 
 style = color_style()
@@ -27,7 +27,7 @@ class PermissionsCreatorError(ValidationError):
     pass
 
 
-class CodenameDoesNotExist(Exception):
+class CodenameDoesNotExist(Exception):  # noqa: N818
     pass
 
 
@@ -87,7 +87,7 @@ class GroupUpdater:
             group = self.group_model_cls.objects.get(name=group_name)
         except ObjectDoesNotExist as e:
             if not create_group:
-                raise ObjectDoesNotExist(f"{e} Got {group_name}")
+                raise ObjectDoesNotExist(f"{e} Got {group_name}") from e
             group = self.group_model_cls.objects.create(name=group_name)
         else:
             group.permissions.clear()
@@ -122,7 +122,7 @@ class GroupUpdater:
             try:
                 app_label, codename = self.get_from_dotted_codename(dotted_codename)
             except PermissionsCodenameError as e:
-                warn(str(e))
+                warn(str(e), stacklevel=2)
             else:
                 # if you add extra codenames you must also add custom
                 # codename tuples to the Permissions model before you
@@ -138,7 +138,7 @@ class GroupUpdater:
                 except ObjectDoesNotExist as e:
                     errmsg = f"{e} Got codename={codename},app_label={app_label}"
                     if not self.warn_only:
-                        raise CodenameDoesNotExist(errmsg)
+                        raise CodenameDoesNotExist(errmsg) from e
                     warn(style.ERROR(errmsg))
                 except MultipleObjectsReturned as e:
                     if not allow_multiple_objects:
@@ -166,15 +166,17 @@ class GroupUpdater:
         try:
             app_label, _codename = codename.split(".")
         except ValueError as e:
-            raise PermissionsCodenameError(f"Invalid dotted codename. {e} Got {codename}.")
+            raise PermissionsCodenameError(
+                f"Invalid dotted codename. {e} Got {codename}."
+            ) from e
         else:
             try:
                 self.apps.get_app_config(app_label)
-            except LookupError:
+            except LookupError as e:
                 raise PermissionsCodenameError(
                     "Invalid app_label in codename. Expected format "
                     f"'<app_label>.<some_codename>'. Got {codename}."
-                )
+                ) from e
         prefix = _codename.split("_")[0]
         if prefix not in self.codename_prefixes:
             raise PermissionsCodenameError(
@@ -244,7 +246,7 @@ class GroupUpdater:
         except ObjectDoesNotExist as e:
             raise CodenameDoesNotExist(
                 f"Unable to verify codename. {e} Got '{app_label}.{codename}'"
-            )
+            ) from e
         except MultipleObjectsReturned as e:
             self.delete_and_raise_on_duplicate_codenames(codename, app_label, exception=e)
         return permission
@@ -267,7 +269,7 @@ class GroupUpdater:
         try:
             value, name = codename_tpl
         except ValueError as e:
-            raise ValueError(f"{e} Got {codename_tpl}")
+            raise ValueError(f"{e} Got {codename_tpl}") from e
         _app_label, codename = value.split(".")
         if app_label and _app_label != app_label:
             raise PermissionsCreatorError(

edc_auth/auth_updater/role_updater.py

@@ -56,11 +56,11 @@ class RoleUpdater:
             for group_name in groups:
                 try:
                     group = self.group_model_cls.objects.get(name=group_name)
-                except ObjectDoesNotExist:
+                except ObjectDoesNotExist as e:
                     raise RoleUpdaterError(
                         "Invalid group specified for role. "
                         f"`{group_name}` is not a group. See role `{role}`."
-                    )
+                    ) from e
                     # group = self.group_model_cls.objects.create(name=group_name)
                 role.groups.add(group)
             index += 1

edc_auth/constants.py

@@ -19,3 +19,13 @@ CUSTOM_ROLE = "custom"
 NURSE_ROLE = "research_nurse"
 STAFF_ROLE = "staff"
 STATISTICIAN = "statistician"
+
+# keys for the site_auths registry
+UPDATE_ROLES_KEY = "update_roles"
+UPDATE_GROUPS_KEY = "update_groups"
+PRE_UPDATE_FUNCS_KEY = "pre_update_funcs"
+POST_UPDATE_FUNCS_KEY = "post_update_funcs"
+GROUPS_KEY = "groups"
+ROLES_KEY = "roles"
+PII_MODELS_KEY = "pii_models"
+CUSTOM_PERMISSIONS_TUPLES_KEY = "custom_permissions_tuples"

edc_auth/import_users.py

@@ -183,9 +183,9 @@ class UserImporter:
         self.update_user_sites(site_names or [])
         self.update_user_roles(role_names or [STAFF_ROLE])
         self.user.save()
-        self.user.userprofile.job_title = self.job_title
-        self.user.userprofile.mobile = self.mobile
-        self.user.userprofile.alternate_email = self.alternate_email
+        self.user.userprofile.job_title = self.job_title or ""
+        self.user.userprofile.mobile = self.mobile or ""
+        self.user.userprofile.alternate_email = self.alternate_email or ""
         self.user.userprofile.save()
 
         self.site_names = (

edc_auth/migrations/0001_squashed_0033_alter_userprofile_is_multisite_viewer.py

@@ -10,10 +10,10 @@ import django_audit_fields.models.audit_model_mixin
 import django_revision.revision_field
 from django.conf import settings
 from django.db import migrations, models
+import django.utils.timezone
 
 
 class Migration(migrations.Migration):
-
     replaces = [
         ("edc_auth", "0001_initial"),
         ("edc_auth", "0002_auto_20180803_0515"),
@@ -78,14 +78,14 @@ class Migration(migrations.Migration):
                     "created",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
                     "modified",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
@@ -402,14 +402,14 @@ class Migration(migrations.Migration):
                     "created",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
                     "modified",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (

edc_auth/migrations/0012_auto_20191026_0034.py

@@ -7,6 +7,7 @@ import django_audit_fields.fields.uuid_auto_field
 import django_audit_fields.models.audit_model_mixin
 import django_revision.revision_field
 from django.db import migrations, models
+import django.utils.timezone
 
 
 class Migration(migrations.Migration):
@@ -31,14 +32,14 @@ class Migration(migrations.Migration):
                     "created",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
                     "modified",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (

edc_auth/migrations/0013_auto_20191026_0055.py

@@ -7,6 +7,7 @@ import django_audit_fields.fields.uuid_auto_field
 import django_audit_fields.models.audit_model_mixin
 import django_revision.revision_field
 from django.db import migrations, models
+import django.utils.timezone
 
 
 class Migration(migrations.Migration):
@@ -34,14 +35,14 @@ class Migration(migrations.Migration):
                     "created",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
                     "modified",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (

edc_auth/migrations/0025_permissions.py

@@ -7,6 +7,7 @@ import django_audit_fields.fields.uuid_auto_field
 import django_audit_fields.models.audit_model_mixin
 import django_revision.revision_field
 from django.db import migrations, models
+import django.utils.timezone
 
 
 class Migration(migrations.Migration):
@@ -33,14 +34,14 @@ class Migration(migrations.Migration):
                     "created",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (
                     "modified",
                     models.DateTimeField(
                         blank=True,
-                        default=django_audit_fields.models.audit_model_mixin.utcnow,
+                        default=django.utils.timezone.now,
                     ),
                 ),
                 (

edc_auth/migrations/0035_alter_edcpermissions_device_created_and_more.py

@@ -0,0 +1,85 @@
+# Generated by Django 5.2.6 on 2025-09-17 16:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("edc_auth", "0034_alter_edcpermissions_revision_alter_role_revision"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="edcpermissions",
+            name="device_created",
+            field=models.CharField(
+                blank=True, default="", max_length=10, verbose_name="Device created"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="edcpermissions",
+            name="device_modified",
+            field=models.CharField(
+                blank=True, default="", max_length=10, verbose_name="Device modified"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="edcpermissions",
+            name="locale_created",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Auto-updated by Modeladmin",
+                max_length=10,
+                verbose_name="Locale created",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="edcpermissions",
+            name="locale_modified",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Auto-updated by Modeladmin",
+                max_length=10,
+                verbose_name="Locale modified",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="role",
+            name="device_created",
+            field=models.CharField(
+                blank=True, default="", max_length=10, verbose_name="Device created"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="role",
+            name="device_modified",
+            field=models.CharField(
+                blank=True, default="", max_length=10, verbose_name="Device modified"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="role",
+            name="locale_created",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Auto-updated by Modeladmin",
+                max_length=10,
+                verbose_name="Locale created",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="role",
+            name="locale_modified",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="Auto-updated by Modeladmin",
+                max_length=10,
+                verbose_name="Locale modified",
+            ),
+        ),
+    ]