Class PythonModule

api_app/models.py:106–271

Represents a Python module model used in the application. Attributes: module (str): The name of the module. base_path (str): The base path where the module is located. update_schedule (CrontabSchedule): The schedule for updating the module. update_task (Peri

class PythonModule(models.Model):
    """
    Represents a Python module model used in the application.

    Attributes:
        module (str): The name of the module.
        base_path (str): The base path where the module is located.
        update_schedule (CrontabSchedule): The schedule for updating the module.
        update_task (PeriodicTask): The task associated with updating the module.
        health_check_schedule (CrontabSchedule): The schedule for health checks.
    """

    module = models.CharField(max_length=120, db_index=True)
    base_path = models.CharField(max_length=120, db_index=True, choices=PythonModuleBasePaths.choices)
    update_schedule = models.ForeignKey(
        CrontabSchedule,
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
        related_name="update_for_%(class)s",
    )
    update_task = models.OneToOneField(
        PeriodicTask,
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
        related_name="update_for_%(class)s",
        editable=False,
    )

    health_check_schedule = models.ForeignKey(
        CrontabSchedule,
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
        related_name="healthcheck_for_%(class)s",
    )

    class Meta:
        unique_together = [["module", "base_path"]]
        ordering = ["base_path", "module"]

    def __str__(self):
        return self.module

    def __contains__(self, item: str):
        """
        Check if a string or PythonConfig is in the module.

        Args:
            item (str or PythonConfig): The item to check.

        Returns:
            bool: True if the item is in the module, False otherwise.
        """
        if not isinstance(item, str) and not isinstance(item, PythonConfig):
            raise TypeError(f"{self.__class__.__name__} needs a string or pythonConfig")
        if isinstance(item, str):