endoreg-db 0.6.4__py3-none-any.whl → 0.8.2__py3-none-any.whl

endoreg_db/models/label/label.py

@@ -1,34 +1,10 @@
 from django.db import models
+from typing import TYPE_CHECKING
 
 
-class LabelTypeManager(models.Manager):
-    def get_by_natural_key(self, name):
-        return self.get(name=name)
-
-
-class LabelType(models.Model):
-    """
-    A class representing a label type.
-
-    Attributes:
-        name (str): The name of the label type.
-        description (str): A description of the label type.
-
-    """
-
-    name = models.CharField(max_length=255)
-    description = models.TextField(blank=True, null=True)
-
-    objects = LabelTypeManager()
-
-    def natural_key(self):
-        """Return the natural key of this label type"""
-        return (self.name,)
-
-    def __str__(self):
-        return str(self.name)
-
-
+if TYPE_CHECKING:
+    from .label_type import LabelType
+    from .label_set import LabelSet
 class LabelManager(models.Manager):
     """Manager class for handling Label model operations."""
 
@@ -50,63 +26,58 @@ class Label(models.Model):
 
     name = models.CharField(max_length=255)
     label_type = models.ForeignKey(
-        "LabelType", on_delete=models.CASCADE, related_name="labels"
+        "LabelType", on_delete=models.CASCADE, related_name="labels", blank=True, null=True
     )
     description = models.TextField(blank=True, null=True)
 
     objects = LabelManager()
 
-    def natural_key(self):
-        """Return the natural key of this label"""
-        return (self.name,)
-
-    def __str__(self):
-        return str(self.name)
-
-
-class LabelSetManager(models.Manager):
-    """
-    Manager class for handling LabelSet model operations.
-    Methods
-    -------
-    get_by_natural_key(name)
-
-    """
-
-    def get_by_natural_key(self, name):
-        """Retrieves a LabelSet instance by its natural key (name)."""
-        return self.get(name=name)
-
-
-class LabelSet(models.Model):
-    """
-    A class representing a label set.
-
-    Attributes:
-        name (str): The name of the label set.
-        description (str): A description of the label set.
-
-    """
-
-    name = models.CharField(max_length=255)
-    description = models.TextField(blank=True, null=True)
-    version = models.IntegerField()
-    labels = models.ManyToManyField("Label", related_name="labels")
-
-    objects = LabelSetManager()
+    if TYPE_CHECKING:
+        label_type: "LabelType"
+        label_sets: models.QuerySet["LabelSet"]
 
     def natural_key(self):
-        """Return the natural key of this label set"""
+        """Return the natural key of this label"""
         return (self.name,)
 
     def __str__(self):
         return str(self.name)
+    
+    @classmethod
+    def get_outside_label(cls):
+        """
+        Returns the label instance for 'outside'.
+        """
+        try:
+            return cls.objects.get(name="outside")
+        except Exception as exc:
+            raise ValueError("'outside' label does not exist in the database") from exc
 
-    def get_labels_in_order(self):
+    @classmethod
+    def get_low_quality_label(cls):
+        """
+        Retrieve the label instance with the name 'low_quality'.
+        
+        Raises:
+            ValueError: If a label with the name 'low_quality' does not exist.
         """
-        Get all labels in this label set as list in the correct order.
-        Ordered by string representation (a is first).
+        try:
+            return cls.objects.get(name="low_quality")
+        except Exception as exc:
+            raise ValueError("'low_quality' label does not exist in the database") from exc
+        
+    @classmethod
+    def get_or_create_from_name(cls, name:str):
         """
-        labels = list(self.labels.all())
-        labels.sort(key=lambda x: x.name)
-        return labels
+        Retrieve or create a Label instance with the specified name.
+        
+        Parameters:
+            name (str): The name of the label to retrieve or create.
+        
+        Returns:
+            tuple: A tuple containing the Label instance and a boolean indicating whether the instance was created (True) or retrieved (False).
+        """
+        label, _created = cls.objects.get_or_create(name=name)
+        return label, _created
+
+

endoreg_db/models/label/label_set.py

@@ -0,0 +1,53 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+class LabelSetManager(models.Manager):
+    """
+    Manager class for handling LabelSet model operations.
+    Methods
+    -------
+    get_by_natural_key(name)
+
+    """
+
+    def get_by_natural_key(self, name):
+        """Retrieves a LabelSet instance by its natural key (name)."""
+        return self.get(name=name)
+
+
+class LabelSet(models.Model):
+    """
+    A class representing a label set.
+
+    Attributes:
+        name (str): The name of the label set.
+        description (str): A description of the label set.
+
+    """
+
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True, null=True)
+    version = models.IntegerField()
+    labels = models.ManyToManyField("Label", related_name="label_sets")
+
+    objects = LabelSetManager()
+
+    if TYPE_CHECKING:
+        from .label import Label
+        labels: models.QuerySet["Label"]
+
+    def natural_key(self):
+        """Return the natural key of this label set"""
+        return (self.name,)
+
+    def __str__(self) -> str:
+        return str(self.name)
+
+    def get_labels_in_order(self) -> list["Label"]:
+        """
+        Get all labels in this label set as list in the correct order.
+        Ordered by string representation (a is first).
+        """
+        labels = list(self.labels.all())
+        labels.sort(key=lambda x: x.name)
+        return labels

endoreg_db/models/label/label_type.py

@@ -0,0 +1,29 @@
+from django.db import models
+
+
+class LabelTypeManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+
+
+class LabelType(models.Model):
+    """
+    A class representing a label type.
+
+    Attributes:
+        name (str): The name of the label type.
+        description (str): A description of the label type.
+
+    """
+
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True, null=True)
+
+    objects = LabelTypeManager()
+
+    def natural_key(self):
+        """Return the natural key of this label type"""
+        return (self.name,)
+
+    def __str__(self):
+        return str(self.name)

endoreg_db/models/label/label_video_segment/__init__.py

@@ -0,0 +1,3 @@
+from .label_video_segment import LabelVideoSegment
+
+__all__ = ["LabelVideoSegment"]

endoreg_db/models/label/label_video_segment/_create_from_video.py

@@ -0,0 +1,41 @@
+from typing import TYPE_CHECKING, Optional
+
+if TYPE_CHECKING:
+    from endoreg_db.models import Label, VideoPredictionMeta, VideoFile
+
+
+def _create_from_video(
+    cls,
+    source: "VideoFile",
+    prediction_meta: Optional["VideoPredictionMeta"],
+    label: Optional["Label"],
+    start_frame_number: int,
+    end_frame_number: int,
+):
+    """
+    Create a LabelVideoSegment instance from a VideoFile.
+    """
+    from endoreg_db.models import VideoFile
+
+    if not isinstance(source, VideoFile):
+        raise ValueError("Source must be a VideoFile instance.")
+
+    if start_frame_number < 0 or end_frame_number < 0:
+        raise ValueError(
+            f"Frame numbers must be non-negative: start={start_frame_number}, end={end_frame_number}"
+        )
+
+    if start_frame_number > end_frame_number:
+        raise ValueError(
+            f"Start frame number ({start_frame_number}) must be less than or equal to "
+            f"end frame number ({end_frame_number})"
+        )
+
+    segment = cls(
+        start_frame_number=start_frame_number,
+        end_frame_number=end_frame_number,
+        label=label,
+        video_file=source,
+        prediction_meta=prediction_meta,
+    )
+    return segment