Record modes¶

The record mode controls what happens when a request is made under an active cassette.

none¶

Use it in CI and for day to day test runs. Nothing touches the network. If a request has no matching interaction in the cassette, the test fails with NoMatchError.

with use_cassette("cassette.yaml", record_mode="none"):
    ...

once¶

Use it while developing. The first run records, every run after that replays.

with use_cassette("cassette.yaml", record_mode="once"):
    ...

This is the default for use_cassette().

new_episodes¶

Use it when you add new requests to an existing test. Matched requests replay from the cassette, unmatched requests go to the real server and get appended.

with use_cassette("cassette.yaml", record_mode="new_episodes"):
    ...

all¶

Use it to re-record a cassette from scratch, for example after an API change.

with use_cassette("cassette.yaml", record_mode="all"):
    ...

Set the mode from the command line¶

With the pytest plugin, --record-mode overrides whatever the tests configure:

$ pytest --record-mode=once

A common workflow:

• Locally, record new cassettes with pytest --record-mode=once.
• In CI, run plain pytest. The plugin default is none, so CI never makes real requests.