🏛️ Architect: Refactor KeyErrorPopStudyKeyMixin (#800)

* Refactor KeyErrorPopStudyKeyMixin to use explicit strategy assignments

- Removed KeyErrorPopStudyKeyMixin from core mixins.
- Replaced mixin usage in codings, forms, intervals, sites, and variables endpoints with explicit STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError) assignments.
- Enforced Explicit > Implicit design principle.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

* Refactor KeyErrorPopStudyKeyMixin to use explicit strategy assignments and fix formatting

- Removed KeyErrorPopStudyKeyMixin from core mixins.
- Replaced mixin usage in codings, forms, intervals, sites, and variables endpoints with explicit STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError) assignments.
- Enforced Explicit > Implicit design principle.
- Fixed black formatting errors.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

* Refactor KeyErrorPopStudyKeyMixin to use explicit strategy assignments and fix formatting

- Removed KeyErrorPopStudyKeyMixin from core mixins.
- Replaced mixin usage in codings, forms, intervals, sites, and variables endpoints with explicit STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError) assignments.
- Enforced Explicit > Implicit design principle.
- Fixed black formatting errors.
- Fixed ruff import errors.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>

Author: fderuiter

src/imednet/core/endpoint/mixins/__init__.py

@@ -4,15 +4,14 @@
 from .caching import CachedEndpointMixin, CacheMixin
 from .get import FilterGetEndpointMixin, PathGetEndpointMixin
 from .list import ListEndpointMixin
-from .params import KeyErrorPopStudyKeyMixin, ParamMixin
+from .params import ParamMixin
 from .parsing import ParsingMixin
 
 __all__ = [
     "AsyncPaginator",
     "CachedEndpointMixin",
     "CacheMixin",
     "FilterGetEndpointMixin",
-    "KeyErrorPopStudyKeyMixin",
     "ListEndpointMixin",
     "Paginator",
     "ParamMixin",

src/imednet/core/endpoint/mixins/params.py

@@ -6,7 +6,6 @@
     DefaultParamProcessor,
     KeepStudyKeyStrategy,
     OptionalStudyKeyStrategy,
-    PopStudyKeyStrategy,
     StudyKeyStrategy,
 )
 from imednet.core.endpoint.structs import ParamState
@@ -91,9 +90,3 @@ def _resolve_params(
             params.update(extra_params)
 
         return ParamState(study=study, params=params, other_filters=other_filters)
-
-
-class KeyErrorPopStudyKeyMixin:
-    """Mixin that configures the endpoint to pop the study key and raise KeyError if missing."""
-
-    STUDY_KEY_STRATEGY: Optional[StudyKeyStrategy] = PopStudyKeyStrategy(exception_cls=KeyError)

src/imednet/endpoints/codings.py

@@ -2,13 +2,12 @@
 
 from imednet.core.endpoint.base import GenericListGetEndpoint
 from imednet.core.endpoint.edc_mixin import EdcEndpointMixin
-from imednet.core.endpoint.mixins import KeyErrorPopStudyKeyMixin
+from imednet.core.endpoint.strategies import PopStudyKeyStrategy
 from imednet.models.codings import Coding
 
 
 class CodingsEndpoint(
     EdcEndpointMixin,
-    KeyErrorPopStudyKeyMixin,
     GenericListGetEndpoint[Coding],
 ):
     """
@@ -20,3 +19,4 @@ class CodingsEndpoint(
     PATH = "codings"
     MODEL = Coding
     _id_param = "codingId"
+    STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError)

src/imednet/endpoints/forms.py

@@ -2,13 +2,13 @@
 
 from imednet.core.endpoint.base import GenericListGetEndpoint
 from imednet.core.endpoint.edc_mixin import EdcEndpointMixin
-from imednet.core.endpoint.mixins import CachedEndpointMixin, KeyErrorPopStudyKeyMixin
+from imednet.core.endpoint.mixins import CachedEndpointMixin
+from imednet.core.endpoint.strategies import PopStudyKeyStrategy
 from imednet.models.forms import Form
 
 
 class FormsEndpoint(
     EdcEndpointMixin,
-    KeyErrorPopStudyKeyMixin,
     CachedEndpointMixin,
     GenericListGetEndpoint[Form],
 ):
@@ -21,3 +21,4 @@ class FormsEndpoint(
     PATH = "forms"
     MODEL = Form
     _id_param = "formId"
+    STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError)

src/imednet/endpoints/intervals.py

@@ -2,13 +2,13 @@
 
 from imednet.core.endpoint.base import GenericListGetEndpoint
 from imednet.core.endpoint.edc_mixin import EdcEndpointMixin
-from imednet.core.endpoint.mixins import CachedEndpointMixin, KeyErrorPopStudyKeyMixin
+from imednet.core.endpoint.mixins import CachedEndpointMixin
+from imednet.core.endpoint.strategies import PopStudyKeyStrategy
 from imednet.models.intervals import Interval
 
 
 class IntervalsEndpoint(
     EdcEndpointMixin,
-    KeyErrorPopStudyKeyMixin,
     CachedEndpointMixin,
     GenericListGetEndpoint[Interval],
 ):
@@ -21,3 +21,4 @@ class IntervalsEndpoint(
     PATH = "intervals"
     MODEL = Interval
     _id_param = "intervalId"
+    STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError)

src/imednet/endpoints/sites.py

@@ -2,13 +2,12 @@
 
 from imednet.core.endpoint.base import GenericListGetEndpoint
 from imednet.core.endpoint.edc_mixin import EdcEndpointMixin
-from imednet.core.endpoint.mixins import KeyErrorPopStudyKeyMixin
+from imednet.core.endpoint.strategies import PopStudyKeyStrategy
 from imednet.models.sites import Site
 
 
 class SitesEndpoint(
     EdcEndpointMixin,
-    KeyErrorPopStudyKeyMixin,
     GenericListGetEndpoint[Site],
 ):
     """
@@ -20,3 +19,4 @@ class SitesEndpoint(
     PATH = "sites"
     MODEL = Site
     _id_param = "siteId"
+    STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError)

src/imednet/endpoints/variables.py

@@ -2,13 +2,13 @@
 
 from imednet.core.endpoint.base import GenericListGetEndpoint
 from imednet.core.endpoint.edc_mixin import EdcEndpointMixin
-from imednet.core.endpoint.mixins import CachedEndpointMixin, KeyErrorPopStudyKeyMixin
+from imednet.core.endpoint.mixins import CachedEndpointMixin
+from imednet.core.endpoint.strategies import PopStudyKeyStrategy
 from imednet.models.variables import Variable
 
 
 class VariablesEndpoint(
     EdcEndpointMixin,
-    KeyErrorPopStudyKeyMixin,
     CachedEndpointMixin,
     GenericListGetEndpoint[Variable],
 ):
@@ -21,3 +21,4 @@ class VariablesEndpoint(
     PATH = "variables"
     MODEL = Variable
     _id_param = "variableId"
+    STUDY_KEY_STRATEGY = PopStudyKeyStrategy(exception_cls=KeyError)