Test same object: sameas

The sameas test checks whether two values are the exact same object in memory (identity), not merely equal in value. It is equivalent to Python’s is operator. Use value is sameas(other) to perform the check.

In most Home Assistant templates, you will use eq or == for value comparisons. The sameas test is primarily useful when you need to distinguish between identity and equality, such as checking if a value is specifically true, false, or none as singletons rather than merely equal to them.

Usage

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

{% if true is sameas(true) %}
  Same object
{% endif %}

Same object

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.

sameas(
    value: Any,
    other: Any,
) -> bool

Function parameters

The following parameters can be provided to this test.

Good to know

• Identity, not equality. 1 is sameas(true) is false even though 1 == true.
• Mostly useful for checking singletons like true, false, and none. For normal value comparison, use eq.

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.

Identity vs equality

Two values can be equal but not the same object.

{{ true is sameas(true) }}
{{ 1 is sameas(true) }}

true
false

Check for specific singletons

Verify that a value is the actual none singleton rather than something that equals None.

{% set val = none %}
{% if val is sameas(none) %}
  Value is None
{% endif %}

Value is None

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 equality: eq - Tests if two values are equal. Also known as equalto or ==.

• Test if none: none - Tests whether a value is None.

• Test if defined: defined - Tests whether a variable is defined (not undefined).