Remove items by test: reject

The reject filter is the opposite of select. It iterates over a list and removes items that pass the given test, keeping only those that fail it.

This is useful when it is easier to describe what you want to exclude rather than what you want to keep. For example, you might want to remove all zero values from a list, exclude unavailable states, or filter out empty strings. Instead of writing a complex select with a negated condition, reject lets you express the exclusion directly and clearly.

Usage

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

As a filter
{{ [1, 2, 3, 4, 5] | reject("greaterthan", 3) | list }}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
[1, 2, 3]

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 = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

How to read a signature

Here is the signature of the round filter as an example:

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any
  • round is the name of the function.
  • Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For default: Any, you pass a value of any type, such as 0 or "unknown", not the word Any.
  • = 0 and = "common" are default values. You can leave out precision and method, and round uses these default values.
  • default has no =, but the parameter list marks default as optional. If you leave out default and round gets a value that isn’t a number, round raises an error.
  • -> shows the type of value the function returns.
  • Inside a signature, | means “or”. This function returns a decimal number, a whole number, or the value you passed as default.

round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.

The types you’ll see most often:

  • str: text, such as "hello"
  • int: a whole number, such as 5
  • float: a decimal number, such as 3.14
  • bool: true or false
  • list: a list of values, such as [1, 2, 3]. list[str] is a list of texts.
  • dict: a set of keys and values, such as {"name": "Kitchen"}
  • datetime and timedelta: a date and time, and a duration. For details, refer to Dates and times.
  • None: no value
  • Any: any type of value

Some signatures use special forms:

  • *args means you can pass any number of values, separated by commas. For example, average(1, 2, 3).
  • value | name(...) means the function is a filter. The value before the | is passed to the filter as its first parameter. Some filter signatures, like the round example, show this value as the first parameter between the parentheses instead.
reject(
    value: list,
    *args: str,
) -> iterable

Function parameters

The following parameters can be provided to this filter.

value list Required

The list of items to filter.

args string (Optional)

The test name as a string, optionally followed by arguments for the test. If no test is provided, items that are truthy are removed. Common tests include equalto, greaterthan, lessthan, string, number, contains, and is_number.

Reject by truthiness

When no test is specified, reject removes items that are truthy, keeping only falsy values.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]
{{ [0, 1, "", "hello", none, true] | reject | list }}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
[0, '', None]

Exclude specific values

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]: Remove unavailable states
{{
  ["on", "off", "unavailable", "on", "unknown"]
  | reject("equalto", "unavailable") | list
}}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
['on', 'off', 'on', 'unknown']

Good to know

  • Returns an iterable, not a list. Add | list before using it with length, first, or looping twice.
  • Without a test, truthy items are removed. Zero, empty strings, and None are kept because they are falsy.

Try it yourself

Ready to test this? Open Settings > 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.

Remove zero values before averaging

Exclude zero readings that might skew an average calculation.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]
{{
  [21.5, 0, 19.8, 22.3, 0]
  | reject("equalto", 0)
  | list
  | average
  | round(1)
}}
Result (floatA number that can have decimal places, like 21.5 or 3.14. Used for temperatures, percentages, and other measurements that need precision.)
21.2

Exclude non-numeric values

Remove values that are not valid numbers before performing calculations.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]
{{
  expand("sensor.temperature_sensors")
  | map(attribute="state")
  | reject("in", ["unavailable", "unknown"])
  | map("float")
  | list
}}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
[21.5, 19.8, 22.3]

Remove empty strings

Clean up a list by removing empty or blank entries.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]
{% set items = ["kitchen", "", "bedroom", "", "hall"] %}
{{ items | reject("equalto", "") | list }}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
["kitchen", "bedroom", "hall"]

Exclude outlier values

Remove temperature readings that are outside a reasonable range.

TemplateA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more]
{{
  [21.5, 19.8, -40.0, 22.3, 99.9]
  | reject("greaterthan", 50)
  | reject("lessthan", -20)
  | list
}}
Result (listAn ordered collection of values, like a list of entity IDs or a list of numbers. Written with square brackets in templates, for example [1, 2, 3].)
[21.5, 19.8, 22.3]

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.

Tip

AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.

Related template functions

These functions work well alongside this one: