forked from botswana-harvard/edc-metadata
-
Notifications
You must be signed in to change notification settings - Fork 1
/
metadata_wrapper.py
74 lines (58 loc) · 2.59 KB
/
metadata_wrapper.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Type
from django.apps import apps as django_apps
from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist
from edc_visit_tracking.typing_stubs import RelatedVisitProtocol
if TYPE_CHECKING:
from edc_crf.model_mixins import CrfModelMixin
from edc_metadata.models import CrfMetadata, RequisitionMetadata
class MetadataWrapperError(Exception):
pass
class MetadataWrapper:
"""A class that wraps the corresponding model instance, or not, for the
given metadata object and sets it to itself along with other
attributes like the visit, model class, metadata_obj, etc.
"""
label: str | None = None
def __init__(
self,
visit: RelatedVisitProtocol,
metadata_obj: CrfMetadata | RequisitionMetadata,
) -> None:
self._source_model_obj = None
self.metadata_obj = metadata_obj
self.visit = visit
# visit codes (and sequence) must match
if (self.visit.visit_code != self.metadata_obj.visit_code) or (
self.visit.visit_code_sequence != self.metadata_obj.visit_code_sequence
):
raise MetadataWrapperError(
f"Visit code mismatch. Visit is {self.visit.visit_code}."
f"{self.visit.visit_code_sequence} but metadata object has "
f"{self.metadata_obj.visit_code}."
f"{self.metadata_obj.visit_code_sequence}. Got {repr(metadata_obj)}."
)
def __repr__(self) -> str:
return f"{self.__class__.__name__}({self.visit}, {self.metadata_obj})"
@property
def options(self) -> dict[str, Any]:
"""Returns a dictionary of query options."""
return {f"{self.source_model_cls.related_visit_model_attr()}": self.visit}
@property
def source_model_obj(self) -> CrfModelMixin:
if not self._source_model_obj:
try:
self._source_model_obj = self.source_model_cls.objects.get(**self.options)
except AttributeError as e:
if "related_visit_model_attr" not in str(e):
raise ImproperlyConfigured(f"{e} See {repr(self.source_model_cls)}")
except ObjectDoesNotExist:
self._source_model_obj = None
return self._source_model_obj
@source_model_obj.setter
def source_model_obj(self, value=None) -> None:
self._source_model_obj = value
@property
def source_model_cls(self) -> Type[CrfModelMixin]:
"""Returns a CRF model class"""
return django_apps.get_model(self.metadata_obj.model)