Test if sequence: sequence

The sequence test checks whether a value is a sequence type, which includes lists, tuples, and strings. Unlike the iterable test, it returns false for dictionaries and generators. Unlike mapping, it returns false for dictionaries.

This is useful when you need to distinguish between sequences (ordered, indexed collections) and mappings (key-value collections). For example, when processing entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] attributes that could be either a list or a dictionary, testing with sequence (and confirming the value is not a mapping) lets you determine the correct way to access the data.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{% if [1, 2, 3] is sequence %}
  It is a sequence
{% endif %}

It is a sequence

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically. Function parameters without a default are required.

sequence(
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Dictionaries pass this test in Jinja, so pair with is not mapping when you need to exclude them.
• Strings pass as sequences because they behave like sequences of characters.

Try it yourself

Ready to test this? Open Developer tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Check various types

Lists and strings are sequences, but dictionaries and numbers are not.

{{ [1, 2, 3] is sequence }}
{{ "hello" is sequence }}
{{ {"a": 1} is sequence }}
{{ 42 is sequence }}

true
true
true
false

Determine how to process data

Check whether an attribute is a list-like sequence before indexing into it.

{% set data = state_attr("sensor.forecast", "list") %}
{% if data is sequence and data is not mapping %}
  First item: {{ data[0] }}
{% endif %}

First item: sunny

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Test if iterable: iterable - Tests whether a value is iterable.

• Test if mapping: mapping - Tests whether a value is a mapping (dictionary).

• Convert to list: list - Converts a value to a list.

• Get the type of a value: typeof - Returns the type name of a value as a string.