Sentry Answers>Python>

Test whether a string contains a substring in Python

Test whether a string contains a substring in Python

David Y.

The Problem

How can we test whether a string contains a given substring in Python? Do Python strings have a contains() method?

The Solution

The pythonic way to determine whether a string contains a substring is by using the in operator:

Click to Copy
if "word" in "This string contains word.": print("Found 'word' in string!")

Under the hood, this operator will use the str class’s __contains__() method. Therefore, we could also write this code in the following way and get the same result:

Click to Copy
if "This string contains word.".__contains__("word"): print("Found 'word' in string!")

However, this is unpythonic, as methods starting with underscores are considered private. Calling them externally should be avoided where possible, even though Python does not prevent you from doing so.

This operation will return a boolean value, indicating whether the substring was found somewhere in the string. startswith() and endswith() can be used to test whether it was found at the beginning or end. To return the exact position of the substring, use find() or index().

  • Sentry BlogPython Performance Testing: A Comprehensive Guide
  • Syntax.fmListen to the Syntax Podcast
  • Sentry BlogLogging in Python: A Developer’s Guide
  • CodecovPython - Codecov
  • Syntax.fm logo
    Listen to the Syntax Podcast

    Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.

    SEE EPISODES

Considered “not bad” by 4 million developers and more than 100,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

© 2024 • Sentry is a registered Trademark of Functional Software, Inc.