Feature flags

// access
client.flags

Feature flags — evaluate the environment's active flags for one person.

FlagsCopy Anchor Link

client.flags

Every helper performs one evaluation call. When you need several flags for the same user, call evaluate once and ask the result:

flags = client.flags.evaluate("user_1", {"plan": "pro"})
if flags.is_enabled("new_checkout"):
    ...
theme = flags.payload("paywall")

Extends Resource.

evaluate()Copy Anchor Link

def evaluate(distinct_id=None, properties=None, **extra_properties) -> FlagEvaluation

Evaluate every active flag for a person.

distinct_id falls back to the ambient nexus.context.

Parameters

Returns FlagEvaluation

all()Copy Anchor Link

def all(distinct_id=None, properties=None, **extra_properties) -> Mapping[str, Any]

Flat {key: bool | variant} map.

Parameters

Returns Mapping[str, Any]

is_enabled()Copy Anchor Link

def is_enabled(key, distinct_id=None, properties=None, *, default=False, **extra_properties) -> bool

Whether a flag is on, or default if it can't be evaluated.

Parameters

Returns bool

variant()Copy Anchor Link

def variant(key, distinct_id=None, properties=None, *, default=None, **extra_properties) -> Optional[str]

The resolved variant of a multivariate flag, else default.

Parameters

Returns Optional[str]

payload()Copy Anchor Link

def payload(key, distinct_id=None, properties=None, *, default=None, **extra_properties) -> Any

The flag's attached JSON payload, or default.

default is keyword-only so a third positional argument can't be mistaken for it — that slot is the targeting properties.

Parameters

Returns Any