endoreg-db 0.8.9.2__py3-none-any.whl → 0.8.9.10__py3-none-any.whl

endoreg_db/serializers/meta/sensitive_meta_detail.py

@@ -4,6 +4,7 @@ from ...models import SensitiveMeta
 
 logger = logging.getLogger(__name__)
 
+
 class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
     """
     Serializer for displaying SensitiveMeta details with verification state.
@@ -17,7 +18,9 @@ class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
 
     # Related fields
     center_name = serializers.CharField(source="center.name", read_only=True)
-    patient_gender_name = serializers.CharField(source="patient_gender.name", read_only=True)
+    patient_gender_name = serializers.CharField(
+        source="patient_gender.name", read_only=True
+    )
     examiners_display = serializers.SerializerMethodField()
 
     # Formatted display fields
@@ -57,7 +60,7 @@ class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
             "text",
             "anonymized_text",
             "external_id",
-            "external_id_origin"
+            "external_id_origin",
         ]
         read_only_fields = [
             "id",
@@ -66,14 +69,23 @@ class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
         ]
 
     # --- Verification getters ---
-    def get_is_verified(self, obj): return getattr(obj, "is_verified", False)
-    def get_dob_verified(self, obj): return getattr(getattr(obj, "state", None), "dob_verified", False)
-    def get_names_verified(self, obj): return getattr(getattr(obj, "state", None), "names_verified", False)
+    def get_is_verified(self, obj):
+        return getattr(obj, "is_verified", False)
+
+    def get_dob_verified(self, obj):
+        return getattr(getattr(obj, "state", None), "dob_verified", False)
+
+    def get_names_verified(self, obj):
+        return getattr(getattr(obj, "state", None), "names_verified", False)
 
     # --- Examiner display ---
     def get_examiners_display(self, obj):
         try:
-            return [f"{e.first_name} {e.last_name}" for e in obj.examiners.all()] if obj.pk else []
+            return (
+                [f"{e.first_name} {e.last_name}" for e in obj.examiners.all()]
+                if obj.pk
+                else []
+            )
         except Exception as e:
             logger.warning(f"Error fetching examiners for SensitiveMeta {obj.pk}: {e}")
             return []
@@ -83,7 +95,9 @@ class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
         return obj.patient_dob.strftime("%Y-%m-%d") if obj.patient_dob else None
 
     def get_examination_date_display(self, obj):
-        return obj.examination_date.strftime("%Y-%m-%d") if obj.examination_date else None
+        return (
+            obj.examination_date.strftime("%Y-%m-%d") if obj.examination_date else None
+        )
 
     # --- Hash short forms ---
     def get_patient_hash_display(self, obj):
@@ -98,10 +112,11 @@ class SensitiveMetaDetailSerializer(serializers.ModelSerializer):
 
     def get_anonymized_text(self, obj):
         return obj.anonymized_text if isinstance(obj.anonymized_text, str) else None
-    
-    def get_external_id(self, obj) -> str | None:  
-        return obj.external_id if isinstance(obj.external_id, str) else None  
-    
-    def get_external_id_origin(self, obj) -> str | None:  
-        return obj.external_id_origin if isinstance(obj.external_id_origin, str) else None 
 
+    def get_external_id(self, obj) -> str | None:
+        return obj.external_id if isinstance(obj.external_id, str) else None
+
+    def get_external_id_origin(self, obj) -> str | None:
+        return (
+            obj.external_id_origin if isinstance(obj.external_id_origin, str) else None
+        )

endoreg_db/serializers/meta/sensitive_meta_update.py

@@ -7,44 +7,43 @@ from ...models import SensitiveMeta, Center, Gender
 logger = logging.getLogger(__name__)
 
 
-
 class SensitiveMetaUpdateSerializer(serializers.ModelSerializer):
     """
     Serializer for updating SensitiveMeta fields including verification state.
     Handles partial updates and state management.
     """
-    
+
     # Verification state fields
     dob_verified = serializers.BooleanField(required=False)
     names_verified = serializers.BooleanField(required=False)
-    
+
     # Center can be updated by name
     center_name = serializers.CharField(write_only=True, required=False)
-    
+
     # Gender can be updated by name
     patient_gender_name = serializers.CharField(write_only=True, required=False)
 
     class Meta:
         model = SensitiveMeta
         fields = [
-            'patient_first_name',
-            'patient_last_name',
-            'patient_dob',
-            'examination_date',
-            'center_name',
-            'patient_gender_name',
-            'endoscope_type',
-            'endoscope_sn',
-            'examiner_first_name',
-            'examiner_last_name',
-            'dob_verified',
-            'names_verified',
+            "patient_first_name",
+            "patient_last_name",
+            "patient_dob",
+            "examination_date",
+            "center_name",
+            "patient_gender_name",
+            "endoscope_type",
+            "endoscope_sn",
+            "examiner_first_name",
+            "examiner_last_name",
+            "dob_verified",
+            "names_verified",
         ]
 
     def validate_center_name(self, value):
         """
         Validates that a center with the given natural key exists.
-        
+
         Raises a validation error if the specified center does not exist.
         """
         if value:
@@ -58,7 +57,7 @@ class SensitiveMetaUpdateSerializer(serializers.ModelSerializer):
     def validate_patient_gender_name(self, value):
         """
         Validates that a gender with the given name exists.
-        
+
         Raises a validation error if no matching Gender is found.
         """
         if value:
@@ -72,21 +71,21 @@ class SensitiveMetaUpdateSerializer(serializers.ModelSerializer):
     def validate(self, data):
         """
         Validate that patient first and last names, if provided, are not empty strings.
-        
+
         Raises a validation error if either `patient_first_name` or `patient_last_name` is present but empty.
         """
         # Ensure names are not empty if provided
-        first_name = data.get('patient_first_name')
+        first_name = data.get("patient_first_name")
         if first_name is not None and not first_name.strip():
-            raise serializers.ValidationError({
-                'patient_first_name': 'First name cannot be empty.'
-            })
-        
-        last_name = data.get('patient_last_name')
+            raise serializers.ValidationError(
+                {"patient_first_name": "First name cannot be empty."}
+            )
+
+        last_name = data.get("patient_last_name")
         if last_name is not None and not last_name.strip():
-            raise serializers.ValidationError({
-                'patient_last_name': 'Last name cannot be empty.'
-            })
+            raise serializers.ValidationError(
+                {"patient_last_name": "Last name cannot be empty."}
+            )
 
         return data
 
@@ -94,55 +93,61 @@ class SensitiveMetaUpdateSerializer(serializers.ModelSerializer):
     def update(self, instance, validated_data):
         """
         Updates a SensitiveMeta instance with provided data, including related center, gender, and verification state fields.
-        
+
         Handles assignment of related Center and Gender objects by name, updates model fields, and manages verification state flags (`dob_verified`, `names_verified`) in the associated state object if provided.
-        
+
         Returns:
             SensitiveMeta: The updated SensitiveMeta instance.
         """
         # Extract verification state data
-        dob_verified = validated_data.pop('dob_verified', None)
-        names_verified = validated_data.pop('names_verified', None)
-        
+        dob_verified = validated_data.pop("dob_verified", None)
+        names_verified = validated_data.pop("names_verified", None)
+
         # Extract and handle center update
-        center_name = validated_data.pop('center_name', None)
+        center_name = validated_data.pop("center_name", None)
         if center_name:
             try:
                 center = Center.objects.get_by_natural_key(center_name)
                 instance.center = center
             except Center.DoesNotExist:
                 logger.error(f"Center '{center_name}' not found during update")
-                raise serializers.ValidationError(f"Center '{center_name}' does not exist.")
-        
+                raise serializers.ValidationError(
+                    f"Center '{center_name}' does not exist."
+                )
+
         # Extract and handle gender update
-        patient_gender_name = validated_data.pop('patient_gender_name', None)
+        patient_gender_name = validated_data.pop("patient_gender_name", None)
         if patient_gender_name:
             try:
                 gender = Gender.objects.get(name=patient_gender_name)
                 instance.patient_gender = gender
             except Gender.DoesNotExist:
                 logger.error(f"Gender '{patient_gender_name}' not found during update")
-                raise serializers.ValidationError(f"Gender '{patient_gender_name}' does not exist.")
+                raise serializers.ValidationError(
+                    f"Gender '{patient_gender_name}' does not exist."
+                )
 
         # Update regular fields using the model's update_from_dict method
         if validated_data:
             instance.update_from_dict(validated_data)
-        
+
         # Update verification state if provided
         if dob_verified is not None or names_verified is not None:
             # Ensure state exists
             state = instance.get_or_create_state()
-            
+
             if dob_verified is not None:
                 state.dob_verified = dob_verified
-                logger.info(f"Updated DOB verification for SensitiveMeta {instance.pk}: {dob_verified}")
-            
+                logger.info(
+                    f"Updated DOB verification for SensitiveMeta {instance.pk}: {dob_verified}"
+                )
+
             if names_verified is not None:
                 state.names_verified = names_verified
-                logger.info(f"Updated names verification for SensitiveMeta {instance.pk}: {names_verified}")
-            
+                logger.info(
+                    f"Updated names verification for SensitiveMeta {instance.pk}: {names_verified}"
+                )
+
             state.save()
 
         return instance
-
-

endoreg_db/serializers/meta/sensitive_meta_verification.py

@@ -5,20 +5,21 @@ from ...models import SensitiveMeta
 
 logger = logging.getLogger(__name__)
 
+
 class SensitiveMetaVerificationSerializer(serializers.Serializer):
     """
     Simple serializer for bulk verification state updates.
     Used when only updating verification flags.
     """
-    
+
     sensitive_meta_id = serializers.IntegerField()
     dob_verified = serializers.BooleanField(required=False)
     names_verified = serializers.BooleanField(required=False)
-    
+
     def validate_sensitive_meta_id(self, value):
         """
         Validates that a SensitiveMeta object with the given ID exists and caches it.
-        
+
         Raises:
             ValidationError: If no SensitiveMeta object is found with the specified ID.
         """
@@ -27,33 +28,35 @@ class SensitiveMetaVerificationSerializer(serializers.Serializer):
             self._cached_sensitive_meta = SensitiveMeta.objects.get(id=value)
             return value
         except SensitiveMeta.DoesNotExist:
-            raise serializers.ValidationError(f"SensitiveMeta with ID {value} does not exist.")
+            raise serializers.ValidationError(
+                f"SensitiveMeta with ID {value} does not exist."
+            )
 
     def save(self):
         """
         Updates the verification state for a specified SensitiveMeta instance.
-        
-        Uses the cached SensitiveMeta object from validation, obtains or creates its verification state, 
+
+        Uses the cached SensitiveMeta object from validation, obtains or creates its verification state,
         updates the `dob_verified` and `names_verified` fields if provided, and saves the changes.
-        
+
         Returns:
             The updated verification state object.
         """
-        sensitive_meta_id = self.validated_data['sensitive_meta_id']
-        dob_verified = self.validated_data.get('dob_verified')
-        names_verified = self.validated_data.get('names_verified')
-        
+        sensitive_meta_id = self.validated_data["sensitive_meta_id"]
+        dob_verified = self.validated_data.get("dob_verified")
+        names_verified = self.validated_data.get("names_verified")
+
         # Use the cached instance from the validation step, avoiding a redundant query.
         sensitive_meta = self._cached_sensitive_meta
         state = sensitive_meta.get_or_create_state()
-        
+
         if dob_verified is not None:
             state.dob_verified = dob_verified
-        
+
         if names_verified is not None:
             state.names_verified = names_verified
-        
+
         state.save()
-        
+
         logger.info(f"Updated verification state for SensitiveMeta {sensitive_meta_id}")
-        return state
+        return state

endoreg_db/serializers/misc/__init__.py

@@ -10,5 +10,5 @@ __all__ = [
     "StatsSerializer",
     "UploadJobStatusSerializer",
     "UploadCreateResponseSerializer",
-    "TranslatableFieldMixin"
-]
+    "TranslatableFieldMixin",
+]

endoreg_db/serializers/misc/file_overview.py

@@ -3,8 +3,12 @@ from typing import TYPE_CHECKING
 from rest_framework import serializers
 
 from endoreg_db.models.media import RawPdfFile, VideoFile
-from endoreg_db.models.state.anonymization import AnonymizationState as PdfAnonymizationState
-from endoreg_db.models.state.anonymization import AnonymizationState as VideoAnonymizationState
+from endoreg_db.models.state.anonymization import (
+    AnonymizationState as PdfAnonymizationState,
+)
+from endoreg_db.models.state.anonymization import (
+    AnonymizationState as VideoAnonymizationState,
+)
 
 if TYPE_CHECKING:
     pass
@@ -41,8 +45,6 @@ class FileOverviewSerializer(serializers.Serializer):
         Raises:
             TypeError: If the instance is not a VideoFile or RawPdfFile.
         """
-        text = ""
-        anonym_text = ""
 
         if isinstance(instance, VideoFile):
             media_type = "video"
@@ -76,10 +78,12 @@ class FileOverviewSerializer(serializers.Serializer):
                 rps.anonymization_status if rps else PdfAnonymizationState.NOT_STARTED
             )
 
-            # ------- annotation status (not applicable for PDFs)
+            # ------- annotation status (not applicable for reports)
             annot_status = (
-                            PdfAnonymizationState.VALIDATED if rps.anonymization_validated else PdfAnonymizationState.NOT_STARTED 
-                            )
+                PdfAnonymizationState.VALIDATED
+                if rps.anonymization_validated
+                else PdfAnonymizationState.NOT_STARTED
+            )
 
         else:  # shouldn't happen
             raise TypeError(f"Unsupported instance for overview: {type(instance)}")

endoreg_db/serializers/misc/stats.py

@@ -1,12 +1,14 @@
 from rest_framework import serializers
 
+
 class StatsSerializer(serializers.Serializer):
     """
     Serializer for statistics data from AuditLedger.
-    
+
     This serializer defines the structure of statistics data and ensures
     consistent API responses.
     """
+
     totalCases = serializers.IntegerField()
     totalVideos = serializers.IntegerField()
     totalAnnotations = serializers.IntegerField()
@@ -14,20 +16,20 @@ class StatsSerializer(serializers.Serializer):
     totalImages = serializers.IntegerField()
     videosCompleted = serializers.IntegerField()
     videosAnonym = serializers.IntegerField()
-    
+
     # You can add additional fields or methods here as needed
     # For example, to calculate derived statistics:
-    #TODO
+    # TODO
     def get_completion_percentage(self, obj):
         """
         Calculates the percentage of completed videos out of the total videos.
-        
+
         Args:
             obj: A dictionary containing 'videosCompleted' and 'totalVideos' keys.
-        
+
         Returns:
             The completion percentage as a float rounded to two decimal places, or 0 if totalVideos is zero or less.
         """
-        if obj['totalVideos'] > 0:
-            return round((obj['videosCompleted'] / obj['totalVideos']) * 100, 2)
-        return 0
+        if obj["totalVideos"] > 0:
+            return round((obj["videosCompleted"] / obj["totalVideos"]) * 100, 2)
+        return 0

endoreg_db/serializers/misc/translatable_field_mix_in.py

@@ -4,20 +4,20 @@ from django.utils.translation import get_language
 class TranslatableFieldMixin:
     """Mixin für automatische Sprachauswahl basierend auf Accept-Language"""
 
-    def get_localized_name(self, obj, field_base='name'):
+    def get_localized_name(self, obj, field_base="name"):
         """
         Retrieve a localized value for a specified field from an object, using language preference fallbacks.
-        
+
         Attempts to return the value of the field with the current language code suffix (e.g., `name_en`). If unavailable or empty, falls back to the German (`_de`) version, then the English (`_en`) version, and finally the base field without a language suffix. Returns an empty string if no value is found.
-        
+
         Parameters:
             obj: The object containing the translatable fields.
             field_base (str): The base name of the field to localize (default is 'name').
-        
+
         Returns:
             str: The localized field value, or an empty string if none is available.
         """
-        current_lang = get_language() or 'en'
+        current_lang = get_language() or "en"
 
         # Versuche sprachspezifisches Feld
         lang_field = f"{field_base}_{current_lang}"
@@ -41,4 +41,4 @@ class TranslatableFieldMixin:
                 return value
 
         # Letzter Fallback auf Basis-Feld
-        return getattr(obj, field_base, '')
+        return getattr(obj, field_base, "")

endoreg_db/serializers/misc/upload_job.py

@@ -7,27 +7,29 @@ class UploadJobStatusSerializer(serializers.ModelSerializer):
     Read-only serializer for upload job status responses.
     Returns status information for polling endpoints.
     """
-    
+
     sensitive_meta_id = serializers.IntegerField(
-        source='sensitive_meta.id',
+        source="sensitive_meta.id",
         read_only=True,
         allow_null=True,
-        help_text="ID of the created SensitiveMeta record (only when anonymized)"
+        help_text="ID of the created SensitiveMeta record (only when anonymized)",
     )
-    
+
     # Optional helper fields for preview (can be populated by view if needed)
     text = serializers.CharField(read_only=True, required=False, allow_blank=True)
-    anonymized_text = serializers.CharField(read_only=True, required=False, allow_blank=True)
+    anonymized_text = serializers.CharField(
+        read_only=True, required=False, allow_blank=True
+    )
 
     class Meta:
         model = UploadJob
         fields = [
-            'status',
-            'error_detail', 
-            'sensitive_meta_id',
-            'id',
-            'text',
-            'anonymized_text'
+            "status",
+            "error_detail",
+            "sensitive_meta_id",
+            "id",
+            "text",
+            "anonymized_text",
         ]
         read_only_fields = fields
 
@@ -36,21 +38,24 @@ class UploadJobStatusSerializer(serializers.ModelSerializer):
         Customize the representation to only include relevant fields based on status.
         """
         data = super().to_representation(instance)
-        
+
         # Only include error_detail if status is error
         if instance.status != UploadJob.Status.ERROR:
-            data.pop('error_detail', None)
-        
+            data.pop("error_detail", None)
+
         # Only include sensitive_meta_id if status is anonymized and we have a meta record
-        if instance.status != UploadJob.Status.ANONYMIZED or not instance.sensitive_meta:
-            data.pop('sensitive_meta_id', None)
-        
+        if (
+            instance.status != UploadJob.Status.ANONYMIZED
+            or not instance.sensitive_meta
+        ):
+            data.pop("sensitive_meta_id", None)
+
         # Remove empty optional fields
-        if not data.get('text'):
-            data.pop('text', None)
-        if not data.get('anonymized_text'):
-            data.pop('anonymized_text', None)
-            
+        if not data.get("text"):
+            data.pop("text", None)
+        if not data.get("anonymized_text"):
+            data.pop("anonymized_text", None)
+
         return data
 
 
@@ -59,13 +64,11 @@ class UploadCreateResponseSerializer(serializers.Serializer):
     Serializer for the initial upload response.
     Returns upload_id and status_url for polling.
     """
-    
+
     upload_id = serializers.UUIDField(
-        read_only=True,
-        help_text="UUID of the created upload job"
+        read_only=True, help_text="UUID of the created upload job"
     )
-    
+
     status_url = serializers.CharField(
-        read_only=True,
-        help_text="URL to poll for upload status updates"
-    )
+        read_only=True, help_text="URL to poll for upload status updates"
+    )

endoreg_db/serializers/patient/__init__.py

@@ -5,7 +5,8 @@ from .patient import (
 from .patient_dropdown import (
     PatientDropdownSerializer,
 )
+
 __all__ = [
     "PatientSerializer",
     "PatientDropdownSerializer",
-]
+]