Test if iterable: iterable

The iterable test checks whether a value can be iterated over. It returns true for lists, tuples, strings, dictionaries, generators, and other iterable types. It returns false for non-iterable types like numbers, booleans, and None.

This is useful when you need to verify that a value can be looped over with {% for %} before attempting to do so. Some 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 might be a list in some cases and a single value in others. Testing with iterable prevents errors when the value turns out not to be something you can loop over.

Usage

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

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

It is iterable

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.

iterable(
    value: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Strings pass this test because they are iterable character by character.
• Use sequence if you want to exclude dictionaries or use mapping to match only dictionaries.

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, strings, and dictionaries are iterable. Numbers and booleans are not.

{{ [1, 2] is iterable }}
{{ "hello" is iterable }}
{{ 42 is iterable }}

true
true
false

Guard a loop

Only attempt to iterate over an attribute if it is actually iterable.

{% set items = state_attr("sensor.device", "features") %}
{% if items is iterable %}
  {% for item in items %}
    - {{ item }}
  {% endfor %}
{% else %}
  No features available
{% endif %}

- wifi
- bluetooth

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 sequence: sequence - Tests whether a value is a sequence (list, tuple, or string).

• 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.