Class Environment

api/environments/models.py:80–620

class Environment(
    LifecycleModel,  # type: ignore[misc]
    abstract_base_auditable_model_factory(  # type: ignore[misc]
        change_details_excluded_fields=["updated_at"],
        historical_records_excluded_fields=["uuid"],
    ),
    SoftDeleteObject,  # type: ignore[misc]
):
    history_record_class_path = "environments.models.HistoricalEnvironment"
    related_object_type = RelatedObjectType.ENVIRONMENT

    name = models.CharField(max_length=2000)  # type: ignore[var-annotated]
    uuid = models.UUIDField(default=uuid.uuid4, unique=True, editable=False)  # type: ignore[var-annotated]
    created_date = models.DateTimeField("DateCreated", auto_now_add=True)  # type: ignore[var-annotated]
    description = models.TextField(null=True, blank=True, max_length=20000)  # type: ignore[var-annotated]
    project = models.ForeignKey(  # type: ignore[var-annotated]
        "projects.Project",
        related_name="environments",
        help_text=(
            "Changing the project selected will remove all previous Feature States for"
            " the previously associated projects Features that are related to this"
            " Environment. New default Feature States will be created for the new"
            " selected projects Features for this Environment."
        ),
        # Cascade deletes are decouple from the Django ORM. See this PR for details.
        # https://github.com/Flagsmith/flagsmith/pull/3360/
        on_delete=models.DO_NOTHING,
    )

    api_key = models.CharField(  # type: ignore[var-annotated]
        default=generate_client_api_key, unique=True, max_length=100
    )

    minimum_change_request_approvals = models.IntegerField(blank=True, null=True)  # type: ignore[var-annotated]

    webhooks_enabled = models.BooleanField(default=False, help_text="DEPRECATED FIELD.")  # type: ignore[var-annotated]  # noqa: E501
    webhook_url = models.URLField(null=True, blank=True, help_text="DEPRECATED FIELD.")  # type: ignore[var-annotated]

    allow_client_traits = models.BooleanField(  # type: ignore[var-annotated]
        default=True, help_text="Allows clients using the client API key to set traits."
    )
    updated_at = models.DateTimeField(  # type: ignore[var-annotated]
        default=timezone.now,
        help_text="Tracks changes to self and related entities, e.g. FeatureStates.",
    )
    banner_text = models.CharField(null=True, blank=True, max_length=255)  # type: ignore[var-annotated]
    banner_colour = models.CharField(  # type: ignore[var-annotated]
        null=True, blank=True, max_length=7, help_text="hex code for the banner colour"
    )
    metadata = GenericRelation(Metadata)

    hide_disabled_flags = models.BooleanField(  # type: ignore[var-annotated]
        null=True,
        blank=True,
        help_text=(
            "If true will exclude flags from SDK which are disabled. NOTE: If set, this"
            " will override the project `hide_disabled_flags`"
        ),