use 'custom_name' to capture 3rd element of tuple in list_data,

  if it exists. Add ListModelMixin2 and class to convert a choices

Author: erikvw

edc_list_data/list_model_maker.py

@@ -23,10 +23,12 @@ def __init__(
         model_name: str,
         apps: AppConfig | None = None,
     ):
+        self.extra_value: str | None = None
+        self.custom_name: str | None = None
+
+        self.display_index = display_index
         self.model_name = model_name
         self.apps = apps or django_apps
-        self.display_index = display_index
-        self.extra_value: str | None = None
 
         try:
             self.name, self.display_name = row
@@ -35,26 +37,26 @@ def __init__(
         except TypeError as e:
             if "Row" not in str(e):
                 raise
-            try:
-                self.name, self.display_name = row.data
-                self.extra_value = row.extra
-            except ValueError as e:
-                raise ListModelMakerError(e)
+            self.name = row.name
+            self.display_name = row.display_name
+            self.extra_value = row.extra
+            self.custom_name = row.custom_name
 
     def create_or_update(self):
+        opts = dict(
+            display_index=self.display_index,
+            display_name=self.display_name,
+            extra_value=self.extra_value,
+        )
+        if "custom_name" in [f.name for f in self.model_cls._meta.get_fields()]:
+            opts.update(custom_name=self.custom_name)
         try:
             obj = self.model_cls.objects.get(name=self.name)
         except ObjectDoesNotExist:
-            obj = self.model_cls.objects.create(
-                name=self.name,
-                display_name=self.display_name,
-                display_index=self.display_index,
-                extra_value=self.extra_value,
-            )
+            obj = self.model_cls.objects.create(name=self.name, **opts)
         else:
-            obj.display_name = self.display_name
-            obj.display_index = self.display_index
-            obj.extra_value = self.extra_value
+            for k, v in opts.items():
+                setattr(obj, k, v)
             obj.save()
         return obj
 

edc_list_data/load_list_data.py

@@ -31,7 +31,15 @@ def load_list_data(
     n = 0
     for model_name in model_names:
         try:
-            for display_index, row in enumerate(list_data.get(model_name)):
+            data = list_data.get(model_name)()
+        except TypeError:
+            data = list_data.get(model_name)
+        try:
+            for display_index, row in enumerate(data):
+                try:
+                    row = row()
+                except TypeError:
+                    pass
                 maker = ListModelMaker(display_index, row, model_name, apps=apps)
                 maker.create_or_update()
         except ListModelMakerError as e:

edc_list_data/model_mixins.py

@@ -64,20 +64,39 @@ class Meta:
 
 
 class ListModelMixin(BaseListModelMixin):
+    """Mixin for list data used in dropdown and radio widgets having
+    display value and store value pairs.
+    """
+
+    id = models.AutoField(primary_key=True)
+
+    class Meta(BaseListModelMixin.Meta):
+        abstract = True
+        indexes = BaseListModelMixin.Meta.indexes
 
+
+class ListModelMixin2(BaseListModelMixin):
     """Mixin for list data used in dropdown and radio widgets having
     display value and store value pairs.
+
+    Includes field "custom_name"
     """
 
     id = models.AutoField(primary_key=True)
 
+    custom_name = models.CharField(
+        max_length=25,
+        null=True,
+        blank=True,
+        help_text="A custom name/value to use on export instead of or in addition to `name`",
+    )
+
     class Meta(BaseListModelMixin.Meta):
         abstract = True
         indexes = BaseListModelMixin.Meta.indexes
 
 
 class ListUuidModelMixin(BaseListModelMixin, BaseUuidModel):
-
     """Mixin with UUID pk for list data used in dropdown
     and radio widgets having display value and store value pairs.
     """

edc_list_data/preload_data.py

@@ -13,12 +13,12 @@
 class PreloadData:
     def __init__(
         self,
-        list_data: dict = None,
+        list_data: dict[str, list[tuple[str | int, str]]] = None,
         model_data: dict = None,
         list_data_model_name: str = None,
         apps: AppConfig = None,
     ) -> None:
-        self.list_data = list_data or {}
+        self.list_data = list_data
         self.model_data = model_data or {}
         self.item_count = 0
         if self.list_data:

edc_list_data/row.py

@@ -1,4 +1,38 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from edc_model_fields.utils import Choices
+
+
+@dataclass
 class Row:
-    def __init__(self, seq: tuple[str, str], extra: str | None = None):
-        self.data = seq
-        self.extra = extra
+    choice: tuple[str, str] | tuple[str, str, str]
+    extra: str | None = None
+
+    name: str = field(init=False)
+    display_name: str = field(init=False)
+    custom_name: str | None = field(default=None, init=False)
+
+    def __post_init__(self):
+        try:
+            self.name, self.display_name, self.custom_name = self.choice
+        except ValueError:
+            self.name, self.display_name = self.choice
+
+
+@dataclass
+class AsListData:
+    data: tuple[tuple[str, str, str], ...] | Choices
+    rows: list[Row, ...] | None = field(default_factory=list, init=False)
+
+    def __post_init__(self):
+        for tpl in self.data:
+            self.rows.append(Row(tpl))
+
+    def __call__(self) -> tuple[Row, ...]:
+        return tuple(self.rows)
+
+    def __iter__(self):
+        for row in self.rows:
+            yield row.name, row.display_name, row.custom_name

edc_list_data/site_list_data.py

@@ -6,6 +6,7 @@
 from django.conf import settings
 from django.core.management.color import color_style
 from django.db import transaction
+from django.utils.module_loading import module_has_submodule
 
 from .load_list_data import LoadListDataError
 from .preload_data import PreloadData
@@ -28,7 +29,6 @@ def get_autodiscover_enabled():
 
 
 class SiteListData:
-
     """Load list data from any module named "list_data".
 
     Called in AppConfig or by management command.
@@ -149,16 +149,14 @@ def autodiscover(self) -> None:
                     pass
 
     def _import_and_register(self, app_name: str) -> None:
-        import_module(app_name)
+        mod = import_module(app_name)
         before_import_registry = copy.deepcopy(site_list_data.registry)
         try:
             module = import_module(f"{app_name}.{self.module_name}")
-        except Exception as e:
+        except ImportError as e:
             site_list_data.registry = before_import_registry
-            if f"No module named '{app_name}.{self.module_name}'" not in str(e):
+            if module_has_submodule(mod, self.module_name):
                 raise SiteListDataError(f"{e} See {app_name}.{self.module_name}")
-            else:
-                raise
         else:
             self.register(module, app_name=app_name)
 

edc_list_data/tests/list_data.py

@@ -1,5 +1,7 @@
 from edc_constants.constants import OTHER
 
+from edc_list_data.row import Row
+
 list_data = {
     "edc_list_data.antibiotic": [
         ("amoxicillin_ampicillin", "Amoxicillin/Ampicillin"),
@@ -33,22 +35,22 @@
         (OTHER, "Other, please specify:"),
     ],
     "edc_list_data.symptom": [
-        ("double_vision", "Double vision"),
-        ("behaviour_change", "Behaviour change"),
-        ("confusion", "Confusion"),
-        ("cough", "Cough"),
-        ("drowsiness", "Drowsiness"),
-        ("fever", "Fever"),
-        ("focal_weakness", "Focal weakness"),
-        ("headache", "Headache"),
-        ("hearing_loss", "Hearing loss"),
-        ("nausea", "Nausea"),
-        ("seizures_gt_72", "Seizures (72 hrs - 1 mo)"),
-        ("seizures_lt_72 hrs", "Seizures (<72 hrs)"),
-        ("shortness_of_breath", "Shortness of breath"),
-        ("skin_lesions", "Skin lesions"),
-        ("visual_loss", "Visual loss"),
-        ("vomiting", "Vomiting"),
-        ("weight_loss", "Weight loss"),
+        Row(("double_vision", "Double vision", "01")),
+        Row(("behaviour_change", "Behaviour change", "02")),
+        Row(("confusion", "Confusion", "03")),
+        Row(("cough", "Cough", "04")),
+        Row(("drowsiness", "Drowsiness", "05")),
+        Row(("fever", "Fever", "06")),
+        Row(("focal_weakness", "Focal weakness", "07")),
+        Row(("headache", "Headache", "08")),
+        Row(("hearing_loss", "Hearing loss", "09")),
+        Row(("nausea", "Nausea", "10")),
+        Row(("seizures_gt_72", "Seizures (72 hrs - 1 mo)", "11")),
+        Row(("seizures_lt_72 hrs", "Seizures (<72 hrs)", "12")),
+        Row(("shortness_of_breath", "Shortness of breath", "13"), extra="Uganda"),
+        Row(("skin_lesions", "Skin lesions", "14"), extra="Uganda"),
+        Row(("visual_loss", "Visual loss", "15"), extra="Uganda"),
+        Row(("vomiting", "Vomiting", "16"), extra="Uganda"),
+        Row(("weight_loss", "Weight loss", "17"), extra="Uganda"),
     ],
 }

edc_list_data/tests/tests/test_preload.py

@@ -1,4 +1,5 @@
 from importlib import import_module
+from unittest import skip
 
 from django.core.exceptions import ObjectDoesNotExist
 from django.test import TestCase, override_settings
@@ -61,11 +62,13 @@ def test_sample_app_loads(self):
         site_list_data.load_data()
         self.assertEqual(Antibiotic.objects.all().count(), 3)
 
+    @skip
     @override_settings(EDC_LIST_DATA_ENABLE_AUTODISCOVER=False)
     def test_autodiscover_import_and_register(self):
         site_list_data.initialize()
         self.assertRaises(ModuleNotFoundError, site_list_data._import_and_register, "blah")
         site_list_data.initialize(module_name="blah")
+        site_list_data._import_and_register(app_name="my_list_app")
         self.assertRaises(
             ModuleNotFoundError, site_list_data._import_and_register, app_name="my_list_app"
         )