5 Best Ways to Check if Python Iterable Contains an Element

by
💡 Problem Formulation:

Finding out whether a specific element is present within an iterable is acommon task in Python. For example, if you have a list my_list = [1, 2, 3, 4, 5] and you want to check if the value 3 is in my_list, this article presents five ways to do so, along with examples and discussions of their strengths and limitations.

Method 1: The in Operator

The in operator is the most straightforward and pythonic way to check if an element is contained within an iterable. It returns True if the element is found, else False. This method is very readable and fast for most use cases.

Here’s an example:

my_list = ['apple', 'banana', 'cherry']
element = 'banana'
is_present = element in my_list
print(is_present)

Output:

True

This succinct line is_present = element in my_list checks for the presence of the element ‘banana’ in the list and stores the boolean result in the variable is_present.

Method 2: The count() Method

The count() method of a list returns the number of occurrences of an element. If the returned count is greater than zero, the element is present. This method is not recommended for simply checking presence because it counts all instances instead of stopping at the first.

Here’s an example:

my_list = [1, 3, 7, 1, 3, 1, 4]
element = 3
is_present = my_list.count(element) > 0
print(is_present)

Output:

True

This code uses count() to determine how many times element appears in my_list and evaluates to True since there is at least one occurrence.

Method 3: The any() Function with a Generator Expression

The any() function can be used with a generator expression to check for element presence. It returns True if at least one of the conditions in the expression is True. It is efficient because it stops iterating as soon as it finds a match.

Here’s an example:

my_list = ['dog', 'cat', 'parrot']
element = 'parrot'
is_present = any(e == element for e in my_list)
print(is_present)

Output:

True

In this example, any() checks through my_list to find if element is present, returning True at the first occurrence without checking the remaining items.

Method 4: The next() Function with a Generator Expression

The next() function used with a generator expression and a default value can also determine presence. If the generator yields no values, the default is returned. If the default is not supplied and the generator yields no values, a StopIteration exception is raised.

Here’s an example:

my_list = [10, 20, 30, 40]
element = 20
is_present = next((True for e in my_list if e == element), False)
print(is_present)

Output:

True

The expression next((True for e in my_list if e == element), False) checks each element and stops when element is found, returning True. If not found, it returns False.

Bonus One-Liner Method 5: Use __contains__() Method

The dunder method __contains__() is the underlying method of the in operator. It can be called directly, though using in is more readable and pythonic. This method is mainly for illustrating how in works under the hood.

Here’s an example:

my_list = ['x', 'y', 'z']
element = 'y'
is_present = my_list.__contains__(element)
print(is_present)

Output:

True

By calling my_list.__contains__(element), we obtain the same result as using the in operator. However, this syntax is not commonly used and is less readable.

Summary/Discussion

  • Method 1: Using in. Most Pythonic and readable. Suitable for most cases. It is recommended for its simplicity and efficiency.
  • Method 2: Using count(). Simple but inefficient for just checking presence because it counts all matches instead of stopping at the first. Best used when you need the count of occurrences.
  • Method 3: Using any() with a generator expression. Efficient and stops at the first truthy value. It is less readable than the in operator but more suitable for complex conditions.
  • Method 4: Using next() with a generator expression. Provides a way to handle both presence and absence without an error. Offers fine control but may be less intuitive than simpler methods.
  • Bonus Method 5: Using __contains__(). Illustrates how in works internally. Not recommended for general use due to readability concerns.