clinicedc 2.0.7__py3-none-any.whl → 2.0.9__py3-none-any.whl

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/0036_alter_userprofile_alternate_email_and_more.py

@@ -0,0 +1,88 @@
+# Generated by Django 5.2.6 on 2025-09-22 12:31
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("edc_auth", "0035_alter_edcpermissions_device_created_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="userprofile",
+            name="alternate_email",
+            field=models.EmailField(
+                blank=True,
+                default="",
+                max_length=254,
+                verbose_name="Alternate email address",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="clinic_label_printer",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text='Change in <a href="/edc_label/">Edc Label Administration</a>',
+                max_length=100,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="export_format",
+            field=models.CharField(
+                blank=True,
+                choices=[
+                    ("CSV", "CSV (delimited by pipe `|`)"),
+                    (114, "Stata v10 or later"),
+                    (117, "Stata v13 or later"),
+                    (118, "Stata v14 or later"),
+                    (119, "Stata v15 or later"),
+                ],
+                default="CSV",
+                help_text="Note: requires export permissions",
+                max_length=25,
+                verbose_name="Export format",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="job_title",
+            field=models.CharField(blank=True, default="", max_length=100),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="lab_label_printer",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text='Change in <a href="/edc_label/">Edc Label Administration</a>',
+                max_length=100,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="mobile",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="e.g. +1234567890",
+                max_length=25,
+                validators=[django.core.validators.RegexValidator(regex="^\\+\\d+")],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="userprofile",
+            name="print_server",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text='Change in <a href="/edc_label/">Edc Label Administration</a>',
+                max_length=100,
+            ),
+        ),
+    ]

edc_auth/models/user_profile.py

@@ -11,7 +11,7 @@ from edc_export.choices import EXPORT_FORMATS
 from edc_export.constants import CSV
 from edc_notification.model_mixins import NotificationUserProfileModelMixin
 
-from ..auth_objects import CUSTOM_ROLE, STAFF_ROLE
+from ..constants import CUSTOM_ROLE, STAFF_ROLE
 from .role import Role
 
 
@@ -32,21 +32,21 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
 
     sites = models.ManyToManyField(Site, blank=True)
 
-    job_title = models.CharField(max_length=100, null=True, blank=True)
+    job_title = models.CharField(max_length=100, default="", blank=True)
 
-    alternate_email = models.EmailField(_("Alternate email address"), blank=True, null=True)
+    alternate_email = models.EmailField(_("Alternate email address"), blank=True, default="")
 
     mobile = models.CharField(
         max_length=25,
         validators=[RegexValidator(regex=r"^\+\d+")],
-        null=True,
+        default="",
         blank=True,
         help_text="e.g. +1234567890",
     )
 
     clinic_label_printer = models.CharField(
         max_length=100,
-        null=True,
+        default="",
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
@@ -57,7 +57,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
 
     lab_label_printer = models.CharField(
         max_length=100,
-        null=True,
+        default="",
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
@@ -68,7 +68,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
 
     print_server = models.CharField(
         max_length=100,
-        null=True,
+        default="",
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
@@ -82,7 +82,6 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
         max_length=25,
         choices=EXPORT_FORMATS,
         default=CSV,
-        null=True,
         blank=True,
         help_text="Note: requires export permissions",
     )
@@ -101,9 +100,13 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
             group_names = [group.name for group in self.user.groups.all()]
             add_group_names = []
             for role in self.roles.all():
-                for group in role.groups.all():
-                    if group.name not in group_names:
-                        add_group_names.append(group.name)
+                add_group_names.extend(
+                    [
+                        group.name
+                        for group in role.groups.all()
+                        if group.name not in group_names
+                    ]
+                )
             add_group_names = list(set(add_group_names))
             for name in add_group_names:
                 self.user.groups.add(Group.objects.get(name=name))