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. Tested on Travis CI.

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') as vcr:
            resp = self.session.get(
            assert resp.json()['owner'] != {}

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.


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.1.5.tar.gz (11.1 kB view hashes)

Uploaded Source

Built Distribution

betamax-0.1.5-py27-none-any.whl (15.4 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