Method annotate_runnable

api_app/queryset.py:844–875

Annotates configurations indicating if they are runnable. Args: user (User, optional): The user to check. Defaults to None. Returns: PythonConfigQuerySet: The annotated queryset.

(self, user: User = None)

        )

    def annotate_runnable(self, user: User = None) -> "PythonConfigQuerySet":
        """
        Annotates configurations indicating if they are runnable.

        Args:
            user (User, optional): The user to check. Defaults to None.

        Returns:
            PythonConfigQuerySet: The annotated queryset.
        """
        # we are excluding the plugins that has failed the health_check
        qs = (
            self.exclude(health_check_status=False)
            # we save the `configured` attribute in the queryset
            .annotate_configured(user)
        )
        return (
            # this super call parameters are required
            super(PythonConfigQuerySet, qs)
            # we set the parent `runnable` attribute
            .annotate_runnable(user)
            # and we do the logic AND between the two fields
            .annotate(
                runnable=Exact(
                    # I have no idea how to do the compare
                    # of two boolean field in a subquery.
                    # this is the same as runnable =`configured` AND `runnable`
                    Cast(F("configured"), IntegerField()) * Cast(F("runnable"), IntegerField()),
                    1,
                )
            )
        )

    def get_signatures(self, job) -> Generator[Signature, None, None]:
        """