clinicedc 2.0.28__py3-none-any.whl → 2.0.30__py3-none-any.whl

edc_auth/admin/role_admin.py

@@ -1,5 +1,4 @@
 from django.contrib import admin
-from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 
 from edc_model_admin.mixins import TemplatesModelAdminMixin
@@ -12,22 +11,20 @@ from ..models import Role
 class RoleAdmin(TemplatesModelAdminMixin, admin.ModelAdmin):
     fieldsets = ((None, ({"fields": ("display_name", "name", "display_index", "groups")})),)
 
-    list_display_links: tuple[str, ...] = ("display_name", "group_list")
+    list_display_links = ("display_name", "group_list")
 
-    list_display: tuple[str, ...] = ("display_name", "name", "group_list")
+    list_display = ("display_name", "name", "group_list")
 
-    filter_horizontal: tuple[str, ...] = ("groups",)
+    filter_horizontal = ("groups",)
 
-    search_fields: tuple[str, ...] = ("display_name", "name", "groups__name")
+    search_fields = ("display_name", "name", "groups__name")
 
-    ordering: tuple[str, ...] = ("display_index", "display_name")
+    ordering = ("display_index", "display_name")
 
     list_filter = ("groups__name",)
 
     @staticmethod
     def group_list(obj=None) -> str:
-        group_names = []
-        for group in obj.groups.all():
-            group_names.append(group.name)
+        group_names = [group.name for group in obj.groups.all()]
         group_names.sort()
-        return format_html("{}", mark_safe("<BR>".join(group_names)))  # nosec B703 B308
+        return mark_safe("<BR>".join(group_names))  # noqa: S308

edc_auth/admin/user_admin.py

@@ -31,8 +31,8 @@ class UserAdmin(TemplatesModelAdminMixin, BaseUserAdmin):
     show_object_tools: bool = True
 
     form = UserChangeForm
-    inlines = [UserProfileInline]
-    actions = [send_new_credentials_to_user_action]
+    inlines = (UserProfileInline,)
+    actions = (send_new_credentials_to_user_action,)
 
     list_display = (
         "username",

edc_auth/admin/user_profile_admin.py

@@ -1,5 +1,4 @@
 from django.contrib import admin
-from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 
 from edc_model_admin.mixins import TemplatesModelAdminMixin
@@ -45,21 +44,18 @@ class UserProfileAdmin(TemplatesModelAdminMixin, admin.ModelAdmin):
     @staticmethod
     def user_sites(obj=None):
         site_names = [o.name for o in obj.sites.all().order_by("name")]
-        return format_html("{}", mark_safe("<BR>".join(site_names)))  # nosec B703 B308
+        return mark_safe("<BR>".join(site_names))  # noqa: S308
 
     @staticmethod
     def user_email_notifications(obj=None):
         display_names = [
             o.display_name for o in obj.email_notifications.all().order_by("display_name")
         ]
-        return format_html("{}", mark_safe("<BR>".join(display_names)))  # nosec B703 B308
+        return mark_safe("<BR>".join(display_names))  # noqa: S308
 
     @staticmethod
     def user_sms_notifications(obj=None):
         display_names = [
             o.display_name for o in obj.sms_notifications.all().order_by("display_name")
         ]
-        return format_html(
-            "{}",
-            mark_safe("<BR>".join(display_names)),  # nosec B703, B308
-        )
+        return mark_safe("<BR>".join(display_names))  # noqa: S308

edc_auth/apps.py

@@ -11,9 +11,9 @@ class AppConfig(DjangoAppConfig):
     default_auto_field = "django.db.models.BigAutoField"
 
     def ready(self):
-        from edc_appconfig.system_checks import check_for_edc_appconfig
+        from edc_appconfig.system_checks import check_for_edc_appconfig  # noqa: PLC0415
 
-        from .system_checks import (
+        from .system_checks import (  # noqa: PLC0415
             check_auth_updater,
             check_etc_dir,
             check_site_auths,

edc_auth/auth_updater/group_updater.py

@@ -139,7 +139,7 @@ class GroupUpdater:
                     errmsg = f"{e} Got codename={codename},app_label={app_label}"
                     if not self.warn_only:
                         raise CodenameDoesNotExist(errmsg) from e
-                    warn(style.ERROR(errmsg))
+                    warn(style.ERROR(errmsg), stacklevel=2)
                 except MultipleObjectsReturned as e:
                     if not allow_multiple_objects:
                         self.delete_and_raise_on_duplicate_codenames(
@@ -219,7 +219,7 @@ class GroupUpdater:
             try:
                 model_cls = self.apps.get_model(model)
             except LookupError as e:
-                warn(f"{e}. Got {model}")
+                warn(f"{e}. Got {model}", stacklevel=2)
             else:
                 content_type = self.content_type_model_cls.objects.get_for_model(model_cls)
                 for codename_tpl in codename_tuples:
@@ -282,8 +282,8 @@ class GroupUpdater:
 
     def remove_permissions_by_codenames(
         self,
-        group: Any = None,
-        codenames: list[str] = None,
+        group,
+        codenames: list[str],
         allow_multiple_objects: bool | None = None,
     ):
         """Remove the given codenames from the given group."""

edc_auth/auth_updater/role_updater.py

@@ -36,8 +36,7 @@ class RoleUpdater:
         """
         if self.verbose:
             sys.stdout.write(style.MIGRATE_HEADING(" - Updating roles:\n"))
-        index = 0
-        for role_name, groups in self.roles.items():
+        for index, (role_name, groups) in enumerate(self.roles.items()):
             display_name = role_name.replace("_", " ").lower().title()
             if self.verbose:
                 sys.stdout.write(f"   * updating groups for {role_name}.\n")
@@ -63,7 +62,6 @@ class RoleUpdater:
                     ) from e
                     # group = self.group_model_cls.objects.create(name=group_name)
                 role.groups.add(group)
-            index += 1
         if self.verbose:
             sys.stdout.write("   Done.\n")
             sys.stdout.flush()

edc_auth/backends.py

@@ -10,7 +10,7 @@ class ModelBackendWithSite(ModelBackend):
     associated with the current SITE_ID.
     """
 
-    def authenticate(self, request, username=None, password=None, **kwargs):
+    def authenticate(self, request, username=None, password=None, **kwargs):  # noqa: ARG002
         user = super().authenticate(request, username=username, password=password)
         if user:
             sites = [obj.id for obj in user.userprofile.sites.all()]

edc_auth/export_users.py

@@ -1,11 +1,12 @@
 import csv
-from datetime import datetime
+from pathlib import Path
 
 from django.contrib.auth.models import User
+from django.utils import timezone
 
 
 def export_users(path):
-    path = path or f"edc_users_{datetime.now().strftime('%Y%m%d%H%M%S')}.csv"
+    path = path or f"edc_users_{timezone.now().strftime('%Y%m%d%H%M%S')}.csv"
     user = {
         "username": None,
         "password": None,
@@ -21,13 +22,13 @@ def export_users(path):
         "role_names": None,
     }
 
-    with open(path, "w+") as f:
+    with Path(path).open("w+") as f:
         writer = csv.DictWriter(f, fieldnames=user, delimiter="|")
         writer.writeheader()
         for user in User.objects.all().order_by("username"):
             site_names = ",".join([s.name for s in user.userprofile.sites.all()])
             role_names = ",".join([g.name for g in user.userprofile.roles.all()])
-            user = {
+            user = {  # noqa: PLW2901
                 "username": user.username,
                 "password": user.password,
                 "is_staff": user.is_staff,
@@ -42,4 +43,4 @@ def export_users(path):
                 "role_names": role_names or "",
             }
             writer.writerow(user)
-    print(f"Done. See file `{path}` in the current directory.")
+    print(f"Done. See file `{path}` in the current directory.")  # noqa: T201

edc_auth/fix_export_permissions.py

@@ -33,23 +33,23 @@ class ExportPermissionsFixer:
         """
 
         if self.verbose:
-            print("Adding `import` and `export` to default permissions.")
+            print("Adding `import` and `export` to default permissions.")  # noqa: T201
         for app_config in self.app_configs:
             if self.verbose:
-                print(f"  * updating {app_config.name}")
+                print(f"  * updating {app_config.name}")  # noqa: T201
             for model in app_config.get_models():
                 self.fix_for_model(model)
         if self.verbose:
-            print("Done")
+            print("Done")  # noqa: T201
 
     def fix_for_model(self, model):
-        from edc_model import models as edc_models
+        from edc_model import models as edc_models  # noqa: PLC0415
 
         if issubclass(model, (edc_models.BaseUuidModel,)):
             permission_model_cls = django_apps.get_model("auth.permission")
             content_type_model_cls = django_apps.get_model("contenttypes.contenttype")
             if self.verbose:
-                print(f"    - {model._meta.label_lower}")
+                print(f"    - {model._meta.label_lower}")  # noqa: T201
             try:
                 app_label, model_name = model._meta.label_lower.split(".")
                 content_type = content_type_model_cls.objects.get(
@@ -58,9 +58,9 @@ class ExportPermissionsFixer:
                 )
             except ObjectDoesNotExist as e:
                 if self.warn_only:
-                    warn(f"ObjectDoesNotExist: {e} Got {model}.")
+                    warn(f"ObjectDoesNotExist: {e} Got {model}.", stacklevel=2)
                 else:
-                    raise ObjectDoesNotExist(f"{e} Got {model}.")
+                    raise ObjectDoesNotExist(f"{e} Got {model}.") from e
             else:
                 for action in ["import", "export"]:
                     codename = f"{action}_{model._meta.label_lower.split('.')[1]}"
@@ -71,7 +71,7 @@ class ExportPermissionsFixer:
                         opts.update(name=f"Can {action} {model._meta.verbose_name}")
                         permission_model_cls.objects.create(**opts)
                         if self.verbose:
-                            print(f"       created for {model._meta.label_lower}")
+                            print(f"       created for {model._meta.label_lower}")  # noqa: T201
                     else:
                         obj.name = f"Can {action} {model._meta.verbose_name}"
                         obj.save()

edc_auth/forms.py

@@ -45,36 +45,33 @@ class UserProfileForm(forms.ModelForm):
                 raise forms.ValidationError(
                     {
                         "is_multisite_viewer": (
-                            "Invalid. User has change permissions to other objects. "
-                            f"Got {c}"
+                            f"Invalid. User has change permissions to other objects. Got {c}"
                         )
                     }
                 )
 
         qs = self.cleaned_data.get("email_notifications")
-        if qs and qs.count() > 0:
-            if not get_email_enabled():
-                raise forms.ValidationError(
-                    {
-                        "email_notifications": (
-                            "You may not choose an email "
-                            "notification. Email is not enabled. "
-                            "Contact your EDC administrator."
-                        )
-                    }
-                )
+        if qs and qs.count() > 0 and not get_email_enabled():
+            raise forms.ValidationError(
+                {
+                    "email_notifications": (
+                        "You may not choose an email "
+                        "notification. Email is not enabled. "
+                        "Contact your EDC administrator."
+                    )
+                }
+            )
         qs = self.cleaned_data.get("sms_notifications")
-        if qs and qs.count() > 0:
-            if not settings.TWILIO_ENABLED:
-                raise forms.ValidationError(
-                    {
-                        "sms_notifications": (
-                            "You may not choose an SMS "
-                            "notification. SMS is not enabled. "
-                            "Contact your EDC administrator."
-                        )
-                    }
-                )
+        if qs and qs.count() > 0 and not settings.TWILIO_ENABLED:
+            raise forms.ValidationError(
+                {
+                    "sms_notifications": (
+                        "You may not choose an SMS "
+                        "notification. SMS is not enabled. "
+                        "Contact your EDC administrator."
+                    )
+                }
+            )
         qs = self.cleaned_data.get("roles")
         if qs and qs.count() > 0:
             for role in qs:

edc_auth/get_app_codenames.py

@@ -38,7 +38,7 @@ def get_app_codenames(
         pass
     else:
         for model_cls in get_models(app_config, exclude_models):
-            codenames.append(f"{app_config.name}.view_{model_cls._meta.model_name}")
+            codenames.append(f"{app_config.name}.view_{model_cls._meta.model_name}")  # noqa: PERF401
     for name in crud_apps:
         try:
             app_config = django_apps.get_app_config(name)
@@ -80,5 +80,5 @@ def get_codename(
             ]
         prefixes = [f"{s}_" for s in permissions]
         for prefix in prefixes:
-            codenames.append(f"{app_name}.{prefix}{model_name}")
+            codenames.append(f"{app_name}.{prefix}{model_name}")  # noqa: PERF401
     return codenames

edc_auth/import_users.py

@@ -1,7 +1,7 @@
 import csv
-import os
 import re
-from datetime import datetime
+import sys
+from pathlib import Path
 from string import Template
 from typing import Any
 
@@ -9,6 +9,7 @@ from django.contrib.auth.models import User
 from django.contrib.sites.models import Site
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.mail import EmailMessage
+from django.utils import timezone
 from mempass import PasswordGenerator
 
 from edc_protocol.research_protocol_config import ResearchProtocolConfig
@@ -89,8 +90,8 @@ def import_users(
     site_names: a comma-separated list of sites
     role_names: a comma-separated list of roles
     """
-    path = os.path.expanduser(path)
-    with open(path) as f:
+    path = Path(path)
+    with path.open() as f:
         reader = csv.DictReader(f, delimiter="|")
         for csv_data in reader:
             opts: dict = {}
@@ -111,8 +112,8 @@ def import_users(
             opts.update(email=csv_data.get("email"))
             opts.update(alternate_email=csv_data.get("alternate_email"))
             opts.update(job_title=csv_data.get("job_title"))
-            opts.update(is_active=True if csv_data.get("is_active") == "True" else False)
-            opts.update(is_staff=True if csv_data.get("is_staff") == "True" else False)
+            opts.update(is_active=csv_data.get("is_active") == "True")
+            opts.update(is_staff=csv_data.get("is_staff") == "True")
             UserImporter(
                 resource_name=resource_name,
                 send_email_to_user=send_email_to_user,
@@ -122,7 +123,7 @@ def import_users(
                 **kwargs,
             )
     if export_to_file:
-        export_users(f"edc_users_imported_{datetime.now().strftime('%Y%m%d%H%M%S')}")
+        export_users(f"edc_users_imported_{timezone.now().strftime('%Y%m%d%H%M%S')}")
 
 
 class UserImporter:
@@ -133,18 +134,18 @@ class UserImporter:
 
     def __init__(
         self,
-        username: str = None,
-        first_name: str = None,
-        last_name: str = None,
-        job_title: str = None,
-        email: str = None,
-        alternate_email: str = None,
-        mobile: str = None,
-        site_names: list[str] = None,
-        role_names: list[str] = None,
-        is_active: bool = None,
-        is_staff: bool = None,
-        resource_name: str = None,
+        username: str | None = None,
+        first_name: str | None = None,
+        last_name: str | None = None,
+        job_title: str | None = None,
+        email: str | None = None,
+        alternate_email: str | None = None,
+        mobile: str | None = None,
+        site_names: list[str] | None = None,
+        role_names: list[str] | None = None,
+        is_active: bool | None = None,
+        is_staff: bool | None = None,
+        resource_name: str | None = None,
         created_email_template: Template | None = None,
         updated_email_template: Template | None = None,
         send_email_to_user: Any | None = None,
@@ -200,7 +201,7 @@ class UserImporter:
             try:
                 self.email_message.send(fail_silently=False)
             except ConnectionRefusedError:
-                print(self.email_message.body)
+                sys.stdout.write(f"{self.email_message.body}\n")
 
     def validate_username(self) -> None:
         if not self.username:
@@ -241,12 +242,12 @@ class UserImporter:
         for site_name in site_names:
             try:
                 site = Site.objects.get(name=site_name)
-            except ObjectDoesNotExist:
+            except ObjectDoesNotExist as e:
                 sites = [s.name for s in Site.objects.all()]
                 raise UserImporterError(
                     f"Unknown site for user. Expected one of {sites}. "
                     f"Got {self.user.username}, {site_name}."
-                )
+                ) from e
             else:
                 self.user.userprofile.sites.add(site)
 
@@ -256,11 +257,11 @@ class UserImporter:
         for role_name in role_names:
             try:
                 role = Role.objects.get(name__iexact=role_name)
-            except ObjectDoesNotExist:
+            except ObjectDoesNotExist as e:
                 raise UserImporterError(
                     f"Unknown role for user. Got role `{role_name}` "
                     f"for user `{self.user.username}`"
-                )
+                ) from e
             else:
                 self.user.userprofile.roles.add(role)
 

edc_auth/management/commands/export_users.py

@@ -25,5 +25,5 @@ class Command(BaseCommand):
             help="Export new users to file",
         )
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options):  # noqa: ARG002
         export_users(options["csvfile"])

edc_auth/management/commands/fix_export_permissions.py

@@ -4,6 +4,6 @@ from edc_auth.fix_export_permissions import ExportPermissionsFixer
 
 
 class Command(BaseCommand):
-    def handle(self, *args, **options):
+    def handle(self, *args, **options):  # noqa: ARG002
         fixer = ExportPermissionsFixer()
         fixer.fix()

edc_auth/management/commands/import_users.py

@@ -65,7 +65,7 @@ class Command(BaseCommand):
             help="Limit import to a single username",
         )
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options):  # noqa: ARG002
         import_users(
             options["csvfile"],
             resource_name=options["resource_name"],

edc_auth/management/commands/reset_password.py

@@ -25,11 +25,11 @@ class Command(BaseCommand):
             "--email", action="store_true", dest="email", help="Alternate email"
         )
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options):  # noqa: ARG002
         try:
             user = User.objects.get(username=options["username"])
         except ObjectDoesNotExist as e:
-            raise CommandError(e)
+            raise CommandError(e) from e
         else:
             p = PasswordSetter(super_username=options["super_user"])
             p.reset_user(username=options["username"])

edc_auth/models/signals.py

@@ -10,7 +10,7 @@ from .user_profile import UserProfile
 def update_user_profile_on_post_save(sender, instance, raw, **kwargs):
     if not raw:
         try:
-            instance.userprofile
+            instance.userprofile  # noqa: B018
         except ObjectDoesNotExist:
             UserProfile.objects.create(user=instance)
 

edc_auth/models/user_profile.py

@@ -4,7 +4,6 @@ from django.core.validators import RegexValidator
 from django.db import models
 from django.db.models.deletion import CASCADE
 from django.utils.html import format_html
-from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
 from edc_export.choices import EXPORT_FORMATS
@@ -50,7 +49,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
-            href=mark_safe("/edc_label/"),  # nosec B703, B308
+            href="/edc_label/",
             label="Edc Label Administration",
         ),
     )
@@ -61,7 +60,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
-            href=mark_safe("/edc_label/"),  # nosec B703, B308
+            href="/edc_label/",
             label="Edc Label Administration",
         ),
     )
@@ -72,7 +71,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
         blank=True,
         help_text=format_html(
             'Change in <a href="{href}">{label}</a>',
-            href=mark_safe("/edc_label/"),  # nosec B703, B308
+            href="/edc_label/",
             label="Edc Label Administration",
         ),
     )
@@ -91,7 +90,7 @@ class UserProfile(NotificationUserProfileModelMixin, models.Model):
     def __str__(self):
         return self.user.username
 
-    def add_groups_for_roles(self, pk_set):
+    def add_groups_for_roles(self, pk_set):  # noqa: ARG002
         """Add groups to this user for the selected roles.
 
         Called by m2m signal.

edc_auth/password_setter.py

@@ -37,17 +37,17 @@ class PasswordSetter:
     def get_administrator_fullname(super_username: str) -> str:
         try:
             obj = User.objects.get(username=super_username)
-        except ObjectDoesNotExist:
+        except ObjectDoesNotExist as e:
             raise PasswordSetterError(
                 "Need the username of the administrator / super user. Got None."
-            )
+            ) from e
         return f"{obj.first_name} {obj.last_name}"
 
     def reset_all(self) -> None:
         users = User.objects.filter(is_active=True, is_staff=True, is_superuser=False)
         self._reset(users)
 
-    def reset_by_groups(self, group_names: list[str] = None) -> None:
+    def reset_by_groups(self, group_names: list[str]) -> None:
         users = User.objects.filter(
             groups__name__in=group_names,
             is_active=True,
@@ -64,7 +64,7 @@ class PasswordSetter:
         usernames = [username]
         self.reset_users(usernames)
 
-    def reset_by_sites(self, site_names: list[str] = None) -> None:
+    def reset_by_sites(self, site_names: list[str]) -> None:
         users = User.objects.filter(
             userprofile__sites__name__in=site_names,
             is_active=True,

edc_auth/post_migrate_signals.py

@@ -9,8 +9,8 @@ style = color_style()
 def post_migrate_user_groups_and_roles(sender=None, **kwargs):
     """Update Groups, Role model with EDC defaults."""
 
-    from .auth_updater import AuthUpdater
-    from .auth_updater.group_updater import CodenameDoesNotExist
+    from .auth_updater import AuthUpdater  # noqa: PLC0415
+    from .auth_updater.group_updater import CodenameDoesNotExist  # noqa: PLC0415
 
     try:
         AuthUpdater(apps=django_apps, verbose=True)

edc_auth/send_new_credentials_to_user.py

@@ -18,7 +18,7 @@ def change_password(user, nwords: int | None = None) -> str:
     return password
 
 
-def send_new_credentials_to_user(user, nwords: int | None = None) -> EmailMessage:
+def send_new_credentials_to_user(user, nwords: int | None = None) -> int:
     body = change_user_template
     site_names = "\n - ".join([s.name for s in user.userprofile.sites.all()])
     role_names = "\n - ".join([r.display_name for r in user.userprofile.roles.all()])

edc_auth/system_checks.py

@@ -1,7 +1,8 @@
 import os
+from pathlib import Path
 
 from django.conf import settings
-from django.core.checks import CheckMessage, Warning
+from django.core.checks import CheckMessage, Warning  # noqa: A004
 from django.core.management import color_style
 
 style = color_style()
@@ -10,7 +11,7 @@ style = color_style()
 def check_etc_dir(app_configs, **kwargs) -> list[CheckMessage]:
     errors = []
     try:
-        settings.ETC_DIR
+        settings.ETC_DIR  # noqa: B018
     except AttributeError:
         pass
     else:
@@ -37,11 +38,11 @@ def check_etc_dir(app_configs, **kwargs) -> list[CheckMessage]:
 def check_static_root(app_configs, **kwargs) -> list[CheckMessage]:
     errors = []
     try:
-        settings.STATIC_ROOT
+        settings.STATIC_ROOT  # noqa: B018
     except AttributeError:
         pass
     else:
-        if settings.STATIC_ROOT and not os.path.exists(settings.STATIC_ROOT):
+        if settings.STATIC_ROOT and not Path(settings.STATIC_ROOT).exists():
             errors.append(
                 Warning(
                     f"Folder does not exist. Got {settings.STATIC_ROOT}",
@@ -54,7 +55,7 @@ def check_static_root(app_configs, **kwargs) -> list[CheckMessage]:
 def check_auth_updater(app_configs, **kwargs) -> list[CheckMessage]:
     errors = []
     try:
-        settings.EDC_AUTH_SKIP_AUTH_UPDATER
+        settings.EDC_AUTH_SKIP_AUTH_UPDATER  # noqa: B018
     except AttributeError:
         pass
     else:
@@ -72,7 +73,7 @@ def check_auth_updater(app_configs, **kwargs) -> list[CheckMessage]:
 def check_site_auths(app_configs, **kwargs) -> list[CheckMessage]:
     errors = []
     try:
-        settings.EDC_AUTH_SKIP_AUTH_UPDATER
+        settings.EDC_AUTH_SKIP_AUTH_UPDATER  # noqa: B018
     except AttributeError:
         pass
     else: