endoreg-db 0.8.6.1__py3-none-any.whl → 0.8.8.0__py3-none-any.whl

endoreg_db/models/administration/center/center_resource.py

@@ -1,12 +1,14 @@
-from django.db import models
 from typing import TYPE_CHECKING
 
+from django.db import models
+
 if TYPE_CHECKING:
-    from .center import Center
+    from ...other.emission import EmissionFactor
     from ...other.resource import Resource
     from ...other.unit import Unit
-    from ...other.emission import EmissionFactor
-    
+    from .center import Center
+
+
 class CenterResource(models.Model):
     name = models.CharField(max_length=255, null=True)
     center = models.ForeignKey(
@@ -16,34 +18,38 @@ class CenterResource(models.Model):
     )
     quantity = models.FloatField()
     resource = models.ForeignKey("Resource", on_delete=models.CASCADE)
-    transport_emission_factor = models.ForeignKey("EmissionFactor", on_delete=models.SET_NULL, null=True,
-                                                  related_name="center_resource_transport_emission_factor")
-    use_emission_factor = models.ForeignKey("EmissionFactor", on_delete=models.SET_NULL, null=True,
-                                            related_name="center_resource_use_emission_factor")
+    transport_emission_factor = models.ForeignKey(
+        "EmissionFactor", on_delete=models.SET_NULL, null=True, related_name="center_resource_transport_emission_factor"
+    )
+    use_emission_factor = models.ForeignKey("EmissionFactor", on_delete=models.SET_NULL, null=True, related_name="center_resource_use_emission_factor")
     year = models.IntegerField()
     unit = models.ForeignKey("Unit", on_delete=models.SET_NULL, null=True)
-    
+
     if TYPE_CHECKING:
-        center: "Center"
-        resource: "Resource"
-        transport_emission_factor: "EmissionFactor"
-        use_emission_factor: "EmissionFactor"
-        unit: "Unit"
+        center: models.ForeignKey["Center"]
+        resource: models.ForeignKey["Resource"]
+        transport_emission_factor: models.ForeignKey["EmissionFactor|None"]
+        use_emission_factor: models.ForeignKey["EmissionFactor|None"]
+        unit: models.ForeignKey["Unit|None"]
 
     def __str__(self):
-        result_string = ""
+        return f"CenterResource {self.pk} - {self.name if self.name else 'No Name'}"
 
-        if self.name is not None:
-            result_string += self.name + ":\n"
+    def display_str(self) -> str:
+        """Return a verbose description of the center resource."""
+        result_string = f"{self.name}:\n"
 
         result_string += "\tCenter\t-\t" + str(self.center) + "\n"
         result_string += "\tResource\t-\t" + str(self.resource) + "\n"
         result_string += "\tQuantity\t-\t" + str(self.quantity) + "\n"
         result_string += "\tYear\t-\t" + str(self.year) + "\n"
         result_string += "\tUnit\t-\t" + str(self.unit) + "\n"
-        result_string += "\tTransport Emission Factor\t-\t" + str(self.transport_emission_factor) + "\n"
+
+        if self.transport_emission_factor is not None:
+            result_string += "\tTransport Emission Factor\t-\t" + str(self.transport_emission_factor) + "\n"
+
         result_string += "\tUse Emission Factor\t-\t" + str(self.use_emission_factor) + "\n"
 
         result_string += "\n"
 
-        return result_string
+        return result_string

endoreg_db/models/administration/center/center_shift.py

@@ -1,30 +1,35 @@
+from decimal import Decimal
+from typing import TYPE_CHECKING, cast
+
 from django.db import models
-from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from endoreg_db.models import (
         Center,
-        Shift,
         ScheduledDays,
+        Shift,
     )
 
+
 class CenterShiftManager(models.Manager):
     def get_by_natural_key(self, name):
         """
         Retrieves a CenterShift instance by its unique name.
-        
+
         Args:
             name: The unique identifier of the CenterShift.
-        
+
         Returns:
             The CenterShift instance with the specified name.
         """
         return self.get(name=name)
 
+
 class CenterShift(models.Model):
     """
     Model representing a center shift.
     """
+
     name = models.CharField(max_length=255, unique=True)
     description = models.TextField(blank=True, null=True)
 
@@ -46,43 +51,42 @@ class CenterShift(models.Model):
         related_name="center_shifts",
     )
 
-    #TODO add validator; the value should be between 0 and 1
+    # TODO add validator; the value should be between 0 and 1
     estimated_presence_fraction = models.DecimalField(
         max_digits=5,
         decimal_places=4,
-        default=0.0,
+        default=Decimal("0"),
     )
 
     if TYPE_CHECKING:
-        center: "Center"
-        shift: "Shift"
-        scheduled_days: models.QuerySet["ScheduledDays"]
+        center: models.ForeignKey["Center"]
+        shift: models.ForeignKey["Shift"]
+        scheduled_days = cast(models.manager.RelatedManager["ScheduledDays"], scheduled_days)
 
     def __str__(self):
         """
         Returns a string representation of the center shift, combining the center and shift.
         """
         return f"{self.center} - {self.shift}"
-    
+
     def initialize_scheduled_days(self):
         # shift_types
         """
         Initializes scheduled days for the center shift.
-        
+
         This method is a placeholder and does not perform any actions.
         """
         pass
-    
-    def get_scheduled_days(self, infer = True):
+
+    def get_scheduled_days(self, infer=True):
         """
         Retrieves the scheduled days associated with this center shift.
-        
+
         If no scheduled days are found and `infer` is False, raises a ValueError. Otherwise, returns the queryset of scheduled days, which may be empty.
         """
         sd = self.scheduled_days.all()
         if not sd.exists():
             if not infer:
                 raise ValueError("No scheduled days found for this center shift.")
-            
-        
-        return sd
+
+        return sd

endoreg_db/models/administration/center/center_waste.py

@@ -1,12 +1,14 @@
-from django.db import models
 from typing import TYPE_CHECKING
 
+from django.db import models
+
 if TYPE_CHECKING:
-    from .center import Center
-    from ...other.waste import Waste
-    from ...other.unit import Unit
     from ...other.emission import EmissionFactor
-    
+    from ...other.unit import Unit
+    from ...other.waste import Waste
+    from .center import Center
+
+
 class CenterWaste(models.Model):
     center: models.ForeignKey["Center"] = models.ForeignKey(
         "Center",
@@ -16,9 +18,15 @@ class CenterWaste(models.Model):
     year = models.IntegerField()
     waste: models.ForeignKey["Waste"] = models.ForeignKey("Waste", on_delete=models.CASCADE)
     quantity = models.FloatField()
-    unit: models.ForeignKey["Unit"] = models.ForeignKey("Unit", on_delete=models.SET_NULL, null=True)
-    emission_factor: models.ForeignKey["EmissionFactor"] = models.ForeignKey("EmissionFactor", on_delete=models.SET_NULL, null=True)
-    
+    unit = models.ForeignKey("Unit", on_delete=models.SET_NULL, null=True)
+    emission_factor = models.ForeignKey("EmissionFactor", on_delete=models.SET_NULL, null=True)
+
+    if TYPE_CHECKING:
+        center: models.ForeignKey["Center"]
+        waste: models.ForeignKey["Waste"]
+        unit: models.ForeignKey["Unit|None"]
+        emission_factor: models.ForeignKey["EmissionFactor|None"]
+
     def __str__(self) -> str:
         """
         Returns a formatted string summarizing the waste record, including quantity, unit,

endoreg_db/models/administration/person/__init__.py

@@ -1,6 +1,7 @@
 from .person import Person
 from .patient import (
     Patient,
+    PatientExternalID,
 )
 from .examiner import Examiner
 from .user.portal_user_information import PortalUserInfo
@@ -13,6 +14,7 @@ from .employee import Employee, EmployeeType, EmployeeQualification
 __all__ = [
     "Person",
     "Patient",
+    "PatientExternalID",
     "Examiner",
     "PortalUserInfo",
     "FirstName",

endoreg_db/models/administration/person/employee/employee.py

@@ -1,16 +1,21 @@
-from django.db import models
 from typing import TYPE_CHECKING
+
+from django.db import models
+
 from ..person import Person
+
 if TYPE_CHECKING:
     from endoreg_db.models import (
-        EmployeeType,
         EmployeeQualification,
+        EmployeeType,
     )
 
+
 class Employee(Person):
     """
     Model representing an employee.
     """
+
     employee_type = models.ForeignKey(
         "EmployeeType",
         on_delete=models.CASCADE,
@@ -18,9 +23,9 @@ class Employee(Person):
     )
 
     if TYPE_CHECKING:
-        employee_type: "EmployeeType"
-        qualification: "EmployeeQualification"
-
+        employee_type: models.ForeignKey["EmployeeType"]
+        # qualification is a OneToOneField defined in the EmployeeQualification model
+        qualification: models.OneToOneField["EmployeeQualification"]
 
     def __str__(self):
         """

endoreg_db/models/administration/person/employee/employee_qualification.py

@@ -1,16 +1,21 @@
+from typing import TYPE_CHECKING, cast
+
 from django.db import models
 
-from typing import TYPE_CHECKING
 if TYPE_CHECKING:
+    from django.db.models.manager import RelatedManager
+
     from endoreg_db.models import (
         Employee,
         Qualification,
     )
 
+
 class EmployeeQualification(models.Model):
     """
     Model representing an employee's qualification.
     """
+
     employee = models.OneToOneField(
         "Employee",
         on_delete=models.CASCADE,
@@ -23,12 +28,12 @@ class EmployeeQualification(models.Model):
 
     if TYPE_CHECKING:
         employee: models.ForeignKey["Employee"]
-        qualifications: models.QuerySet["Qualification"]
+        qualifications = cast(RelatedManager[Qualification], qualifications)
 
     def __str__(self):
         """
         Returns a human-readable string summarizing the employee and their qualifications.
-        
+
         If the employee has qualifications, lists them separated by commas; otherwise, indicates that no qualifications are assigned.
         """
         qualification_list = self.qualifications.all()
@@ -36,4 +41,4 @@ class EmployeeQualification(models.Model):
             # Assuming Qualification model has a decent __str__ representation
             qual_names = ", ".join(str(q) for q in qualification_list)
             return f"{self.employee} - Qualifications: {qual_names}"
-        return f"{self.employee} - No qualifications assigned"
+        return f"{self.employee} - No qualifications assigned"

endoreg_db/models/administration/person/employee/employee_type.py

@@ -1,25 +1,29 @@
+from typing import TYPE_CHECKING, cast
+
 from django.db import models
-from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from endoreg_db.models import (
-        Qualification,
         Employee,
+        Qualification,
     )
 
+
 class EmployeeTypeManager(models.Manager):
     def get_queryset(self):
         """
         Returns a queryset of active employee types.
-        
+
         Only employee types with is_active set to True are included in the queryset.
         """
         return super().get_queryset().filter(is_active=True)
-    
+
+
 class EmployeeType(models.Model):
     """
     Model representing an employee type.
     """
+
     name = models.CharField(max_length=255, unique=True)
     description = models.TextField(blank=True, null=True)
     is_active = models.BooleanField(default=True)
@@ -30,8 +34,10 @@ class EmployeeType(models.Model):
     )
 
     if TYPE_CHECKING:
-        qualifications: models.QuerySet["Qualification"]
-        employees: models.QuerySet["Employee"]
+        qualifications = cast(models.manager.RelatedManager["Qualification"], qualifications)
+
+        @property
+        def employees(self) -> models.QuerySet["Employee"]: ...
 
     objects = EmployeeTypeManager()
 

endoreg_db/models/administration/person/examiner/examiner.py

@@ -1,20 +1,23 @@
-from django.db import models
-from ..person import Person
-from endoreg_db.utils import get_examiner_hash, create_mock_examiner_name
 from typing import TYPE_CHECKING
 
+from django.db import models
+
+from endoreg_db.utils import create_mock_examiner_name, get_examiner_hash
+
 from ....utils import DJANGO_NAME_SALT
+from ..person import Person
+
 if TYPE_CHECKING:
     from endoreg_db.models import administration
+
+
 class Examiner(Person):
-    center = models.ForeignKey(
-        "Center", on_delete=models.CASCADE, blank=True, null=True
-    )
+    center = models.ForeignKey("Center", on_delete=models.CASCADE, blank=True, null=True)
     hash = models.CharField(max_length=255, unique=True)
 
     if TYPE_CHECKING:
-        center: "administration.Center"
-        portal_user_info: "administration.PortalUserInfo"
+        center: models.ForeignKey["administration.Center|None"]
+        portal_user_info: models.OneToOneField["administration.PortalUserInfo"]
 
     def __str__(self):
         return self.first_name + " " + self.last_name
@@ -28,11 +31,10 @@ class Examiner(Person):
 
         if isinstance(first_name, FirstName):
             first_name = str(first_name.name)
-        
+
         if isinstance(last_name, LastName):
             last_name = str(last_name.name)
 
-
         real_hash = get_examiner_hash(
             first_name=first_name,
             last_name=last_name,
@@ -42,7 +44,7 @@ class Examiner(Person):
 
         if substitute_names:
             name_tuple = create_mock_examiner_name()
-        
+
         else:
             name_tuple = (first_name, last_name)
         defaults = dict(

endoreg_db/models/administration/person/patient/__init__.py

@@ -1,5 +1,7 @@
 from .patient import Patient
+from .patient_external_id import PatientExternalID
 
 __all__ = [
     "Patient",
+    "PatientExternalID",
 ]