How to catch a `revert()` error using Brownie?

Question

I am using Brownie to develop my smart contracts, which helps me to intract with the smart contracts, please see doc.

When my call Example.greet() is there any way to return the error message and act based on it during my tests? Also find out is it reverted because the transaction is out of gas or not.

Similar question is answered for Truffle: [how to catch “revert” error in truffle test javascript?].

---

Example of a simple contract with a revert() message:

contract Example{
    function greet(){
        revert("Hello World");        
    }
}

Answer 1

The brownie.reverts context manager handles exactly this use case. The syntax is very similar to pytest.raises:

import brownie

def test_greet(example):
    with brownie.reverts("Hello World"):
         example.greet()

Including the error string is optional, if you omit it you can catch any revert regardless of the message returned.

• Source: Brownie documentation - Handling Reverted Transactions