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

edc_search/generate_slug.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from django.utils.text import slugify
+from django_crypto_fields.utils import get_encrypted_field_names
+
+SLUG_SEP = "|"
+
+
+def generate_slug(obj, fields) -> str | None:
+    """Returns a slug of the char values of the fields
+    listed on the models get_search_slug_fields() method.
+
+    Excludes any encrypted fields if listed.
+    """
+    slug = None
+    if obj and fields:
+        values = []
+        for field in (f for f in fields if f not in get_encrypted_field_names(obj)):
+            v = obj
+            for f in field.split("."):
+                v = getattr(v, f)
+            if isinstance(v, str):
+                values.append(v[:50])  # truncate value
+        slugs = [slugify(v) for v in list(set(values)) if v]
+        slug = SLUG_SEP.join(slugs)[:250]
+    return slug

edc_search/model_mixins.py

@@ -1,42 +1,31 @@
 from django.db import models
+from tqdm import tqdm
 
-from .updater import SearchSlugUpdater
+from .generate_slug import generate_slug
 
 
 class SearchSlugManager(models.Manager):
-    search_slug_updater_cls = SearchSlugUpdater
-    search_slug_field_name = "slug"
-
     def update_search_slugs(self) -> None:
-        for obj in self.all():
-            updater = self.search_slug_updater_cls(
-                fields=obj.get_search_slug_fields(), model_obj=obj
-            )
-            setattr(obj, self.search_slug_field_name, updater.slug)
-            obj.save_base(update_fields=[self.search_slug_field_name])
+        qs = self.all()
+        for obj in tqdm(qs, total=qs.count()):
+            obj.slug = generate_slug(obj, obj.get_search_slug_fields()) or ""
+            obj.save_base(update_fields=["slug"])
 
 
 class SearchSlugModelMixin(models.Model):
-    search_slug_warning = None
-    search_slug_updater_cls = SearchSlugUpdater
-
-    def get_search_slug_fields(self) -> tuple[str] | None:
-        return None
+    def get_search_slug_fields(self) -> tuple[str, ...]:
+        return ()
 
     slug = models.CharField(
         max_length=250,
         default="",
         editable=False,
         db_index=True,
-        help_text="a field used for quick search",
+        help_text="Hold slug field values for quick search. Excludes encrypted fields",
     )
 
     def save(self, *args, **kwargs):
-        updater = self.search_slug_updater_cls(
-            fields=self.get_search_slug_fields(), model_obj=self
-        )
-        self.search_slug_warning = updater.warning
-        self.slug = updater.slug
+        self.slug = generate_slug(self, self.get_search_slug_fields()) or ""
         super().save(*args, **kwargs)
 
     class Meta:

edc_sites/auths.py

@@ -1,6 +1,11 @@
 from edc_auth.site_auths import site_auths
 from edc_auth.utils import remove_default_model_permissions_from_edc_permissions
 
-site_auths.add_post_update_func(
-    "edc_sites", remove_default_model_permissions_from_edc_permissions
-)
+
+def update_site_auths() -> None:
+    site_auths.add_post_update_func(
+        "edc_sites", remove_default_model_permissions_from_edc_permissions
+    )
+
+
+update_site_auths()

edc_subject_dashboard/auths.py

@@ -7,30 +7,35 @@ from edc_auth.constants import (
 from edc_auth.site_auths import site_auths
 from edc_auth.utils import remove_default_model_permissions_from_edc_permissions
 
-site_auths.add_post_update_func(
-    "edc_subject_dashboard", remove_default_model_permissions_from_edc_permissions
-)
-
 SUBJECT_VIEW = "SUBJECT_VIEW"
 
-site_auths.add_custom_permissions_tuples(
-    model="edc_subject_dashboard.edcpermissions",
-    codename_tuples=(
-        (
-            "edc_subject_dashboard.view_subject_listboard",
-            "Can access subject listboard",
+
+def update_site_auths() -> None:
+    site_auths.add_post_update_func(
+        "edc_subject_dashboard", remove_default_model_permissions_from_edc_permissions
+    )
+
+    site_auths.add_custom_permissions_tuples(
+        model="edc_subject_dashboard.edcpermissions",
+        codename_tuples=(
+            (
+                "edc_subject_dashboard.view_subject_listboard",
+                "Can access subject listboard",
+            ),
+            ("edc_subject_dashboard.nav_subject_section", "Can access nav_subject_section"),
         ),
-        ("edc_subject_dashboard.nav_subject_section", "Can access nav_subject_section"),
-    ),
-)
+    )
+
+    site_auths.add_group(
+        "edc_subject_dashboard.view_subject_listboard",
+        "edc_subject_dashboard.nav_subject_section",
+        name=SUBJECT_VIEW,
+    )
+
+    site_auths.update_role(SUBJECT_VIEW, name=CLINICIAN_ROLE)
+    site_auths.update_role(SUBJECT_VIEW, name=NURSE_ROLE)
+    site_auths.update_role(SUBJECT_VIEW, name=CLINICIAN_SUPER_ROLE)
+    site_auths.update_role(SUBJECT_VIEW, name=AUDITOR_ROLE)
 
-site_auths.add_group(
-    "edc_subject_dashboard.view_subject_listboard",
-    "edc_subject_dashboard.nav_subject_section",
-    name=SUBJECT_VIEW,
-)
 
-site_auths.update_role(SUBJECT_VIEW, name=CLINICIAN_ROLE)
-site_auths.update_role(SUBJECT_VIEW, name=NURSE_ROLE)
-site_auths.update_role(SUBJECT_VIEW, name=CLINICIAN_SUPER_ROLE)
-site_auths.update_role(SUBJECT_VIEW, name=AUDITOR_ROLE)
+update_site_auths()

edc_timepoint/apps.py

@@ -1,7 +1,6 @@
 import sys
 
 from django.apps import AppConfig as DjangoAppConfig
-from django.conf import settings
 
 from edc_appointment.constants import COMPLETE_APPT
 
@@ -35,23 +34,3 @@ class AppConfig(DjangoAppConfig):
         for model in self.timepoints:
             sys.stdout.write(f" * '{model}' is a timepoint model.\n")
         sys.stdout.write(f" Done loading {self.verbose_name}.\n")
-
-
-if settings.APP_NAME == "edc_timepoint":
-    from dateutil.relativedelta import FR, MO, SA, SU, TH, TU, WE
-
-    from edc_facility.apps import AppConfig as BaseEdcFacilityAppConfig
-
-    class EdcFacilityAppConfig(BaseEdcFacilityAppConfig):
-        definitions = {
-            "7-day-clinic": dict(
-                days=[MO, TU, WE, TH, FR, SA, SU],
-                slots=[100, 100, 100, 100, 100, 100, 100],
-            ),
-            "5-day-clinic": dict(days=[MO, TU, WE, TH, FR], slots=[100, 100, 100, 100, 100]),
-            "3-day-clinic": dict(
-                days=[TU, WE, TH],
-                slots=[100, 100, 100],
-                best_effort_available_datetime=True,
-            ),
-        }

edc_unblinding/auths.py

@@ -9,7 +9,12 @@ from .auth_objects import (
     unblinding_reviewers,
 )
 
-site_auths.add_group(*unblinding_requestors, name=UNBLINDING_REQUESTORS)
-site_auths.add_group(*unblinding_reviewers, name=UNBLINDING_REVIEWERS)
-site_auths.add_role(UNBLINDING_REQUESTORS, name=UNBLINDING_REQUESTORS_ROLE)
-site_auths.add_role(UNBLINDING_REVIEWERS, name=UNBLINDING_REVIEWERS_ROLE)
+
+def update_site_auths() -> None:
+    site_auths.add_group(*unblinding_requestors, name=UNBLINDING_REQUESTORS)
+    site_auths.add_group(*unblinding_reviewers, name=UNBLINDING_REVIEWERS)
+    site_auths.add_role(UNBLINDING_REQUESTORS, name=UNBLINDING_REQUESTORS_ROLE)
+    site_auths.add_role(UNBLINDING_REVIEWERS, name=UNBLINDING_REVIEWERS_ROLE)
+
+
+update_site_auths()

edc_utils/__init__.py

@@ -8,7 +8,7 @@ from .get_static_file import get_static_file
 from .get_uuid import get_uuid
 from .message_in_queue import message_in_queue
 from .round_up import round_half_away_from_zero, round_half_up, round_up
-from .show_urls import show_url_names, show_urls
+from .show_urls import show_namespaces, show_url_names, show_urls, show_urls_from_patterns
 from .text import (
     convert_from_camel,
     convert_php_dateformat,
@@ -48,8 +48,10 @@ __all__ = [
     "round_half_up",
     "round_up",
     "safe_allowed_chars",
+    "show_namespaces",
     "show_url_names",
     "show_urls",
+    "show_urls_from_patterns",
     "to_local",
     "to_utc",
     "truncate_string",

edc_utils/show_urls.py

@@ -2,7 +2,7 @@
 # https://github.com/django-extensions/django-extensions/blob/master/django_extensions/management/commands/show_urls.py
 
 from django.core.exceptions import ViewDoesNotExist
-from django.urls import URLPattern, URLResolver
+from django.urls import URLPattern, URLResolver, get_resolver
 
 
 class RegexURLPattern:
@@ -21,7 +21,26 @@ def describe_pattern(p):
     return str(p.pattern)
 
 
-def show_urls(urlpatterns, base="", namespace=None, search=None):
+def show_namespaces():
+    """Returns a list of all registered URL namespaces."""
+    resolver = get_resolver()
+    return list(resolver.namespace_dict.keys())
+
+
+def show_urls():
+    """Return a list of all URL patterns in the project."""
+    urls = []
+    resolver = get_resolver()
+    url_patterns = resolver.url_patterns
+    for pattern in url_patterns:
+        try:
+            urls.append(f"URL: {pattern.pattern} -> View: {pattern.callback.__name__}")
+        except AttributeError:
+            urls.append(f"URL: {pattern.pattern}")
+    return urls
+
+
+def show_urls_from_patterns(urlpatterns, base="", namespace=None, search=None):
     urls = extract_views_from_urlpatterns(urlpatterns, base=base, namespace=namespace)
     if search:
         return [url[1] for url in urls if search in url[1]]
@@ -29,6 +48,14 @@ def show_urls(urlpatterns, base="", namespace=None, search=None):
 
 
 def show_url_names(urlpatterns, base="", namespace=None, search=None):
+    """Returns a list of url names.
+
+    For example:
+        resolver = get_resolver()
+        url_patterns = resolver.url_patterns
+        pprint(show_url_names(url_patterns))
+    """
+
     urls = extract_views_from_urlpatterns(urlpatterns, base=base, namespace=namespace)
     if search:
         return [url[2] for url in urls if search in url[2]]

edc_visit_schedule/auths.py

@@ -1,4 +1,9 @@
 from edc_auth.constants import EVERYONE
 from edc_auth.site_auths import site_auths
 
-site_auths.update_group("edc_visit_schedule.view_subjectschedulehistory", name=EVERYONE)
+
+def update_site_auths() -> None:
+    site_auths.update_group("edc_visit_schedule.view_subjectschedulehistory", name=EVERYONE)
+
+
+update_site_auths()

edc_visit_schedule/site_visit_schedules.py

@@ -163,10 +163,10 @@ class SiteVisitSchedules:
             for schedule in visit_schedule.schedules.values():
                 try:
                     model_name = getattr(schedule, attr)
-                except (AttributeError, TypeError):
+                except (AttributeError, TypeError) as e:
                     raise SiteVisitScheduleError(
                         f"Invalid attr for Schedule. See {schedule}. Got {attr}."
-                    )
+                    ) from e
                 if model_name and model_name == model:
                     ret.append([visit_schedule, schedule])
         if not ret:

edc_visit_tracking/models/signals.py

@@ -51,8 +51,8 @@ def subject_visit_missed_on_post_delete(sender, instance, using, **kwargs) -> No
             instance.related_visit.reason = SCHEDULED
             instance.related_visit.reason_unscheduled = NOT_APPLICABLE
             instance.related_visit.info_source = PATIENT
-            instance.related_visit.info_source_other = None
-            instance.related_visit.comment = None
+            instance.related_visit.info_source_other = ""
+            instance.related_visit.comment = ""
             instance.related_visit.modified = instance.modified
             instance.related_visit.user_modified = instance.user_modified
             instance.related_visit.save_base(

edc_search/constants.py

@@ -1 +0,0 @@
-SEARCH_SLUG_SEP = "|"

edc_search/search_slug.py

@@ -1,51 +0,0 @@
-from __future__ import annotations
-
-import sys
-from typing import TYPE_CHECKING
-
-from django.apps import apps as django_apps
-from django.core.management.color import color_style
-from django.utils.text import slugify
-from django_crypto_fields.fields import BaseField
-
-from .constants import SEARCH_SLUG_SEP
-
-style = color_style()
-if TYPE_CHECKING:
-    from edc_model.models import BaseUuidModel
-
-    from .model_mixins import SearchSlugModelMixin
-
-    class Model(SearchSlugModelMixin, BaseUuidModel):
-        pass
-
-
-class SearchSlug:
-    def __init__(
-        self, obj: Model | SearchSlugModelMixin = None, fields: tuple[str] | None = None
-    ):
-        self.warning = None
-        self.slug = ""
-        self.model_cls = None
-        self.fields = None
-        if obj and fields:
-            self.model_cls = django_apps.get_model(obj._meta.label_lower)
-            self.fields = self.get_safe_fields(fields)
-            values = []
-            for field in fields:
-                value = obj
-                for f in field.split("."):
-                    value = getattr(value, f)
-                values.append(value)
-            slugs = [slugify(item or "") for item in values]
-            slug = SEARCH_SLUG_SEP.join(slugs)
-            if len(slug) > 250:
-                self.warning = f"Warning! Search slug string exceeds 250 chars. See {obj!r}\n"
-                sys.stdout.write(style.WARNING(self.warning))
-            self.slug = slug[:250]
-
-    def get_safe_fields(self, fields) -> tuple[str]:
-        encrypted_fields = tuple(
-            [fld.name for fld in self.model_cls._meta.fields if isinstance(fld, BaseField)]
-        )
-        return tuple([f for f in fields if f not in encrypted_fields])

edc_search/updater.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from .search_slug import SearchSlug
-
-if TYPE_CHECKING:
-    from edc_model.models import BaseUuidModel
-
-    from .model_mixins import SearchSlugModelMixin
-
-    class Model(SearchSlugModelMixin, BaseUuidModel):
-        pass
-
-
-class SearchSlugDuplicateFields(Exception):  # noqa: N818
-    pass
-
-
-class SearchSlugUpdater:
-    search_slug_cls = SearchSlug
-
-    def __init__(self, fields: tuple[str], model_obj: Model | SearchSlugModelMixin = None):
-        if len(fields) > len(list(set(fields))):
-            raise SearchSlugDuplicateFields(
-                f"Duplicate search slug fields detected. Got {fields}. See {self!r}"
-            )
-        search_slug = self.search_slug_cls(obj=model_obj, fields=fields)
-        self.warning = search_slug.warning
-        self.slug = search_slug.slug

edc_search/wsgi.py

@@ -1,7 +0,0 @@
-import os
-
-from django.core.wsgi import get_wsgi_application
-
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "edc_search.settings")
-
-application = get_wsgi_application()