clinicedc 2.0.23__py3-none-any.whl → 2.0.25__py3-none-any.whl

edc_screening/utils.py

@@ -40,10 +40,8 @@ def format_reasons_ineligible(*str_values: str | None, delimiter: str | None = N
     str_values = str_values or []
     str_values = tuple(x for x in str_values if x)
     if str_values:
-        reasons = format_html(
-            "{}",
-            mark_safe(delimiter.join(str_values)),  # noqa: S308
-        )
+        formatted_string = delimiter.join(str_values)
+        reasons = mark_safe(formatted_string)  # noqa: S308
     return reasons
 
 
@@ -120,15 +118,15 @@ def is_eligible_or_raise(
             if url and url_name.endswith("changelist"):
                 url = f"{url}?q={subject_screening.screening_identifier}"
         if not url:
-            msg = format_html(
-                "{}",
+            safe_string = mark_safe(  # noqa: S308
                 "Not allowed. Subject is not eligible. "
-                f"Got {subject_screening.screening_identifier}",
+                f"Got {subject_screening.screening_identifier}.",
             )
         else:
-            msg = format_html(
-                'Not allowed. Subject is not eligible. See subject <A href="{}">{}</A>',
-                mark_safe(url),  # noqa: S308
-                subject_screening.screening_identifier,
+            safe_string = format_html(
+                "Not allowed. Subject is not eligible. See subject "
+                '<A href="{url}">{screening_identifier}</A>',
+                url=url,
+                screening_identifier=subject_screening.screening_identifier,
             )
-        raise forms.ValidationError(msg)
+        raise forms.ValidationError(safe_string)

edc_sites/admin/list_filters.py

@@ -17,10 +17,10 @@ class SiteListFilter(SimpleListFilter):
         else:
             site_ids = sites.get_site_ids_for_user(request=request)
         for site in Site.objects.filter(id__in=site_ids).order_by("id"):
-            names.append((site.id, f"{site.id} {sites.get(site.id).description}"))
+            names.append((site.id, f"{site.id} {sites.get(site.id).description}"))  # noqa: PERF401
         return tuple(names)
 
-    def queryset(self, request, queryset):
+    def queryset(self, request, queryset):  # noqa: ARG002
         if self.value() and self.value() != "none":
             queryset = queryset.filter(site__id=self.value())
         return queryset

edc_sites/admin/site_model_admin_mixin.py

@@ -46,7 +46,7 @@ class SiteModelAdminMixin:
             ]
         return sites.get_view_only_site_ids_for_user(request=request)
 
-    def has_viewallsites_permission(self, request, obj=None) -> bool:
+    def has_viewallsites_permission(self, request, obj=None) -> bool:  # noqa: ARG002
         """Checks if the user has the EDC custom codename
         "viewallsites" for this model.
 
@@ -54,7 +54,7 @@ class SiteModelAdminMixin:
         """
         opts = self.opts
         codename_allsites = get_permission_codename("viewallsites", opts)
-        return request.user.has_perm("%s.%s" % (opts.app_label, codename_allsites))
+        return request.user.has_perm(f"{opts.app_label}.{codename_allsites}")
 
     @admin.display(description="Site", ordering="site__id")
     def site_code(self, obj=None):
@@ -75,7 +75,7 @@ class SiteModelAdminMixin:
         to mulitple sites.
         """
         list_filter = super().get_list_filter(request)
-        list_filter = [x for x in list_filter if x != "site" and x != SiteListFilter]
+        list_filter = [x for x in list_filter if x not in ("site", SiteListFilter)]
         if self.user_may_view_other_sites(request) or self.has_viewallsites_permission(
             request
         ):
@@ -95,25 +95,25 @@ class SiteModelAdminMixin:
             or self.has_viewallsites_permission(request)
         ) and "site" not in list_display:
             list_display = tuple(list_display)
-            list_display = list_display[:pos] + (self.site_code,) + list_display[pos:]
+            list_display = list_display[:pos], self.site_code, list_display[pos:]
         elif "site" in list_display:
             list_display = tuple(
                 [x for x in list_display if x not in ["site", self.site_code]]
             )
-            list_display = list_display[:pos] + (self.site_code,) + list_display[pos:]
+            list_display = list_display[:pos], self.site_code, list_display[pos:]
         return list_display
 
     def get_queryset(self, request) -> QuerySet:
         """Limit modeladmin queryset for the current site only"""
         qs = super().get_queryset(request)
-        site_ids = [request.site.id] + self.get_view_only_site_ids_for_user(request=request)
+        site_ids = (request.site.id, *self.get_view_only_site_ids_for_user(request=request))
         try:
             qs = qs.select_related("site").filter(site_id__in=site_ids)
-        except FieldError:
+        except FieldError as e:
             raise SiteModeAdminMixinError(
                 f"Model missing field `site`. Model `{self.model}`. Did you mean to use "
                 f"the SiteModelAdminMixin? See `{self}`."
-            )
+            ) from e
         return qs
 
     def get_form(self, request, obj=None, change=False, **kwargs):

edc_sites/exceptions.py

@@ -6,5 +6,5 @@ class InvalidSiteForSubjectError(Exception):
     pass
 
 
-class InvalidSiteForUser(Exception):
+class InvalidSiteForUser(Exception):  # noqa: N818
     pass

edc_sites/forms.py

@@ -1 +1,3 @@
-from .modelform_mixins import SiteModelFormMixin  # noqa
+from .modelform_mixins import SiteModelFormMixin
+
+__all__ = ["SiteModelFormMixin"]

edc_sites/management/commands/sync_sites.py

@@ -4,6 +4,8 @@ import sys
 from django.conf import settings
 from django.core.management.base import BaseCommand
 from django.core.management.color import color_style
+from multisite.models import Alias
+from multisite.utils import create_or_sync_canonical_from_all_sites
 
 from edc_sites.site import sites as site_sites
 from edc_sites.utils import add_or_update_django_sites
@@ -15,7 +17,6 @@ class Command(BaseCommand):
     help = "Add / Update django Site model after changes to edc_sites"
 
     def add_arguments(self, parser):
-
         parser.add_argument(
             "--ping-hosts",
             default=False,
@@ -32,26 +33,19 @@ class Command(BaseCommand):
             help="Suggest ALLOWED_HOSTS",
         )
 
-    def handle(self, *args, **options) -> None:
+    def handle(self, *args, **options) -> None:  # noqa: ARG002
         sys.stdout.write("\n\n")
         sys.stdout.write(" Edc Sites : Adding / Updating sites ...     \n")
         add_or_update_django_sites(verbose=True)
-        if (
-            "multisite" in settings.INSTALLED_APPS
-            or "multisite.apps.AppConfig" in settings.INSTALLED_APPS
-        ):
-            from multisite.models import Alias
-            from multisite.utils import create_or_sync_canonical_from_all_sites
-
-            sys.stdout.write("\n Multisite. \n")
-            create_or_sync_canonical_from_all_sites(verbose=True)
+        sys.stdout.write("\n Multisite. \n")
+        create_or_sync_canonical_from_all_sites(verbose=True)
 
-            sys.stdout.write("    multisite.Alias \n")
-            for obj in Alias.objects.all():
-                sys.stdout.write(
-                    f"      - Site model: {obj.site.id}: {obj.domain} "
-                    f"is_canonical={obj.is_canonical}.\n"
-                )
+        sys.stdout.write("    multisite.Alias \n")
+        for obj in Alias.objects.all():
+            sys.stdout.write(
+                f"      - Site model: {obj.site.id}: {obj.domain} "
+                f"is_canonical={obj.is_canonical}.\n"
+            )
         arg = [arg for arg in sys.argv if arg.startswith("--settings")]
         sys.stdout.write(f"\n Settings: reading from {arg}")
         sys.stdout.write("\n\n Current value of settings.ALLOWED_HOSTS\n")

edc_sites/models/site_profile.py

@@ -5,17 +5,19 @@ import json
 from django.contrib.sites.models import Site
 from django.db import models
 
+from edc_constants.constants import NULL_STRING
+
 
 class SiteProfile(models.Model):
     id = models.BigAutoField(primary_key=True)
 
-    country = models.CharField(max_length=250, default="")
+    country = models.CharField(max_length=250, default=NULL_STRING)
 
-    country_code = models.CharField(max_length=15, default="")
+    country_code = models.CharField(max_length=15, default=NULL_STRING)
 
-    languages = models.TextField(default="")
+    languages = models.TextField(default=NULL_STRING)
 
-    title = models.CharField(max_length=250, default="")
+    title = models.CharField(max_length=250, default=NULL_STRING)
 
     site = models.OneToOneField(Site, on_delete=models.PROTECT)
 

edc_sites/post_migrate_signals.py

@@ -6,8 +6,8 @@ style = color_style()
 
 
 def post_migrate_update_sites(sender=None, **kwargs):
-    from .site import sites as site_sites
-    from .utils import add_or_update_django_sites
+    from .site import sites as site_sites  # noqa: PLC0415
+    from .utils import add_or_update_django_sites  # noqa: PLC0415
 
     sys.stdout.write(style.MIGRATE_HEADING("Updating sites:\n"))
 

edc_sites/site.py

@@ -52,23 +52,23 @@ __all__ = [
 ]
 
 
-class SiteDoesNotExist(Exception):
+class SiteDoesNotExist(Exception):  # noqa: N818
     pass
 
 
-class AlreadyRegistered(Exception):
+class AlreadyRegistered(Exception):  # noqa: N818
     pass
 
 
-class AlreadyRegisteredName(Exception):
+class AlreadyRegisteredName(Exception):  # noqa: N818
     pass
 
 
-class AlreadyRegisteredDomain(Exception):
+class AlreadyRegisteredDomain(Exception):  # noqa: N818
     pass
 
 
-class SiteNotRegistered(Exception):
+class SiteNotRegistered(Exception):  # noqa: N818
     pass
 
 
@@ -157,7 +157,7 @@ class Sites:
             for single_site in single_sites:
                 if get_insert_uat_subdomain():
                     domain = insert_into_domain(single_site.domain, self.uat_subdomain)
-                    single_site = dataclasses.replace(single_site, domain=domain)
+                    single_site = dataclasses.replace(single_site, domain=domain)  # noqa: PLW2901
 
                 if single_site.site_id in self._registry:
                     raise AlreadyRegistered(f"Site already registered. Got `{single_site}`.")
@@ -282,8 +282,8 @@ class Sites:
     def user_may_view_other_sites(
         self,
         request: WSGIRequest = None,
-        user: User = None,
-        site_id: int = None,
+        user: User | None = None,
+        site_id: int | None = None,
     ) -> list[int]:
         return self.get_view_only_site_ids_for_user(
             request=request,

edc_sites/utils/add_or_update_django_sites.py

@@ -15,14 +15,14 @@ class UpdateDjangoSitesError(Exception):
 
 
 def get_sites():
-    from ..site import sites  # prevent circular import
+    from ..site import sites  # prevent circular import  # noqa: PLC0415
 
     return sites
 
 
 def add_or_update_django_sites(
-    apps: django_apps | None = None,
-    single_sites: list[SingleSite] | tuple[SingleSite] = None,
+    apps=None,
+    single_sites: list[SingleSite] | tuple[SingleSite] | None = None,
     verbose: bool | None = None,
 ):
     """Removes default site and adds/updates given `sites`, etc.

edc_sites/utils/valid_site_for_subject_or_raise.py

@@ -30,7 +30,10 @@ def valid_site_for_subject_or_raise(
         subject_identifier, raise_exception=True
     )
     if skip_get_current_site:
-        warn("Skipping validation of current site against registered subject site.")
+        warn(
+            "Skipping validation of current site against registered subject site.",
+            stacklevel=2,
+        )
         site_obj = registered_subject.site
     else:
         site_obj: Site = get_site_model_cls().objects.get_current()
@@ -40,15 +43,15 @@ def valid_site_for_subject_or_raise(
                 site=site_obj,
                 raise_exception=True,
             )
-        except RegisteredSubjectDoesNotExist:
+        except RegisteredSubjectDoesNotExist as e:
             if not registered_subject.site_id:
                 raise InvalidSiteForSubjectError(
                     "Site not defined for registered subject! "
                     f"Subject identifier=`{subject_identifier}`. "
-                )
+                ) from e
             raise InvalidSiteForSubjectError(
                 f"Invalid site for subject. Subject identifier=`{subject_identifier}`. "
                 f"Expected `{registered_subject.site.name}`. "
                 f"Got site_id=`{site_obj.id}`"
-            )
+            ) from e
     return site_obj

edc_sites/view_mixins.py

@@ -19,10 +19,10 @@ class SiteViewMixin:
         kwargs.update(site_profile=site_profile)
         try:
             kwargs.update(site_title=site_profile.title)
-        except AttributeError:
+        except AttributeError as e:
             if not sites.all():
                 raise SiteNotRegistered(
                     "Unable to determine site profile 'title'. No sites have been registered! "
-                )
+                ) from e
             raise
         return kwargs

edc_subject_dashboard/view_utils/subject_screening_button.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING
 from uuid import UUID
 
 from django.contrib.sites.models import Site
@@ -11,16 +11,18 @@ from django.utils.translation import gettext as _
 from edc_view_utils import DashboardModelButton
 
 if TYPE_CHECKING:
+    from edc_model.models import BaseUuidModel
     from edc_screening.model_mixins import ScreeningModelMixin
 
-    ScreeningModel = TypeVar("ScreeningModel", bound=ScreeningModelMixin)
+    class ScreeningModel(ScreeningModelMixin, BaseUuidModel): ...
+
 
 __all__ = ["SubjectScreeningButton"]
 
 
 @dataclass
 class SubjectScreeningButton(DashboardModelButton):
-    model_obj: ScreeningModel = None
+    model_obj: ScreeningModel | None = None
     metadata_model_obj: models.Model = field(init=False)
 
     def __post_init__(self):

edc_view_utils/dashboard_model_button.py

@@ -34,9 +34,9 @@ class DashboardModelButton(ModelButton):
 
     """
 
-    model_obj: CrfModel | RequisitionModel = field(init=False)
-    metadata_model_obj: CrfMetadata | RequisitionMetadata = None
-    appointment: Appointment = None
+    model_obj: CrfModel | RequisitionModel | None = None
+    metadata_model_obj: CrfMetadata | RequisitionMetadata | None = None
+    appointment: Appointment | None = None
     next_url_name: str = field(default="subject_dashboard_url")
     model_cls: type[CrfModel | RequisitionModel] = field(default=None, init=False)
 

edc_visit_schedule/site_visit_schedules.py

@@ -93,7 +93,8 @@ class SiteVisitSchedules:
         return visit_schedules or self.registry
 
     def get_by_consent_definition(
-        self, cdef: ConsentDefinition
+        self,
+        cdef: ConsentDefinition,
     ) -> tuple[VisitSchedule, Schedule]:
         """Returns a visit schedule instance or raises."""
         ret = []