endoreg-db 0.8.6.4__py3-none-any.whl

endoreg_db/models/administration/product/product_group.py

@@ -0,0 +1,39 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from endoreg_db.models import (
+        Product,
+        ReferenceProduct,
+    )
+
+class ProductGroupManager(models.Manager):
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class ProductGroup(models.Model):
+    objects = ProductGroupManager()
+
+    name = models.CharField(max_length=255)
+    
+    if TYPE_CHECKING:
+        reference_product: "ReferenceProduct"
+        products: models.QuerySet["Product"]
+
+    def natural_key(self):
+        return (self.name,)
+    
+    def __str__(self):
+        return str(self.name)
+    
+    def get_products(self) -> models.QuerySet["Product"]:
+        from .product import Product
+        products = self.products.all()
+        if products:
+            return products
+        else:
+            return Product.objects.none()
+        
+    def get_reference_product(self) -> "None | ReferenceProduct":
+        return self.reference_product 
+

endoreg_db/models/administration/product/product_material.py

@@ -0,0 +1,54 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+from endoreg_db.models.other.unit import Unit
+
+if TYPE_CHECKING:
+    from ...other.emission import EmissionFactor
+    from ...other.unit import Unit
+    from .product import Product
+    from ...other.material import Material
+
+class ProductMaterial(models.Model):
+    component = models.CharField(max_length=255)
+    material = models.ForeignKey(
+        "Material",
+        on_delete=models.CASCADE,
+        related_name="material_product_materials", # Changed related_name
+    )
+    product = models.ForeignKey(
+        "Product",
+        on_delete=models.CASCADE,
+        related_name="product_product_materials" # Changed related_name
+    )
+    unit = models.ForeignKey(
+        "Unit",
+        on_delete=models.CASCADE,
+        related_name="unit_product_materials", # Changed related_name
+    )
+    quantity = models.FloatField()
+
+    if TYPE_CHECKING:
+        product: "Product"
+        material: "Material"
+        unit: "Unit"
+        emission_factor: "EmissionFactor"
+
+    def get_emission(self) -> tuple[float, Unit]:
+        emission_factor = self.material.emission_factor
+        if emission_factor is None:
+            raise Exception("No emission factor for material " + self.material.name + " found.")
+        
+        # make sure product_material.unit is the same as emission_factor.unit
+        if self.unit != emission_factor.unit:
+            raise Exception("Unit mismatch: " + self.unit.name + " != " + emission_factor.unit.name)
+        
+        emmision_value = emission_factor.value * self.quantity
+        emission_unit = emission_factor.unit
+        return emmision_value, emission_unit
+    
+    def __str__(self) -> str:
+        return f"{self.product.name} - {self.material.name} - {self.quantity} {self.unit.name}"
+
+
+

endoreg_db/models/administration/product/product_weight.py

@@ -0,0 +1,47 @@
+from django.db import models
+import pandas as pd
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .product import Product
+    from ...other.unit import Unit
+
+class ProductWeightManager(models.Manager):
+    def get_by_natural_key(self, product, product_group, weight):
+        return self.get(product=product, product_group=product_group, weight=weight)
+    
+class ProductWeight(models.Model):
+    objects = ProductWeightManager()
+
+    name = models.CharField(max_length=255, null = True)
+    product = models.ForeignKey("Product", on_delete=models.CASCADE)
+    measured = models.FloatField(null=True)
+    verified = models.FloatField(null=True)
+    manufacturer = models.FloatField(null=True)
+    unit = models.ForeignKey("Unit", on_delete=models.SET_NULL, null=True)
+
+    if TYPE_CHECKING:
+        product: "Product"
+        unit: "Unit"
+
+    def get_weight(self):
+        if not pd.isnull(self.verified):
+            return self.verified
+        elif not pd.isnull(self.measured):
+            return self.measured
+        elif not pd.isnull(self.manufacturer):
+            return self.manufacturer
+        else:
+            return None
+        
+    def get_weight_source(self):
+        if not pd.isnull(self.verified):
+            return "verified"
+        elif not pd.isnull(self.measured):
+            return "measured"
+        elif not pd.isnull(self.manufacturer):
+            return "manufacturer"
+        else:
+            return None
+    def __str__(self):
+        return f"{self.product} - {self.get_weight()} {self.unit} (Source: {self.get_weight_source()})"

endoreg_db/models/administration/product/reference_product.py

@@ -0,0 +1,130 @@
+from django.db import models
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+    from ...other.emission import EmissionFactor
+    from .product import Product
+    from .product_group import ProductGroup
+class ReferenceProductManager(models.Manager):
+    def get_by_natural_key(self, product_name:str, product_group_name:str):
+        return self.get(product__name=product_name, product_group__name=product_group_name)
+
+class ReferenceProduct(models.Model):
+    name = models.CharField(max_length=255)
+    product = models.ForeignKey(
+        "Product",
+        on_delete=models.CASCADE,
+        related_name="reference_products",
+    )
+    product_group = models.OneToOneField(
+        "ProductGroup",
+        on_delete=models.CASCADE,
+        related_name="reference_product" # Changed from "reference_products"
+    )
+    emission_factor_total = models.ForeignKey(
+        "EmissionFactor", 
+        on_delete=models.SET_NULL, 
+        null=True, 
+        blank = True,
+        related_name="reference_products"
+        )
+    emission_factor_package = models.ForeignKey(
+        "EmissionFactor", 
+        on_delete=models.SET_NULL, 
+        null=True, 
+        related_name="reference_product_package"
+    )
+    emission_factor_product = models.ForeignKey(
+        "EmissionFactor", 
+        on_delete=models.SET_NULL, 
+        null=True, 
+        related_name="reference_product_product"
+    )
+
+    if TYPE_CHECKING:
+        product: "Product"
+        product_group: "ProductGroup"
+        emission_factor_total: "EmissionFactor"
+        emission_factor_package: "EmissionFactor"
+        emission_factor_product: "EmissionFactor"
+    
+    objects = ReferenceProductManager()
+
+    def __str__(self):
+        return self.product.name + " (" + self.product_group.name + ")"
+    
+    def set_emission_factors(self):
+        from ...other.emission import EmissionFactor
+        product = self.product
+        materials = product.product_materials.all()
+        emission_factor_name = f"{self.product_group.name}_{product.name}_total_emission_factor"
+        emission_factor_package_name = f"{self.product_group.name}_{product.name}_package_emission_factor"
+        emission_factor_product_name = f"{self.product_group.name}_{product.name}_product_emission_factor"
+
+        product_emissions = 0
+        package_emissions = 0
+
+        product_weight, product_weight_unit = product.get_product_material_weight()
+        package_weight, package_weight_unit = product.get_package_material_weight()
+        product_emission, product_emission_unit = product.get_product_material_emission()
+        package_emission, package_emission_unit = product.get_package_material_emission()
+
+        total_weight = product_weight + package_weight
+        total_emission = product_emission + package_emission
+
+        reference_unit = product_weight_unit
+        assert reference_unit == package_weight_unit, "Package weight units do not match"
+        assert reference_unit == product_emission_unit, "Product emission units do not match"
+        assert reference_unit == package_emission_unit, "Package emission units do not match"
+
+        product_emission_factor_value = product_emission / product_weight
+        package_emission_factor_value = package_emission / package_weight
+        total_emission_factor_value = total_emission / total_weight
+
+        emission_factor, created = EmissionFactor.objects.get_or_create(
+            name=emission_factor_name,
+            defaults={
+                "name": emission_factor_name,
+                "value": total_emission_factor_value,
+                "unit": reference_unit
+            }
+        )
+        self.emission_factor_total = emission_factor
+
+        emission_factor_package, created = EmissionFactor.objects.get_or_create(
+            name=emission_factor_package_name,
+            defaults={
+                "name": emission_factor_package_name,
+                "value": package_emission_factor_value,
+                "unit": reference_unit
+            }
+        )
+        self.emission_factor_package = emission_factor_package
+
+        emission_factor_product, created = EmissionFactor.objects.get_or_create(
+            name=emission_factor_product_name,
+            defaults={
+                "name": emission_factor_product_name,
+                "value": product_emission_factor_value,
+                "unit": reference_unit
+            }
+        )
+        self.emission_factor_product = emission_factor_product
+
+        self.save()
+
+    def get_emission_factor(self, component:str):
+        # check if emission_factor_total exists:
+        if self.emission_factor_total is None:
+            self.set_emission_factors()
+
+        if component == "total":
+            return self.emission_factor_total
+        elif component == "package":
+            return self.emission_factor_package
+        elif component == "product":
+            return self.emission_factor_product
+        else:
+            raise Exception("Unknown component: " + component)
+
+
+

endoreg_db/models/administration/qualification/__init__.py

@@ -0,0 +1,7 @@
+from .qualification import Qualification
+from .qualification_type import QualificationType
+
+__all__ = [
+    "Qualification",
+    "QualificationType",
+]

endoreg_db/models/administration/qualification/qualification.py

@@ -0,0 +1,37 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from endoreg_db.models import (
+        QualificationType,
+    )
+
+class QualificationManager(models.Manager):
+    def get_queryset(self):
+        """
+        Returns a queryset of qualifications filtered to include only active entries.
+        """
+        return super().get_queryset().filter(is_active=True)
+    
+class Qualification(models.Model):
+    """
+    Model representing a qualification.
+    """
+    name = models.CharField(max_length=255, unique=True)
+    description = models.TextField(blank=True, null=True)
+    is_active = models.BooleanField(default=True)
+
+    qualification_types = models.ManyToManyField(
+        "QualificationType",
+        related_name="qualifications",
+    )
+    if TYPE_CHECKING:
+        qualification_types: models.QuerySet["QualificationType"]
+
+    objects = QualificationManager()
+
+    def __str__(self):
+        """
+        Returns the string representation of the qualification's name.
+        """
+        return str(self.name)

endoreg_db/models/administration/qualification/qualification_type.py

@@ -0,0 +1,35 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from endoreg_db.models import (
+        Qualification,
+    )
+
+class QualificationTypeManager(models.Manager):
+    def get_queryset(self):
+        """
+        Returns a queryset of active qualification types.
+        
+        Only includes records where the `is_active` field is set to True.
+        """
+        return super().get_queryset().filter(is_active=True)
+    
+class QualificationType(models.Model):
+    """
+    Model representing a qualification type.
+    """
+    name = models.CharField(max_length=255, unique=True)
+    description = models.TextField(blank=True, null=True)
+    is_active = models.BooleanField(default=True)
+
+    objects = QualificationTypeManager()
+
+    if TYPE_CHECKING:
+        qualification: models.QuerySet["Qualification"]
+
+    def __str__(self):
+        """
+        Returns the string representation of the qualification type's name.
+        """
+        return str(self.name)

endoreg_db/models/administration/shift/__init__.py

@@ -0,0 +1,9 @@
+from .shift import Shift
+from .shift_type import ShiftType
+from .scheduled_days import ScheduledDays
+
+__all__ = [
+    "Shift",
+    "ShiftType",
+    "ScheduledDays",
+]

endoreg_db/models/administration/shift/scheduled_days.py

@@ -0,0 +1,69 @@
+from django.db import models
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from endoreg_db.models import (
+        CenterShift,
+    )
+
+class ScheduledDaysManager(models.Manager):
+    def get_by_natural_key(self, name):
+        """
+        Retrieves a ScheduledDays instance by its unique name.
+        
+        Args:
+            name: The unique name of the ScheduledDays instance to retrieve.
+        
+        Returns:
+            The ScheduledDays instance matching the given name.
+        """
+        return self.get(name=name)
+    
+class ScheduledDays(models.Model):
+    """
+    Model representing scheduled days for a shift.
+    """
+    name = models.CharField(
+        max_length=255,
+        unique=True,
+        help_text="Name of the scheduled days.",
+    )
+    working_days = models.BooleanField(
+        null=True,
+        blank=True,
+        default=True,
+    )
+
+    non_working_days = models.BooleanField(
+        null=True,
+        blank=True,
+        default=False,
+    )
+
+    limited_time = models.BooleanField(
+        null=True,
+        blank=True,
+        default=False,
+    )
+
+    start_date = models.DateField(
+        null=True,
+        blank=True,
+    )
+
+    end_date = models.DateField(
+        null=True,
+        blank=True,
+    )
+
+    objects = ScheduledDaysManager()
+
+    if TYPE_CHECKING:
+        center_shifts: models.QuerySet["CenterShift"]
+
+    def __str__(self):
+        """
+        Returns a string representation of the scheduled day, including its name and date range.
+        """
+        return f"{self.name} - {self.start_date} to {self.end_date}"

endoreg_db/models/administration/shift/shift.py

@@ -0,0 +1,51 @@
+from django.db import models
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from endoreg_db.models import (
+        ShiftType,
+        Qualification,
+        CenterShift,
+    )
+
+class ShiftManager(models.Manager):
+    def get_queryset(self):
+        """
+        Returns a queryset of active shifts.
+        
+        Only includes shifts where the 'is_active' field is set to True.
+        """
+        return super().get_queryset().filter(is_active=True)
+    
+class Shift(models.Model):
+    """
+    Model representing a shift.
+    """
+    name = models.CharField(max_length=255, unique=True)
+    description = models.TextField(blank=True, null=True)
+    is_active = models.BooleanField(default=True)  
+
+
+    shift_types = models.ManyToManyField(
+        "ShiftType",
+        related_name="shifts",
+    )
+
+    required_qualifications = models.ManyToManyField(
+        "Qualification",
+        related_name="shifts",
+    )
+
+    if TYPE_CHECKING:
+        shift_types: models.QuerySet["ShiftType"]
+        required_qualifications: models.QuerySet["Qualification"]
+        center_shifts: models.QuerySet["CenterShift"]
+
+    objects = ShiftManager()
+
+    def __str__(self):
+        """
+        Returns the string representation of the shift using its name.
+        """
+        return str(self.name)

endoreg_db/models/administration/shift/shift_type.py

@@ -0,0 +1,108 @@
+import logging # Added import
+from django.db import models
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from endoreg_db.models import Shift
+
+# Those are defined in our base data
+NAME_REGULAR = "regular"
+NAME_ON_CALL = "on_call"
+NAME_WARD = "ward"
+NAME_OFF_HOURS = "off_hours"
+
+logger = logging.getLogger(__name__) # Added logger
+
+class ShiftTypeManager(models.Manager):
+    def get_queryset(self):
+        """
+        Returns a queryset containing only active shift types.
+        """
+        return super().get_queryset().filter(is_active=True)
+    
+class ShiftType(models.Model):
+    """
+    Model representing a Shift type.
+    """
+    name = models.CharField(max_length=255, unique=True)
+    description = models.TextField(blank=True, null=True)
+    is_active = models.BooleanField(default=True)
+
+    objects = ShiftTypeManager()
+
+    if TYPE_CHECKING:
+        shift: models.QuerySet["Shift"]
+
+    def __str__(self):
+        """
+        Returns the name of the shift type as its string representation.
+        """
+        return str(self.name)
+
+    @classmethod
+    def get_type_regular(cls) -> "ShiftType | None": # Modified return type
+        """
+        Retrieves the 'regular' shift type instance.
+        
+        Returns:
+            The ShiftType instance with the name 'regular', or None if it does not exist.
+        """
+        try:
+            return cls.objects.get(name=NAME_REGULAR)
+        except cls.DoesNotExist:
+            logger.error(
+                f"ShiftType with name '{NAME_REGULAR}' does not exist. "
+                "Base data might be missing."
+            )
+            return None
+    
+    @classmethod
+    def get_type_on_call(cls) -> "ShiftType | None": # Modified return type
+        """
+        Retrieves the ShiftType instance representing the on-call shift type.
+        
+        Returns:
+            The ShiftType instance with the on-call name, or None if it does not exist.
+        """
+        try:
+            return cls.objects.get(name=NAME_ON_CALL)
+        except cls.DoesNotExist:
+            logger.error(
+                f"ShiftType with name '{NAME_ON_CALL}' does not exist. "
+                "Base data might be missing."
+            )
+            return None
+    
+    @classmethod
+    def get_type_ward(cls) -> "ShiftType | None": # Modified return type
+        """
+        Retrieves the ShiftType instance representing a ward shift.
+        
+        Returns:
+            The ShiftType instance with the name corresponding to a ward shift, or None if it does not exist.
+        """
+        try:
+            return cls.objects.get(name=NAME_WARD)
+        except cls.DoesNotExist:
+            logger.error(
+                f"ShiftType with name '{NAME_WARD}' does not exist. "
+                "Base data might be missing."
+            )
+            return None
+    
+    @classmethod
+    def get_type_off_hours(cls) -> "ShiftType | None": # Modified return type
+        """
+        Retrieves the off-hours shift type instance by name.
+        
+        Returns:
+            The ShiftType instance for off-hours if it exists, otherwise None.
+        """
+        try:
+            return cls.objects.get(name=NAME_OFF_HOURS)
+        except cls.DoesNotExist:
+            logger.error(
+                f"ShiftType with name '{NAME_OFF_HOURS}' does not exist. "
+                "Base data might be missing."
+            )
+            return None

endoreg_db/models/label/__init__.py

@@ -0,0 +1,24 @@
+from .label import Label
+from .label_set import LabelSet
+from .label_type import LabelType
+from .video_segmentation_label import VideoSegmentationLabel
+from .video_segmentation_labelset import VideoSegmentationLabelSet
+from .label_video_segment import (
+    LabelVideoSegment,
+)
+
+from .annotation import (
+    ImageClassificationAnnotation,
+    VideoSegmentationAnnotation,
+)
+
+__all__ = [
+    "Label",
+    "LabelSet",
+    "LabelType",
+    "VideoSegmentationLabel",
+    "VideoSegmentationLabelSet",
+    "LabelVideoSegment",
+    "ImageClassificationAnnotation",
+    "VideoSegmentationAnnotation",
+]

endoreg_db/models/label/annotation/__init__.py

@@ -0,0 +1,12 @@
+"""Module for annotation models"""
+
+from .image_classification import ImageClassificationAnnotation
+
+from .video_segmentation_annotation import (
+    VideoSegmentationAnnotation,
+)
+
+__all__ = [
+    "ImageClassificationAnnotation",
+    "VideoSegmentationAnnotation",
+]