Method annotate_configured

api_app/queryset.py:788–842

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

(self, user: User = None)

    """

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

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

        Returns:
            PythonConfigQuerySet: The annotated queryset.
        """
        # a Python plugin is configured only if every required parameter is configured
        from api_app.models import Parameter, PluginConfig

        return (
            # we retrieve the number or required parameters
            self.alias(
                required_params=Coalesce(
                    Subquery(
                        Parameter.objects.filter(python_module=OuterRef("python_module"), required=True)
                        # count them
                        .annotate(count=Func(F("pk"), function="Count"))
                        .values("count"),
                        output_field=IntegerField(),
                    ),
                    0,
                )
            )
            # how many of them are configured
            .alias(
                # just to be sure that if the query fails, we return an integered
                required_configured_params=Coalesce(
                    Subquery(
                        # we count how many parameters have a valid value
                        # considering the values that the user has access to
                        Parameter.objects.filter(
                            pk__in=Subquery(
                                # we get all values that the user can see
                                PluginConfig.objects.filter(
                                    **{self.model.snake_case_name: OuterRef(OuterRef("pk"))},
                                    parameter__required=True,
                                )
                                .visible_for_user(user)
                                .values("parameter__pk")
                            )
                        )
                        .annotate(count=Func(F("pk"), function="Count"))
                        .values("count"),
                        output_field=IntegerField(),
                    ),
                    0,
                )
            )
            # and we save the difference
            .annotate(configured=Exact(F("required_params") - F("required_configured_params"), 0))
        )

    def annotate_runnable(self, user: User = None) -> "PythonConfigQuerySet":
        """