Blog ยป Python ยป Python Assert Statement, How to Test a Condition

Python Assert Statement, How to Test a Condition

By Lane Wagner on December 13, 2021

Curated backend podcasts, videos and articles. All free.

Want to improve your backend development skills? Subscribe to get a copy of The Beat in your inbox each month. It's a newsletter packed with the best content for new backend devs.

In Python, an assertion is a statement that confirms something about the state of your program. For example, if you write a createUser function and you are sure that the user needs to be older than 18, you assert that the age field is greater than or equal to 18. You can think of an assert statement like a unit test that is performed at runtime.

def createUser(user):
  assert user.age >= 18

tl;dr ๐Ÿ”—

  • Assertions are simply boolean expressions that raise exceptions if their condition is False
  • The assert statement is the built-in syntax for assertions in Python
  • Developers often use assert to do type checking, and input/output validation for function signatures
  • The assert statement is used for debugging purposes

Anatomy of an assert statement in Python ๐Ÿ”—

Python has a built-in assert statement, and its syntax is as follows.

assert condition [, error_message]

If the {condition} is false, an AssertionError is raised. If the optional second parameter, error_message was set, then that error message is used.

Catching an assertion error ๐Ÿ”—

You can catch an assertion error just like you would any other error in Python.

age = 17
    assert age >= 18, "too young!"
except Exception as e:
# prints: "too young!"

Don’t use the assert statement in production ๐Ÿ”—

The assert statement is a fantastic tool for debugging code and writing tests. You should probably not use an assert statement in a production environment. You should be checking your code for unexpected behavior before you deploy it.

Don’t use parenthesis for the assert parameters ๐Ÿ”—

Do not use parentheses to call assert as if it were a normal function. Asser is a statement, not a function. When you call assert(condition,message), you execute the assert statement with a tuple (condition,message) as the condition, and no actual message.

Find a problem with this article?

Report an issue on GitHub