Skip to main content

A VCR imitation for python-requests

Project description


Betamax is a VCR imitation for requests. This will make mocking out requests much easier. It is tested on Travis CI.

Put in a more humorous way: “Betamax records your HTTP interactions so the NSA does not have to.”

Example Use

from betamax import Betamax
from requests import Session
from unittest import TestCase

with Betamax.configure() as config:
    config.cassette_library_dir = 'tests/fixtures/cassettes'

class TestGitHubAPI(TestCase):
    def setUp(self):
        self.session = Session()

    # Set the cassette in a line other than the context declaration
    def test_user(self):
        with Betamax(self.session) as vcr:
            resp = self.session.get('',
                                    auth=('user', 'pass'))
            assert resp.json()['login'] is not None

    # Set the cassette in line with the context declaration
    def test_repo(self):
        with Betamax(self.session).use_cassette('repo'):
            resp = self.session.get(
            assert resp.json()['owner'] != {}

What does it even do?

If you are unfamiliar with VCR, you might need a better explanation of what Betamax does.

Betamax intercepts every request you make and attempts to find a matching request that has already been intercepted and recorded. Two things can then happen:

  1. If there is a matching request, it will return the response that is associated with it.

  2. If there is not a matching request and it is allowed to record new responses, it will make the request, record the response and return the response.

Recorded requests and corresponding responses - also known as interactions - are stored in files called cassettes. (An example cassette can be seen in the examples section of the documentation.) The directory you store your cassettes in is called your library, or your cassette library.

VCR Cassette Compatiblity

Betamax can use any VCR-recorded cassette as of this point in time. The only caveat is that python-requests returns a URL on each response. VCR does not store that in a cassette now but we will. Any VCR-recorded cassette used to playback a response will unfortunately not have a URL attribute on responses that are returned. This is a minor annoyance but not something that can be fixed.


You can check out the project board on to see what the status of each issue is.


0.3.1 - 2014-05-28

  • Fix GitHub Issue #35 - Placeholders were not being properly applied to request bodies. This release fixes that so placeholders are now behave as expected with recorded request bodies.

0.3.0 - 2014-05-23

  • Add Betamax#start and Betamax#stop to allow users to start recording and stop without using a context-manager.

  • Add digest-auth matcher to help users match the right request when using requests’ HTTPDigestAuth.

  • Reorganize and refactor the cassettes, matchers, and serializers modules.

  • Refactor some portions of code a bit.

  • Cassette.cassette_name no longer is the relative path to the file in which the cassette is saved. To access that information use Cassette.cassette_path. The cassette_name attribute is now the name that you pass to Betamax#use_cassette.

0.2.0 - 2014-04-12

  • Fix bug where new interactions recorded under new_episodes or all were not actually saved to disk.

  • Match URIs in a far more intelligent way.

  • Use the Session’s original adapters when making new requests

    In the event the Session has a custom adapter mounted, e.g., the SSLAdapter in requests-toolbelt, then we should probably use that.

  • Add on_init hook to BaseMatcher so matcher authors can customize initialization

  • Add support for custom Serialization formats. See the docs for more info.

  • Add support for preserving exact body bytes.

  • Deprecate serialize keyword to Betamax#use_cassette in preference for serialize_with (to be more similar to VCR).

0.1.6 - 2013-12-07

  • Fix how global settings and per-invocation options are persisted and honored. (#10)

  • Support match_requests_on as a parameter sent to Betamax#use_cassette. (No issue)

0.1.5 - 2013-09-27

  • Make sure what we pass to base64.b64decode is a bytes object

0.1.4 - 2013-09-27

  • Do not try to sanitize something that may not exist.

0.1.3 - 2013-09-27

  • Fix issue when response has a Content-Encoding of gzip and we need to preserve the original bytes of the message.

0.1.2 - 2013-09-21

  • Fix issues with how requests parses cookies out of responses

  • Fix unicode issues with Response#text (trying to use Response#json raises exception because it cannot use string decoding on a unicode string)

0.1.1 - 2013-09-19

  • Fix issue where there is a unicode character not in range(128)

0.1.0 - 2013-09-17

  • Initial Release

  • Support for VCR generated cassettes (JSON only)

  • Support for re_record_interval

  • Support for the once, all, new_episodes, all cassette modes

  • Support for filtering sensitive data

  • Support for the following methods of request matching:

    • Method

    • URI

    • Host

    • Path

    • Query String

    • Body

    • Headers

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

betamax-0.3.1.tar.gz (18.9 kB view hashes)

Uploaded Source

Built Distribution

betamax-0.3.1-py27-none-any.whl (36.7 kB view hashes)

Uploaded Python 2.7

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page