refactor: replace global filter_validity with model-specific methods

Replace calls to the global filter_validity() function with model-specific
filter_validity() methods (e.g., Item.filter_validity(), Service.filter_validity())
across resources.py and services.py. This change improves code modularity by
encapsulating validity filtering logic within each model class, allowing for
potential model-specific customizations in the future.

Author: delcroip

tools/resources.py

@@ -132,7 +132,7 @@ def before_import_row(self, row, **kwargs):
 
     # This method is overridden in order to define which data is valid during import.
     def get_queryset(self):
-        return Item.objects.filter(*filter_validity())
+        return Item.objects.filter(*Item.filter_validity())
 
 
 class ServiceResource(ItemServiceResource):
@@ -160,4 +160,4 @@ def before_import_row(self, row, **kwargs):
 
     # This method is overridden in order to define which data is valid during import.
     def get_queryset(self):
-        return Service.objects.filter(*filter_validity())
+        return Service.objects.filter(*Service.filter_validity())

tools/services.py

@@ -582,7 +582,7 @@ def upload_simple_data(user, context):
     db_entries = {
         x.code: x
         for x in context.object_manager.filter(
-            code__in=[x["code"] for x in context.parsed_entries], *filter_validity()
+            code__in=[x["code"] for x in context.parsed_entries], *context.object_manager.model.filter_validity()
         )
     }
 
@@ -729,7 +729,7 @@ def load_locations_xml(xml):
 
 @functools.lru_cache(None)
 def get_parent_location(code):
-    return Location.objects.filter(code=code, *filter_validity()).first()
+    return Location.objects.filter(code=code, *Location.filter_validity()).first()
 
 
 def __chunk_list(l, size=1000):
@@ -748,7 +748,7 @@ def upload_locations(user, xml, strategy=STRATEGY_INSERT, dry_run=False):
     existing_locations = {}
     for ids_chunk in __chunk_list(ids):
         existing_locations.update({
-            loc.code: loc for loc in Location.objects.filter(code__in=ids_chunk, *filter_validity())
+            loc.code: loc for loc in Location.objects.filter(code__in=ids_chunk, *Location.filter_validity())
         })
 
     get_parent_location.cache_clear()
@@ -858,9 +858,9 @@ def load_health_facilities_xml(xml):
 @functools.lru_cache(None)
 def get_pricelist(name, type):
     if type == "services":
-        return ServicesPricelist.objects.filter(name=name, *filter_validity()).first()
+        return ServicesPricelist.objects.filter(name=name, *ServicesPricelist.filter_validity()).first()
     elif type == "items":
-        return ItemsPricelist.objects.filter(name=name, *filter_validity()).first()
+        return ItemsPricelist.objects.filter(name=name, *ServicesPricelist.filter_validity()).first()
 
 
 def upload_health_facilities(user, xml, strategy=STRATEGY_INSERT, dry_run=False):
@@ -878,7 +878,7 @@ def upload_health_facilities(user, xml, strategy=STRATEGY_INSERT, dry_run=False)
     db_health_facilities = {
         x.code: x
         for x in HealthFacility.objects.filter(
-            code__in=[x["code"] for x in raw_health_facilities], *filter_validity()
+            code__in=[x["code"] for x in raw_health_facilities], *HealthFacility.filter_validity()
         )
     }
     for facility in raw_health_facilities:
@@ -1014,7 +1014,7 @@ def create_officer_feedbacks_export(user, officer):
 
     """
 
-    prompts = FeedbackPrompt.objects.filter(*filter_validity())\
+    prompts = FeedbackPrompt.objects.filter(*FeedbackPrompt.filter_validity())\
         .filter(officer_id=officer.id, claim__feedback_status=Claim.FEEDBACK_SELECTED)\
         .select_related('claim',
                         'claim__insuree',
@@ -1061,7 +1061,7 @@ def create_officer_renewals_export(user, officer):
     from policy.models import PolicyRenewal
     format_date = '%d-%m-%Y'
     renewals = PolicyRenewal.objects.filter(
-        new_officer=officer, *filter_validity()
+        new_officer=officer, *PolicyRenewal.filter_validity()
     ).select_related(
         "policy",
         "insuree",
@@ -1138,7 +1138,7 @@ def get_controls():
 
 
 def create_phone_extract_db(location_id, with_insuree=False):
-    location = Location.objects.get(id=location_id, *filter_validity())
+    location = Location.objects.get(id=location_id, *Location.filter_validity())
     if not location:
         raise ValueError(f"Location {location_id} does not exist")
 
@@ -1173,23 +1173,23 @@ def create_phone_extract_db(location_id, with_insuree=False):
             # Medical Services
             db_con.executemany(
                 "INSERT INTO tblReferences(Code, Name, Type, Price) VALUES (?, ?, 'S', ?)",
-                Service.objects.filter(*filter_validity()).values_list(
+                Service.objects.filter(*Service.filter_validity()).values_list(
                     "code", "name", "price"
                 ),
             )
 
             # Medical Items
             db_con.executemany(
                 "INSERT INTO tblReferences(Code, Name, Type, Price) VALUES (?, ?, 'I', ?)",
-                Item.objects.filter(*filter_validity())
+                Item.objects.filter(*Item.filter_validity())
                 .values_list("code", "name", "price")
                 .all(),
             )
 
             # Medical Diagnosis
             db_con.executemany(
                 "INSERT INTO tblReferences(Code, Name, Type, Price) VALUES (?, ?, 'D', 0)",
-                Diagnosis.objects.filter(*filter_validity())
+                Diagnosis.objects.filter(*Diagnosis.filter_validity())
                 .values_list("code", "name")
                 .all(),
             )
@@ -1210,7 +1210,7 @@ def create_phone_extract_db(location_id, with_insuree=False):
             ClaimAdmin.objects.filter(
                 health_facility__location_id=location_id,
                 health_facility__validity_to__isnull=True,
-                *filter_validity(),
+                *ClaimAdmin.filter_validity(),
             )
             .annotate(
                 name=Concat(

tools/tests/_test_upload_items.py

@@ -1203,7 +1203,7 @@ def test_upload_items_multiple_insert_update_delete_dry_run(self, mock_parsing):
         errors = []
         mock_parsing.return_value = raw_items, errors
 
-        before_total_items = Item.objects.filter(*filter_validity()).count()
+        before_total_items = Item.objects.filter(*Item.filter_validity()).count()
         expected_deleted = before_total_items - 2
 
         expected = UploadResult(
@@ -1273,11 +1273,11 @@ def test_upload_items_multiple_insert(self, mock_parsing):
             updated=0,
             deleted=0,
         )
-        total_items_before = Item.objects.filter(*filter_validity()).count()
+        total_items_before = Item.objects.filter(*Item.filter_validity()).count()
 
         # Inserting
         result = upload_items(self.admin_user, "xml", strategy, dry_run)
-        total_items_after = Item.objects.filter(*filter_validity()).count()
+        total_items_after = Item.objects.filter(*Item.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_items_before + 2, total_items_after)
@@ -1355,11 +1355,11 @@ def test_upload_items_multiple_update(self, mock_parsing):
             updated=2,
             deleted=0,
         )
-        total_items_before = Item.objects.filter(*filter_validity()).count()
+        total_items_before = Item.objects.filter(*Item.filter_validity()).count()
 
         # update
         result = upload_items(self.admin_user, "xml", strategy, dry_run)
-        total_items_after = Item.objects.filter(*filter_validity()).count()
+        total_items_after = Item.objects.filter(*Item.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_items_before, total_items_after)
@@ -1448,11 +1448,11 @@ def test_upload_items_multiple_insert_update(self, mock_parsing):
             updated=2,
             deleted=0,
         )
-        total_items_before = Item.objects.filter(*filter_validity()).count()
+        total_items_before = Item.objects.filter(*Item.filter_validity()).count()
 
         # insert-update
         result = upload_items(self.admin_user, "xml", strategy, dry_run)
-        total_items_after = Item.objects.filter(*filter_validity()).count()
+        total_items_after = Item.objects.filter(*Item.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_items_before + 2, total_items_after)
@@ -1475,7 +1475,7 @@ def test_upload_items_multiple_insert_update(self, mock_parsing):
     @patch("tools.services.parse_xml_items")
     def test_upload_items_multiple_insert_update_delete(self, mock_parsing):
         # setup - fetching initial DB items in order not to delete them
-        all_items = Item.objects.filter(*filter_validity()).all()
+        all_items = Item.objects.filter(*Item.filter_validity()).all()
         items_to_not_delete = []
         for item in all_items:
             item_dict = item.__dict__
@@ -1554,11 +1554,11 @@ def test_upload_items_multiple_insert_update_delete(self, mock_parsing):
             updated=total_updated,
             deleted=1,
         )
-        total_items_before = Item.objects.filter(*filter_validity()).count()
+        total_items_before = Item.objects.filter(*Item.filter_validity()).count()
 
         # insert update delete
         result = upload_items(self.admin_user, "xml", strategy, dry_run)
-        total_items_after = Item.objects.filter(*filter_validity()).count()
+        total_items_after = Item.objects.filter(*Item.filter_validity()).count()
 
         self.assertEqual(expected, result)
         # 2 inserts and 1 deletion

tools/tests/_test_upload_services.py

@@ -1063,7 +1063,7 @@ def test_upload_services_multiple_insert_update_delete_dry_run(self, mock_parsin
         errors = []
         mock_parsing.return_value = raw_services, errors
 
-        before_total_services = Service.objects.filter(*filter_validity()).count()
+        before_total_services = Service.objects.filter(*Service.filter_validity()).count()
         expected_deleted = before_total_services - 2
 
         expected = UploadResult(
@@ -1133,11 +1133,11 @@ def test_upload_services_multiple_insert(self, mock_parsing):
             updated=0,
             deleted=0,
         )
-        total_services_before = Service.objects.filter(*filter_validity()).count()
+        total_services_before = Service.objects.filter(*Service.filter_validity()).count()
 
         # Inserting
         result = upload_services(self.admin_user, "xml", strategy, dry_run)
-        total_services_after = Service.objects.filter(*filter_validity()).count()
+        total_services_after = Service.objects.filter(*Service.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_services_before + 2, total_services_after)
@@ -1216,11 +1216,11 @@ def test_upload_services_multiple_update(self, mock_parsing):
             updated=2,
             deleted=0,
         )
-        total_services_before = Service.objects.filter(*filter_validity()).count()
+        total_services_before = Service.objects.filter(*Service.filter_validity()).count()
 
         # update
         result = upload_services(self.admin_user, "xml", strategy, dry_run)
-        total_services_after = Service.objects.filter(*filter_validity()).count()
+        total_services_after = Service.objects.filter(*Service.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_services_before, total_services_after)
@@ -1310,11 +1310,11 @@ def test_upload_services_multiple_insert_update(self, mock_parsing):
             updated=2,
             deleted=0,
         )
-        total_services_before = Service.objects.filter(*filter_validity()).count()
+        total_services_before = Service.objects.filter(*Service.filter_validity()).count()
 
         # insert-update
         result = upload_services(self.admin_user, "xml", strategy, dry_run)
-        total_services_after = Service.objects.filter(*filter_validity()).count()
+        total_services_after = Service.objects.filter(*Service.filter_validity()).count()
 
         self.assertEqual(expected, result)
         self.assertEqual(total_services_before + 2, total_services_after)
@@ -1337,7 +1337,7 @@ def test_upload_services_multiple_insert_update(self, mock_parsing):
     @patch("tools.services.parse_xml_services")
     def test_upload_services_multiple_insert_update_delete(self, mock_parsing):
         # setup - fetching initial DB services in order not to delete them
-        services = Service.objects.filter(*filter_validity()).all()
+        services = Service.objects.filter(*Service.filter_validity()).all()
         services_to_not_delete = []
         for service in services:
             service_dict = service.__dict__
@@ -1416,11 +1416,11 @@ def test_upload_services_multiple_insert_update_delete(self, mock_parsing):
             updated=total_updated,
             deleted=1,
         )
-        total_services_before = Service.objects.filter(*filter_validity()).count()
+        total_services_before = Service.objects.filter(*Service.filter_validity()).count()
 
         # insert update delete
         result = upload_services(self.admin_user, "xml", strategy, dry_run)
-        total_services_after = Service.objects.filter(*filter_validity()).count()
+        total_services_after = Service.objects.filter(*Service.filter_validity()).count()
 
         self.assertEqual(expected, result)
         # 2 inserts and 1 deletion

tools/views.py

@@ -44,7 +44,7 @@
 def download_locations(request):
     data = {"Regions": [], "Districts": [], "Municipalities": [], "Villages": []}
 
-    for region in Location.objects.filter(~Q(code="FR"), type="R", *filter_validity()):
+    for region in Location.objects.filter(~Q(code="FR"), type="R", *Location.filter_validity()):
         data["Regions"].append(serializers.format_location(region))
         children = Location.objects.children(region.id)
         for child in children:
@@ -106,7 +106,7 @@ def upload_locations(request):
 )
 @renderer_classes([serializers.HealthFacilitiesXMLRenderer])
 def download_health_facilities(request):
-    queryset = HealthFacility.objects.filter(*filter_validity())
+    queryset = HealthFacility.objects.filter(*HealthFacility.filter_validity())
     data = {
         "health_facility_details": [
             serializers.format_health_facility(hf) for hf in queryset
@@ -174,7 +174,7 @@ def upload_health_facilities(request):
 )
 @renderer_classes([serializers.DiagnosesXMLRenderer])
 def download_diagnoses(request):
-    queryset = Diagnosis.objects.filter(*filter_validity())
+    queryset = Diagnosis.objects.filter(*Diagnosis.filter_validity())
     data = [serializers.format_diagnosis(hf) for hf in queryset]
     return Response(
         data=data,
@@ -209,7 +209,7 @@ def download_items(request):
         The requested data in an XML file.
 
     """
-    queryset = Item.objects.filter(*filter_validity())
+    queryset = Item.objects.filter(*Item.filter_validity())
     data = [serializers.format_items(item) for item in queryset]
     return Response(
         data=data,
@@ -227,7 +227,7 @@ def download_items(request):
 )
 @renderer_classes([serializers.ServicesXMLRenderer])
 def download_services(request):
-    queryset = Service.objects.filter(*filter_validity())
+    queryset = Service.objects.filter(*Service.filter_validity())
     data = [serializers.format_services(service) for service in queryset]
     return Response(
         data=data,
@@ -419,7 +419,7 @@ def download_feedbacks(request):
         raise PermissionDenied(_("unauthorized"))
 
     officer_id = request.GET.get("officer_id")
-    officer = get_object_or_404(Officer, id=officer_id, *filter_validity())
+    officer = get_object_or_404(Officer, id=officer_id, *Officer.filter_validity())
 
     export_file = services.create_officer_feedbacks_export(request.user, officer)
 
@@ -438,7 +438,7 @@ def download_renewals(request):
         raise PermissionDenied(_("unauthorized"))
 
     officer_id = request.GET.get("officer_id")
-    officer = get_object_or_404(Officer, id=officer_id, *filter_validity())
+    officer = get_object_or_404(Officer, id=officer_id, *Officer.filter_validity())
 
     export_file = services.create_officer_renewals_export(request.user, officer)
     response = FileResponse(
@@ -586,7 +586,7 @@ def export_items(request):
 def process_export_items(user, data_type):
     logger.info("User (audit id %s) requested export of medical items in %s", user.id_for_audit, data_type)
     item_resource = ItemResource(user=user)
-    query_set = Item.objects.filter(*filter_validity()).order_by("code")
+    query_set = Item.objects.filter(*Item.filter_validity()).order_by("code")
     dataset = item_resource.export(query_set)
     datasets = {
         XLS: dataset.xls,
@@ -644,7 +644,7 @@ def export_services(request):
 def process_export_services(user, data_type):
     logger.info("User (audit id %s) requested export of medical services in %s", user.id_for_audit, data_type)
     service_resource = ServiceResource(user)
-    query_set = Service.objects.filter(*filter_validity()).order_by("code")
+    query_set = Service.objects.filter(*Service.filter_validity()).order_by("code")
     dataset = service_resource.export(query_set)
     datasets = {
         XLS: dataset.xls,