Class Trait

api/environments/identities/traits/models.py:10–132

class Trait(models.Model):
    TRAIT_VALUE_TYPES = (
        (INTEGER, "Integer"),
        (STRING, "String"),
        (BOOLEAN, "Boolean"),
        (FLOAT, "Float"),
    )

    # list of fields that should be updated when using bulk update (e.g. in Identity.update_traits())
    BULK_UPDATE_FIELDS = [
        "value_type",
        "string_value",
        "integer_value",
        "float_value",
        "boolean_value",
    ]

    identity = models.ForeignKey(
        "identities.Identity", related_name="identity_traits", on_delete=models.CASCADE
    )
    trait_key = models.CharField(max_length=200)
    value_type = models.CharField(
        max_length=10, choices=TRAIT_VALUE_TYPES, default=STRING, null=True, blank=True
    )
    boolean_value = models.BooleanField(null=True, blank=True)
    integer_value = models.IntegerField(null=True, blank=True)
    string_value = models.CharField(null=True, max_length=2000, blank=True)
    float_value = models.FloatField(null=True, blank=True)

    created_date = models.DateTimeField("DateCreated", auto_now_add=True)

    class Meta:
        verbose_name_plural = "User Traits"
        unique_together = ("trait_key", "identity")
        ordering = ["id"]
        # hard code the table name after moving from the environments app to prevent
        # issues with production deployment due to multi server configuration.
        db_table = "environments_trait"

    def natural_key(self):  # type: ignore[no-untyped-def]
        return (
            self.trait_key,
            self.identity.identifier,
            self.identity.environment.api_key,
        )

    @property
    def trait_value(self):  # type: ignore[no-untyped-def]
        return self.get_trait_value()  # type: ignore[no-untyped-call]

    @property
    def transient(self) -> bool:
        return getattr(self, "_transient", False)

    @transient.setter
    def transient(self, transient: bool) -> None:
        self._transient = transient