Class ExperimentSerializer

api/experimentation/serializers.py:249–345

class ExperimentSerializer(serializers.ModelSerializer):  # type: ignore[type-arg]
    # Annotated with the common base type so ExperimentListSerializer can
    # override the field with a read-only representation.
    metrics: serializers.BaseSerializer[Any] = ExperimentMetricInlineSerializer(
        many=True,
        required=False,
        write_only=True,
    )
    experiment_rollout: Any = ExperimentRolloutSerializer(
        required=False, write_only=True
    )

    class Meta:
        model = Experiment
        fields = (
            "id",
            "feature",
            "name",
            "hypothesis",
            "status",
            "metrics",
            "experiment_rollout",
            "created_at",
            "updated_at",
            "started_at",
            "ended_at",
        )
        read_only_fields = (
            "id",
            "status",
            "created_at",
            "updated_at",
            "started_at",
            "ended_at",
        )

    def validate_feature(self, feature: Any) -> Any:
        if feature.type != MULTIVARIATE:
            raise serializers.ValidationError(
                "Experiments can only be created for multivariate flags."
            )
        environment: Environment | None = self.context.get("environment")
        if environment and feature.project_id != environment.project_id:
            raise serializers.ValidationError(
                "Feature does not belong to this environment's project."
            )
        return feature

    def validate(self, attrs: dict[str, Any]) -> dict[str, Any]:
        if self.instance is not None and "feature" in attrs:
            raise serializers.ValidationError(
                {"feature": "Cannot change the feature of an existing experiment."}
            )
        if self.instance is not None and "metrics" in attrs:
            raise serializers.ValidationError(
                {"metrics": "Cannot change the metrics of an existing experiment."}
            )
        if self.instance is not None and "experiment_rollout" in attrs: