Release v6.0.0

fix tornado related warnings by replacing pytest-tornado with a simple coroutine runner

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab
+
+[*.{yml,yaml}]
+indent_size = 2

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Validate docs
+
+on:
+  push:
+    paths:
+      - 'docs/**'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Rendering HTML documentation
+        run: sphinx-build -b html docs/ html
+      - name: Inspect html rendered
+        run: cat html/index.html

.github/workflows/main.yml

@@ -5,36 +5,64 @@ on:
     branches:
       - master
   pull_request:
-    branches:
-      - "*"
+  workflow_dispatch:
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "pypy-3.8"]
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "pypy-3.8"
+          - "pypy-3.9"
+          - "pypy-3.10"
+        urllib3-requirement:
+          - "urllib3>=2"
+          - "urllib3<2"
+
+        exclude:
+          - python-version: "3.8"
+            urllib3-requirement: "urllib3>=2"
+          - python-version: "pypy-3.8"
+            urllib3-requirement: "urllib3>=2"
+          - python-version: "3.9"
+            urllib3-requirement: "urllib3>=2"
+          - python-version: "pypy-3.9"
+            urllib3-requirement: "urllib3>=2"
+          - python-version: "pypy-3.10"
+            urllib3-requirement: "urllib3>=2"
 
     steps:
-      - name: Install libgnutls28-dev
-        run: |
-          sudo apt update -q
-          sudo apt install -q -y libgnutls28-dev libcurl4-gnutls-dev
-
-      - uses: actions/checkout@v3.0.2
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          cache: pip
 
       - name: Install project dependencies
         run: |
           pip install --upgrade pip
-          pip install codecov tox tox-gh-actions
+          pip install codecov '.[tests]' '${{ matrix.urllib3-requirement }}'
+          pip check
 
-      - name: Run tests with tox
-        run: tox
+      - name: Run online tests
+        run: ./runtests.sh --cov=./vcr --cov-branch --cov-report=xml --cov-append -m online
+
+      - name: Run offline tests with no access to the Internet
+        run: |
+          # We're using unshare to take Internet access
+          # away so that we'll notice whenever some new test
+          # is missing @pytest.mark.online decoration in the future
+          unshare --map-root-user --net -- \
+              sh -c 'ip link set lo up; ./runtests.sh --cov=./vcr --cov-branch --cov-report=xml --cov-append -m "not online"'
 
       - name: Run coverage
         run: codecov

.github/workflows/pre-commit-detect-outdated.yml

@@ -0,0 +1,62 @@
+# Copyright (c) 2023 Sebastian Pipping <sebastian@pipping.org>
+# Licensed under the MIT license
+
+name: Detect outdated pre-commit hooks
+
+on:
+  schedule:
+    - cron: '0 16 * * 5'  # Every Friday 4pm
+
+# NOTE: This will drop all permissions from GITHUB_TOKEN except metadata read,
+#       and then (re)add the ones listed below:
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  pre_commit_detect_outdated:
+    name: Detect outdated pre-commit hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Install pre-commit
+        run: |-
+          pip install \
+            --disable-pip-version-check \
+            --no-warn-script-location \
+            --user \
+            pre-commit
+          echo "PATH=${HOME}/.local/bin:${PATH}" >> "${GITHUB_ENV}"
+
+      - name: Check for outdated hooks
+        run: |-
+          pre-commit autoupdate
+          git diff -- .pre-commit-config.yaml
+
+      - name: Create pull request from changes (if any)
+        id: create-pull-request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          author: 'pre-commit <pre-commit@tools.invalid>'
+          base: master
+          body: |-
+            For your consideration.
+
+            :warning: Please **CLOSE AND RE-OPEN** this pull request so that [further workflow runs get triggered](https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs) for this pull request.
+          branch: precommit-autoupdate
+          commit-message: "pre-commit: Autoupdate"
+          delete-branch: true
+          draft: true
+          labels: enhancement
+          title: "pre-commit: Autoupdate"
+
+      - name: Log pull request URL
+        if: "${{ steps.create-pull-request.outputs.pull-request-url }}"
+        run: |
+          echo "Pull request URL is: ${{ steps.create-pull-request.outputs.pull-request-url }}"

.github/workflows/pre-commit.yml

@@ -0,0 +1,20 @@
+# Copyright (c) 2023 Sebastian Pipping <sebastian@pipping.org>
+# Licensed under the MIT license
+
+name: Run pre-commit
+
+on:
+- pull_request
+- push
+- workflow_dispatch
+
+jobs:
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+    - uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# Copyright (c) 2023 Sebastian Pipping <sebastian@pipping.org>
+# Licensed under the MIT license
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.13
+    hooks:
+      - id: ruff
+        args: ["--show-source"]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
+  - method: pip
+    path: .

MANIFEST.in

@@ -1,6 +1,5 @@
 include README.rst
 include LICENSE.txt
-include tox.ini
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

README.rst

@@ -4,7 +4,7 @@ VCR.py 📼
 ###########
 
 
-|PyPI| |Python versions| |Build Status| |CodeCov| |Gitter| |CodeStyleBlack|
+|PyPI| |Python versions| |Build Status| |CodeCov| |Gitter|
 
 ----
 
@@ -70,6 +70,3 @@ more details
 .. |CodeCov| image:: https://codecov.io/gh/kevin1024/vcrpy/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/kevin1024/vcrpy
    :alt: Code Coverage Status
-.. |CodeStyleBlack| image:: https://img.shields.io/badge/code%20style-black-000000.svg 
-   :target: https://github.com/psf/black
-   :alt: Code Style: black

docs/_static/vcr.svg

@@ -24,4 +24,4 @@
       <stop offset="1" stop-color="#27DDA6"/>
     </linearGradient>
   </defs>
-</svg>
+</svg>

docs/advanced.rst

@@ -16,7 +16,7 @@ a nice addition. Here's an example:
     with vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml') as cass:
         response = urllib2.urlopen('http://www.zombo.com/').read()
         # cass should have 1 request inside it
-        assert len(cass) == 1 
+        assert len(cass) == 1
         # the request uri should have been http://www.zombo.com/
         assert cass.requests[0].uri == 'http://www.zombo.com/'
 
@@ -71,7 +71,7 @@ Finally, register your class with VCR to use your new serializer.
 
     import vcr
 
-    class BogoSerializer(object):
+    class BogoSerializer:
         """
         Must implement serialize() and deserialize() methods
         """
@@ -136,7 +136,8 @@ Create your own persistence class, see the example below:
 
 Your custom persister must implement both ``load_cassette`` and ``save_cassette``
 methods.  The ``load_cassette`` method must return a deserialized cassette or raise
-``ValueError`` if no cassette is found.
+either ``CassetteNotFoundError`` if no cassette is found, or ``CassetteDecodeError``
+if the cassette cannot be successfully deserialized.
 
 Once the persister class is defined, register with VCR like so...
 
@@ -188,7 +189,7 @@ of post data parameters to filter.
 
 .. code:: python
 
-    with my_vcr.use_cassette('test.yml', filter_post_data_parameters=['client_secret']):
+    with my_vcr.use_cassette('test.yml', filter_post_data_parameters=['api_key']):
         requests.post('http://api.com/postdata', data={'api_key': 'secretstring'})
 
 Advanced use of filter_headers, filter_query_parameters and filter_post_data_parameters
@@ -207,7 +208,7 @@ So these two calls are the same:
 
     # original (still works)
     vcr = VCR(filter_headers=['authorization'])
-    
+
     # new
     vcr = VCR(filter_headers=[('authorization', None)])
 
@@ -217,7 +218,7 @@ Here are two examples of the new functionality:
 
     # replace with a static value (most common)
     vcr = VCR(filter_headers=[('authorization', 'XXXXXX')])
-    
+
     # replace with a callable, for example when testing
     # lots of different kinds of authorization.
     def replace_auth(key, value, request):
@@ -285,7 +286,7 @@ sensitive data from the response body:
         before_record_response=scrub_string(settings.USERNAME, 'username'),
     )
     with my_vcr.use_cassette('test.yml'):
-         # your http code here    
+         # your http code here
 
 
 Decode compressed response
@@ -404,3 +405,25 @@ the Cassette ``allow_playback_repeats`` option.
         for x in range(10):
             response = urllib2.urlopen('http://www.zombo.com/').read()
         assert cass.all_played
+
+Discards Cassette on Errors
+---------------------------
+
+By default VCR will save the cassette file even when there is any error inside
+the enclosing context/test.
+
+If you want to save the cassette only when the test succeeds, set the Cassette
+``record_on_exception`` option to ``False``.
+
+.. code:: python
+
+    try:
+        my_vcr = VCR(record_on_exception=False)
+        with my_vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml') as cass:
+            response = urllib2.urlopen('http://www.zombo.com/').read()
+            raise RuntimeError("Oops, something happened")
+    except RuntimeError:
+        pass
+
+    # Since there was an exception, the cassette file hasn't been created.
+    assert not os.path.exists('fixtures/vcr_cassettes/synopsis.yaml')

docs/changelog.rst

@@ -7,6 +7,57 @@ For a full list of triaged issues, bugs and PRs and what release they are target
 
 All help in providing PRs to close out bug issues is appreciated. Even if that is providing a repo that fully replicates issues. We have very generous contributors that have added these to bug issues which meant another contributor picked up the bug and closed it out.
 
+-  6.0.0
+    - BREAKING: Fix issue with httpx support (thanks @parkerhancock) in #784. NOTE: You may have to recreate some of your cassettes produced in previous releases due to the binary format being saved incorrectly in previous releases
+    - BREAKING: Drop support for `boto` (vcrpy still supports boto3, but is dropping the deprecated `boto` support in this release. (thanks @jairhenrique)
+    - Fix compatibility issue with Python 3.12 (thanks @hartwork)
+    - Drop simplejson (fixes some compatibility issues) (thanks @jairhenrique)
+    - Run CI on Python 3.12 and PyPy 3.9-3.10 (thanks @mgorny)
+    - Various linting and docs improvements (thanks @jairhenrique)
+    - Tornado fixes (thanks @graingert)
+-  5.1.0
+    - Use ruff for linting (instead of current flake8/isort/pyflakes) - thanks @jairhenrique
+    - Enable rule B (flake8-bugbear) on ruff - thanks @jairhenrique
+    - Configure read the docs V2 - thanks @jairhenrique
+    - Fix typo in docs - thanks @quasimik
+    - Make json.loads of Python >=3.6 decode bytes by itself - thanks @hartwork
+    - Fix body matcher for chunked requests (fixes #734) - thanks @hartwork
+    - Fix query param filter for aiohttp (fixes #517) - thanks @hartwork and @salomvary
+    - Remove unnecessary dependency on six. - thanks @charettes
+    - build(deps): update sphinx requirement from <7 to <8 - thanks @jairhenrique
+    - Add action to validate docs - thanks @jairhenrique
+    - Add editorconfig file - thanks @jairhenrique
+    - Drop iscoroutinefunction fallback function for unsupported python thanks @jairhenrique
+-  5.0.0
+    - BREAKING CHANGE: Drop support for Python 3.7.  3.7 is EOL as of 6/27/23 Thanks @jairhenrique
+    - BREAKING CHANGE: Custom Cassette persisters no longer catch ValueError.  If you have implemented a custom persister (has anyone implemented a custom persister?  Let us know!) then you will need to throw a CassetteNotFoundError when unable to find a cassette.  See #681 for discussion and reason for this change. Thanks @amosjyng for the PR and the review from @hartwork
+
+-  4.4.0
+    - HUGE thanks to @hartwork for all the work done on this release!
+    - Bring vcr/unittest in to vcrpy as a full feature of vcr instead of a separate library.  Big thanks to @hartwork for doing this and to @agriffis for originally creating the library
+    - Make decompression robust towards already decompressed input (thanks @hartwork)
+    - Bugfix: Add read1 method (fixes compatibility with biopython), thanks @mghantous
+    - Bugfix: Prevent filters from corrupting request (thanks @abramclark)
+    - Bugfix: Add support for `response.raw.stream()` to fix urllib v2 compat
+    - Bugfix: Replace `assert` with `raise AssertionError`: fixes support for `PYTHONOPTIMIZE=1`
+    - Add pytest.mark.online to run test suite offline, thanks @jspricke
+    - use python3 and pip3 binaries to ease debian packaging (thanks @hartwork)
+    - Add codespell (thanks @mghantous)
+-  4.3.1
+    - Support urllib3 v1 and v2.  NOTE: there is an issue running urllib3 v2 on
+      Python older than 3.10, so this is currently blocked in the requirements.
+      Hopefully we can resolve this situation in the future.  Thanks to @shifqu,
+      hartwork, jairhenrique, pquentin, and vEpiphyte for your work on this.
+-  4.3.0
+    - Add support for Python 3.11 (Thanks @evgeni)
+    - Drop support for botocore <1.11.0 and requests <2.16.2 (thanks @hartwork)
+    - Bugfix: decode_compressed_response raises exception on empty responses. Thanks @CharString
+    - Don't save requests from decorated tests if decorated test fails (thanks @dan-passaro)
+    - Fix not calling all the exit stack when record_on_exception is False (thanks @Terseus)
+    - Various CI, documentation, testing, and formatting improvements (Thanks @jairhenrique, @dan-passaro, @hartwork, and Terseus)
+-  4.2.1
+    - Fix a bug where the first request in a redirect chain was not being recorded with aiohttp
+    - Various typos and small fixes, thanks @jairhenrique, @timgates42
 -  4.2.0
     - Drop support for python < 3.7, thanks @jairhenrique, @IvanMalison, @AthulMuralidhar
     - Various aiohtt bigfixes (thanks @pauloromeira and boechat107)
@@ -28,8 +79,8 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Bugfix: Fix test suite by switching to mockbin (thanks @jairhenrique)
 -  4.0.2
     - Fix mock imports as reported in #504 by @llybin. Thank you.
--  4.0.1 
-    - Fix logo alignment for PyPI 
+-  4.0.1
+    - Fix logo alignment for PyPI
 -  4.0.0
     - Remove Python2 support (@hugovk)
     - Add Python 3.8 TravisCI support (@neozenith)
@@ -41,7 +92,7 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Add support for `request_info` on mocked responses in aiohttp stub #495 (@nickdirienzo)
     - doc: fixed variable name (a -> cass) in an example for rewind #492 (@yarikoptic)
 
--  2.1.1 
+-  2.1.1
     - Format code with black (@neozenith)
     - Use latest pypy3 in Travis (@hugovk)
     - Improve documentation about custom matchers (@gward)
@@ -49,7 +100,7 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Add `pytest-recording` to the documentation as an alternative Pytest plugin (@Stranger6667)
     - Fix yarl and python3.5 version issue (@neozenith)
     - Fix header matcher for boto3 - fixes #474 (@simahawk)
--  2.1.0 
+-  2.1.0
     - Add a `rewind` method to reset a cassette (thanks @khamidou)
     - New error message with more details on why the cassette failed to play a request (thanks @arthurHamon2, @neozenith)
     - Handle connect tunnel URI (thanks @jeking3)
@@ -61,9 +112,9 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Fix bugs on aiohttp integration (thanks @graingert, @steinnes, @stj, @lamenezes, @lmazuel)
     - Fix Biopython incompatibility (thanks @rishab121)
     - Fix Boto3 integration (thanks @1oglop1, @arthurHamon2)
--  2.0.1 
+-  2.0.1
     - Fix bug when using vcrpy with python 3.4
--  2.0.0 
+-  2.0.0
     - Support python 3.7 (fix httplib2 and urllib2, thanks @felixonmars)
     - [#356] Fixes `before_record_response` so the original response isn't changed (thanks @kgraves)
     - Fix requests stub when using proxy (thanks @samuelfekete @daneoshiga)
@@ -73,56 +124,56 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Improve docs (thanks @adamchainz)
 
 
--  1.13.0 
+-  1.13.0
     - Fix support to latest aiohttp version (3.3.2). Fix content-type bug in aiohttp stub. Save URL with query params properly when using aiohttp.
--  1.12.0 
+-  1.12.0
     - Fix support to latest aiohttp version (3.2.1), Adapted setup to PEP508, Support binary responses on aiohttp, Dropped support for EOL python versions (2.6 and 3.3)
--  1.11.1 
+-  1.11.1
     - Fix compatibility with newest requests and urllib3 releases
--  1.11.0 
+-  1.11.0
     - Allow injection of persistence methods + bugfixes (thanks @j-funk and @IvanMalison),
     - Support python 3.6 + CI tests (thanks @derekbekoe and @graingert),
     - Support pytest-asyncio coroutines (thanks @graingert)
--  1.10.5 
+-  1.10.5
     - Added a fix to httplib2 (thanks @carlosds730), Fix an issue with
     - aiohttp (thanks @madninja), Add missing requirement yarl (thanks @lamenezes),
     - Remove duplicate mock triple (thanks @FooBarQuaxx)
--  1.10.4 
+-  1.10.4
     - Fix an issue with asyncio aiohttp (thanks @madninja)
--  1.10.3 
+-  1.10.3
     - Fix some issues with asyncio and params (thanks @anovikov1984 and @lamenezes)
     - Fix some issues with cassette serialize / deserialize and empty response bodies (thanks @gRoussac and @dz0ny)
--  1.10.2 
+-  1.10.2
     - Fix 1.10.1 release - add aiohttp support back in
--  1.10.1 
+-  1.10.1
     - [bad release] Fix build for Fedora package + python2 (thanks @puiterwijk and @lamenezes)
--  1.10.0 
+-  1.10.0
     - Add support for aiohttp (thanks @lamenezes)
--  1.9.0 
-    - Add support for boto3 (thanks @desdm, @foorbarna). 
+-  1.9.0
+    - Add support for boto3 (thanks @desdm, @foorbarna).
     - Fix deepcopy issue for response headers when `decode_compressed_response` is enabled (thanks @nickdirienzo)
--  1.8.0 
-    - Fix for Serialization errors with JSON adapter (thanks @aliaksandrb). 
-    - Avoid concatenating bytes with strings (thanks @jaysonsantos). 
-    - Exclude __pycache__ dirs & compiled files in sdist (thanks @koobs). 
-    - Fix Tornado support behavior for Tornado 3 (thanks @abhinav). 
+-  1.8.0
+    - Fix for Serialization errors with JSON adapter (thanks @aliaksandrb).
+    - Avoid concatenating bytes with strings (thanks @jaysonsantos).
+    - Exclude __pycache__ dirs & compiled files in sdist (thanks @koobs).
+    - Fix Tornado support behavior for Tornado 3 (thanks @abhinav).
     - decode_compressed_response option and filter (thanks @jayvdb).
--  1.7.4 [#217] 
-    - Make use_cassette decorated functions actually return a value (thanks @bcen). 
+-  1.7.4 [#217]
+    - Make use_cassette decorated functions actually return a value (thanks @bcen).
     - [#199] Fix path transformation defaults.
     - Better headers dictionary management.
--  1.7.3 [#188] 
+-  1.7.3 [#188]
     - ``additional_matchers`` kwarg on ``use_cassette``.
     - [#191] Actually support passing multiple before_record_request functions (thanks @agriffis).
--  1.7.2 
+-  1.7.2
     - [#186] Get effective_url in tornado (thanks @mvschaik)
     - [#187] Set request_time on Response object in tornado (thanks @abhinav).
--  1.7.1 
+-  1.7.1
     - [#183] Patch ``fetch_impl`` instead of the entire HTTPClient class for Tornado (thanks @abhinav).
--  1.7.0 
-    - [#177] Properly support coroutine/generator decoration. 
+-  1.7.0
+    - [#177] Properly support coroutine/generator decoration.
     - [#178] Support distribute (thanks @graingert). [#163] Make compatibility between python2 and python3 recorded cassettes more robust (thanks @gward).
--  1.6.1 
+-  1.6.1
     - [#169] Support conditional requirements in old versions of pip
     - Fix RST parse errors generated by pandoc
     - [Tornado] Fix unsupported features exception not being raised
@@ -136,17 +187,17 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Fix crash when cassette path contains cassette library directory (thanks @gazpachoking).
 -  1.5.0
     - Automatic cassette naming and 'application/json' post data filtering (thanks @marco-santamaria).
--  1.4.2 
+-  1.4.2
     - Fix a bug caused by requests 2.7 and chunked transfer encoding
--  1.4.1 
+-  1.4.1
     - Include README, tests, LICENSE in package. Thanks @ralphbean.
--  1.4.0 
+-  1.4.0
     - Filter post data parameters (thanks @eadmundo)
     - Support for posting files through requests, inject\_cassette kwarg to access cassette from ``use_cassette`` decorated function, ``with_current_defaults`` actually works (thanks @samstav).
 -  1.3.0
     - Fix/add support for urllib3 (thanks @aisch)
     - Fix default port  for https (thanks @abhinav).
--  1.2.0 
+-  1.2.0
     - Add custom\_patches argument to VCR/Cassette objects to allow users to stub custom classes when cassettes become active.
 -  1.1.4
     - Add force reset around calls to actual connection from stubs, to ensure compatibility with the version of httplib/urlib2 in python 2.7.9.
@@ -157,22 +208,22 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - fix Windows connectionpool stub bug (thanks @gazpachoking)
     - add support for requests 2.5
 -  1.1.2
-    - Add urllib==1.7.1 support. 
+    - Add urllib==1.7.1 support.
     - Make json serialize error handling correct
     - Improve logging of match failures.
--  1.1.1 
-    - Use function signature preserving ``wrapt.decorator`` to write the decorator version of use\_cassette in order to ensure compatibility with py.test fixtures and python 2. 
+-  1.1.1
+    - Use function signature preserving ``wrapt.decorator`` to write the decorator version of use\_cassette in order to ensure compatibility with py.test fixtures and python 2.
     - Move all request filtering into the ``before_record_callable``.
--  1.1.0 
+-  1.1.0
     - Add ``before_record_response``. Fix several bugs related to the context management of cassettes.
--  1.0.3 
+-  1.0.3
     - Fix an issue with requests 2.4 and make sure case sensitivity is consistent across python versions
 -  1.0.2
     - Fix an issue with requests 2.3
 -  1.0.1
     - Fix a bug with the new ignore requests feature and the once record mode
--  1.0.0 
-    - *BACKWARDS INCOMPATIBLE*: Please see the 'upgrade' section in the README. Take a look at the matcher section as well, you might want to update your ``match_on`` settings. 
+-  1.0.0
+    - *BACKWARDS INCOMPATIBLE*: Please see the 'upgrade' section in the README. Take a look at the matcher section as well, you might want to update your ``match_on`` settings.
     - Add support for filtering sensitive data from requests, matching query strings after the order changes and improving the built-in matchers, (thanks to @mshytikov)
     - Support for ignoring requests to certain hosts, bump supported Python3 version to 3.4, fix some bugs with Boto support (thanks @marusich)
     - Fix error with URL field capitalization in README (thanks @simon-weber)
@@ -180,27 +231,27 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Added ``all_played`` property on cassette (thanks @mshytikov)
 
 -  0.7.0
-    - VCR.py now supports Python 3! (thanks @asundg) 
+    - VCR.py now supports Python 3! (thanks @asundg)
     - Also I refactored the stub connections quite a bit to add support for the putrequest and putheader calls.
-    - This version also adds support for httplib2 (thanks @nilp0inter). 
+    - This version also adds support for httplib2 (thanks @nilp0inter).
     - I have added a couple tests for boto since it is an http client in its own right.
     - Finally, this version includes a fix for a bug where requests wasn't being patched properly (thanks @msabramo).
 -  0.6.0
     - Store response headers as a list since a HTTP response can have the same header twice (happens with set-cookie sometimes).
-        - This has the added benefit of preserving the order of headers. 
-        - Thanks @smallcode for the bug report leading to this change. 
+        - This has the added benefit of preserving the order of headers.
+        - Thanks @smallcode for the bug report leading to this change.
     - I have made an effort to ensure backwards compatibility with the old cassettes' header storage mechanism, but if you want to upgrade to the new header storage, you should delete your cassettes and re-record them.
-    - Also this release adds better error messages (thanks @msabramo) 
+    - Also this release adds better error messages (thanks @msabramo)
     - and adds support for using VCR as a decorator (thanks @smallcode for the motivation)
 -  0.5.0
-    - Change the ``response_of`` method to ``responses_of`` since cassettes can now contain more than one response for a request. 
-        - Since this changes the API, I'm bumping the version. 
-    - Also includes 2 bugfixes: 
-        - a better error message when attempting to overwrite a cassette file, 
+    - Change the ``response_of`` method to ``responses_of`` since cassettes can now contain more than one response for a request.
+        - Since this changes the API, I'm bumping the version.
+    - Also includes 2 bugfixes:
+        - a better error message when attempting to overwrite a cassette file,
         - and a fix for a bug with requests sessions (thanks @msabramo)
 -  0.4.0
     - Change default request recording behavior for multiple requests.
-        - If you make the same request multiple times to the same URL, the response might be different each time (maybe the response has a timestamp in it or something), so this will make the same request multiple times and save them all. 
+        - If you make the same request multiple times to the same URL, the response might be different each time (maybe the response has a timestamp in it or something), so this will make the same request multiple times and save them all.
         - Then, when you are replaying the cassette, the responses will be played back in the same order in which they were received.
         - If you were making multiple requests to the same URL in a cassette before version 0.4.0, you might need to regenerate your cassette files.
         - Also, removes support for the cassette.play\_count counter API, since individual requests aren't unique anymore.
@@ -220,7 +271,7 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
 -  0.3.0
     - *Backwards incompatible release*
     - Added support for record modes, and changed the default recording behavior to the "once" record mode. Please see the documentation on record modes for more.
-    - Added support for custom request matching, and changed the default request matching behavior to match only on the URL and method. 
+    - Added support for custom request matching, and changed the default request matching behavior to match only on the URL and method.
     - Also, improved the httplib mocking to add support for the ``HTTPConnection.send()`` method.
         - This means that requests won't actually be sent until the response is read, since I need to record the entire request in order to match up the appropriate response.
         - I don't think this should cause any issues unless you are sending requests without ever loading the response (which none of the standard httplib wrappers do, as far as I know).
@@ -228,13 +279,13 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
 -  0.2.1
     - Fixed missing modules in setup.py
 -  0.2.0
-    - Added configuration API, which lets you configure some settings on VCR (see the README). 
+    - Added configuration API, which lets you configure some settings on VCR (see the README).
     - Also, VCR no longer saves cassettes if they haven't changed at all and supports JSON as well as YAML (thanks @sirpengi).
     - Added amazing new skeumorphic logo, thanks @hairarrow.
 -  0.1.0
     - *backwards incompatible release - delete your old cassette files*
     - This release adds the ability to access the cassette to make assertions on it
-    - as well as a major code refactor thanks to @dlecocq. 
+    - as well as a major code refactor thanks to @dlecocq.
     - It also fixes a couple longstanding bugs with redirects and HTTPS. [#3 and #4]
 -  0.0.4
     - If you have libyaml installed, vcrpy will use the c bindings instead. Speed up your tests! Thanks @dlecocq
@@ -244,4 +295,3 @@ All help in providing PRs to close out bug issues is appreciated. Even if that i
     - Add support for requests / urllib3
 -  0.0.1
     - Initial Release
-

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # vcrpy documentation build configuration file, created by
 # sphinx-quickstart on Sun Sep 13 11:18:00 2015.
@@ -94,7 +93,7 @@ version = release = find_version("..", "vcr", "__init__.py")
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

docs/configuration.rst

@@ -42,7 +42,8 @@ This can be configured by changing the ``match_on`` setting.
 The following options are available :
 
 -  method (for example, POST or GET)
--  uri (the full URI.)
+-  uri (the full URI)
+-  scheme (for example, HTTP or HTTPS)
 -  host (the hostname of the server receiving the request)
 -  port (the port of the server receiving the request)
 -  path (the path of the request)

docs/contributing.rst

@@ -24,7 +24,7 @@ So whilst reporting issues are valuable, please consider:
  - contributing an issue with a toy repo that replicates the issue.
  - contributing PRs is a more valuable donation of your time and effort.
 
-Thanks again for your interest and support in VCRpy. 
+Thanks again for your interest and support in VCRpy.
 
 We really appreciate it.
 
@@ -57,7 +57,7 @@ Simply adding these three labels for incoming issues means a lot for maintaining
  - Which library does it affect? ``core``, ``aiohttp``, ``requests``, ``urllib3``, ``tornado4``, ``httplib2``
  - If it is a bug, is it ``Verified Can Replicate`` or ``Requires Help Replicating``
  - Thanking people for raising issues. Feedback is always appreciated.
- - Politely asking if they are able to link to an example repo that replicates the issue if they haven't already. Being able to *clone and go* helps the next person and we like that. 😃 
+ - Politely asking if they are able to link to an example repo that replicates the issue if they haven't already. Being able to *clone and go* helps the next person and we like that. 😃
 
 **Maintainer:**
 
@@ -68,13 +68,13 @@ This involves creating PRs to address bugs and enhancement requests. It also mea
 The PR reviewer is a second set of eyes to see if:
  - Are there tests covering the code paths added/modified?
  - Do the tests and modifications make sense seem appropriate?
- - Add specific feedback, even on approvals, why it is accepted. eg "I like how you use a context manager there. 😄 " 
+ - Add specific feedback, even on approvals, why it is accepted. eg "I like how you use a context manager there. 😄 "
  - Also make sure they add a line to `docs/changelog.rst` to claim credit for their contribution.
 
 **Release Manager:**
  - Ensure CI is passing.
  - Create a release on github and tag it with the changelog release notes.
- - ``python setup.py build sdist bdist_wheel``
+ - ``python3 setup.py build sdist bdist_wheel``
  - ``twine upload dist/*``
  - Go to ReadTheDocs build page and trigger a build https://readthedocs.org/projects/vcrpy/builds/
 
@@ -83,39 +83,21 @@ The PR reviewer is a second set of eyes to see if:
 Running VCR's test suite
 ------------------------
 
-The tests are all run automatically on `Travis
-CI <https://travis-ci.org/kevin1024/vcrpy>`__, but you can also run them
-yourself using `pytest <http://pytest.org/>`__ and
-`Tox <http://tox.testrun.org/>`__. 
+The tests are all run automatically on `Github Actions CI <https://github.com/kevin1024/vcrpy/actions>`__,
+but you can also run them yourself using `pytest <http://pytest.org/>`__.
 
-Tox will automatically run them in all environments VCR.py supports if they are available on your `PATH`. Alternatively you can use `tox-pyenv <https://pypi.org/project/tox-pyenv/>`_ with 
-`pyenv <https://github.com/pyenv/pyenv>`_. 
-We recommend you read the documentation for each and see the section further below.
-
-The test suite is pretty big and slow, but you can tell tox to only run specific tests like this::
-
-    tox -e {pyNN}-{HTTP_LIBRARY} -- <pytest flags passed through>
-
-    tox -e py37-requests -- -v -k "'test_status_code or test_gzip'"
-    tox -e py37-requests -- -v --last-failed
-
-This will run only tests that look like ``test_status_code`` or
-``test_gzip`` in the test suite, and only in the python 3.7 environment
-that has ``requests`` installed.
-
-Also, in order for the boto tests to run, you will need an AWS key.
-Refer to the `boto
-documentation <https://boto.readthedocs.io/en/latest/getting_started.html>`__
-for how to set this up. I have marked the boto tests as optional in
+In order for the boto3 tests to run, you will need an AWS key.
+Refer to the `boto3
+documentation <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html>`__
+for how to set this up. I have marked the boto3 tests as optional in
 Travis so you don't have to worry about them failing if you submit a
 pull request.
 
-Using PyEnv with VCR's test suite
+Using Pyenv with VCR's test suite
 ---------------------------------
 
-PyEnv is a tool for managing multiple installation of python on your system.
-See the full documentation at their `github <https://github.com/pyenv/pyenv>`_ 
-but we are also going to use `tox-pyenv <https://pypi.org/project/tox-pyenv/>`_ 
+Pyenv is a tool for managing multiple installation of python on your system.
+See the full documentation at their `github <https://github.com/pyenv/pyenv>`_
 in this example::
 
     git clone https://github.com/pyenv/pyenv ~/.pyenv
@@ -126,27 +108,21 @@ in this example::
     # Setup shim paths
     eval "$(pyenv init -)"
 
-    # Setup your local system tox tooling
-    pip install tox tox-pyenv
-
     # Install supported versions (at time of writing), this does not activate them
-    pyenv install 3.7.5 3.8.0 pypy3.8
+    pyenv install 3.12.0 pypy3.10
 
     # This activates them
-    pyenv local 3.7.5 3.8.0 pypy3.8
+    pyenv local 3.12.0 pypy3.10
 
     # Run the whole test suite
-    tox
-
-    # Run the whole test suite or just part of it
-    tox -e lint
-    tox -e py37-requests
+    pip install .[test]
+    ./run_tests.sh
 
 
 Troubleshooting on MacOSX
 -------------------------
 
-If you have this kind of error when running tox :
+If you have this kind of error when running tests :
 
 .. code:: python
 

docs/installation.rst

@@ -4,21 +4,20 @@ Installation
 VCR.py is a package on `PyPI <https://pypi.python.org>`__, so you can install
 with pip::
 
-    pip install vcrpy
+    pip3 install vcrpy
 
 Compatibility
 -------------
 
-VCR.py supports Python 3.7+, and `pypy <http://pypy.org>`__.
+VCR.py supports Python 3.8+, and `pypy <http://pypy.org>`__.
 
 The following HTTP libraries are supported:
 
 -  ``aiohttp``
--  ``boto``
 -  ``boto3``
 -  ``http.client``
 -  ``httplib2``
--  ``requests`` (both 1.x and 2.x versions)
+-  ``requests`` (>=2.16.2 versions)
 -  ``tornado.httpclient``
 -  ``urllib2``
 -  ``urllib3``
@@ -35,7 +34,7 @@ rebuilding pyyaml.
 
 1. Test if pyyaml is built with libyaml. This should work::
 
-     python -c 'from yaml import CLoader'
+     python3 -c 'from yaml import CLoader'
 
 2. Install libyaml according to your Linux distribution, or using `Homebrew
    <http://mxcl.github.com/homebrew/>`__ on Mac::
@@ -46,8 +45,8 @@ rebuilding pyyaml.
 
 3. Rebuild pyyaml with libyaml::
 
-     pip uninstall pyyaml
-     pip --no-cache-dir install pyyaml
+     pip3 uninstall pyyaml
+     pip3 --no-cache-dir install pyyaml
 
 Upgrade
 -------
@@ -61,7 +60,7 @@ is to simply delete your cassettes and re-record all of them. VCR.py
 also provides a migration script that attempts to upgrade your 0.x
 cassettes to the new 1.x format. To use it, run the following command::
 
-    python -m vcr.migration PATH
+    python3 -m vcr.migration PATH
 
 The PATH can be either a path to the directory with cassettes or the
 path to a single cassette.

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx<8
+sphinx_rtd_theme==2.0.0

docs/usage.rst

@@ -4,11 +4,11 @@ Usage
 .. code:: python
 
     import vcr
-    import urllib
+    import urllib.request
 
     with vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml'):
         response = urllib.request.urlopen('http://www.iana.org/domains/reserved').read()
-        assert 'Example domains' in response
+        assert b'Example domains' in response
 
 Run this test once, and VCR.py will record the HTTP request to
 ``fixtures/vcr_cassettes/synopsis.yaml``. Run it again, and VCR.py will
@@ -26,7 +26,7 @@ look like this:
     @vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml')
     def test_iana():
         response = urllib.request.urlopen('http://www.iana.org/domains/reserved').read()
-        assert 'Example domains' in response
+        assert b'Example domains' in response
 
 When using the decorator version of ``use_cassette``, it is possible to
 omit the path to the cassette file.
@@ -36,7 +36,7 @@ omit the path to the cassette file.
     @vcr.use_cassette()
     def test_iana():
         response = urllib.request.urlopen('http://www.iana.org/domains/reserved').read()
-        assert 'Example domains' in response
+        assert b'Example domains' in response
 
 In this case, the cassette file will be given the same name as the test
 function, and it will be placed in the same directory as the file in
@@ -92,9 +92,73 @@ all
 Unittest Integration
 --------------------
 
-While it's possible to use the context manager or decorator forms with unittest,
-there's also a ``VCRTestCase`` provided separately by `vcrpy-unittest
-<https://github.com/agriffis/vcrpy-unittest>`__.
+Inherit from ``VCRTestCase`` for automatic recording and playback of HTTP
+interactions.
+
+.. code:: python
+
+    from vcr.unittest import VCRTestCase
+    import requests
+
+    class MyTestCase(VCRTestCase):
+       def test_something(self):
+           response = requests.get('http://example.com')
+
+Similar to how VCR.py returns the cassette from the context manager,
+``VCRTestCase`` makes the cassette available as ``self.cassette``:
+
+.. code:: python
+
+    self.assertEqual(len(self.cassette), 1)
+    self.assertEqual(self.cassette.requests[0].uri, 'http://example.com')
+
+By default cassettes will be placed in the ``cassettes`` subdirectory next to the
+test, named according to the test class and method. For example, the above test
+would read from and write to ``cassettes/MyTestCase.test_something.yaml``
+
+The configuration can be modified by overriding methods on your subclass:
+``_get_vcr_kwargs``, ``_get_cassette_library_dir`` and ``_get_cassette_name``.
+To modify the ``VCR`` object after instantiation, for example to add a matcher,
+you can hook on ``_get_vcr``, for example:
+
+.. code:: python
+
+    class MyTestCase(VCRTestCase):
+        def _get_vcr(self, **kwargs):
+            myvcr = super(MyTestCase, self)._get_vcr(**kwargs)
+            myvcr.register_matcher('mymatcher', mymatcher)
+            myvcr.match_on = ['mymatcher']
+            return myvcr
+
+See
+`the source
+<https://github.com/kevin1024/vcrpy/blob/master/vcr/unittest.py>`__
+for the default implementations of these methods.
+
+If you implement a ``setUp`` method on your test class then make sure to call
+the parent version ``super().setUp()`` in your own in order to continue getting
+the cassettes produced.
+
+VCRMixin
+~~~~~~~~
+
+In case inheriting from ``VCRTestCase`` is difficult because of an existing
+class hierarchy containing tests in the base classes, inherit from ``VCRMixin``
+instead.
+
+.. code:: python
+
+    from vcr.unittest import VCRMixin
+    import requests
+    import unittest
+
+    class MyTestMixin(VCRMixin):
+       def test_something(self):
+           response = requests.get(self.url)
+
+    class MyTestCase(MyTestMixin, unittest.TestCase):
+        url = 'http://example.com'
+
 
 Pytest Integration
 ------------------

pyproject.toml

@@ -1,2 +1,36 @@
-[tool.black]
-line-length=110
+[tool.codespell]
+skip = '.git,*.pdf,*.svg,.tox'
+ignore-regex = "\\\\[fnrstv]"
+#
+# ignore-words-list = ''
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+]
+markers = ["online"]
+filterwarnings = [
+    "error",
+    '''ignore:datetime\.datetime\.utcfromtimestamp\(\) is deprecated and scheduled for removal in a future version.*:DeprecationWarning''',
+]
+
+[tool.ruff]
+select = [
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "COM", # flake8-commas
+    "E",   # pycodestyle error
+    "F",   # pyflakes
+    "I",   # isort
+    "ISC", # flake8-implicit-str-concat
+    "PIE", # flake8-pie
+    "RUF", # Ruff-specific rules
+    "UP",  # pyupgrade
+    "W",   # pycodestyle warning
+]
+line-length = 110
+target-version = "py38"
+
+[tool.ruff.isort]
+known-first-party = ["vcr"]

runtests.sh

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-# https://blog.ionelmc.ro/2015/04/14/tox-tricks-and-patterns/#when-it-inevitably-leads-to-shell-scripts
-# If you are getting an INVOCATION ERROR for this script then there is 
-# a good chance you are running on Windows.
-# You can and should use WSL for running tox on Windows when it calls bash scripts.
-REQUESTS_CA_BUNDLE=`python -m pytest_httpbin.certs` pytest $*
+# If you are getting an INVOCATION ERROR for this script then there is a good chance you are running on Windows.
+# You can and should use WSL for running tests on Windows when it calls bash scripts.
+REQUESTS_CA_BUNDLE=`python3 -m pytest_httpbin.certs` exec pytest "$@"

setup.py

@@ -5,10 +5,10 @@ import os
 import re
 import sys
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 from setuptools.command.test import test as TestCommand
 
-long_description = open("README.rst", "r").read()
+long_description = open("README.rst").read()
 here = os.path.abspath(os.path.dirname(__file__))
 
 
@@ -45,10 +45,42 @@ class PyTest(TestCommand):
 install_requires = [
     "PyYAML",
     "wrapt",
-    "six>=1.5",
     "yarl",
+    # Support for urllib3 >=2 needs CPython >=3.10
+    # so we need to block urllib3 >=2 for Python <3.10 and PyPy for now.
+    # Note that vcrpy would work fine without any urllib3 around,
+    # so this block and the dependency can be dropped at some point
+    # in the future. For more Details:
+    # https://github.com/kevin1024/vcrpy/pull/699#issuecomment-1551439663
+    "urllib3 <2; python_version <'3.10'",
+    # https://github.com/kevin1024/vcrpy/pull/775#issuecomment-1847849962
+    "urllib3 <2; platform_python_implementation =='PyPy'",
 ]
 
+extras_require = {
+    "tests": [
+        "aiohttp",
+        "boto3",
+        "httplib2",
+        "httpx",
+        "pytest-aiohttp",
+        "pytest-asyncio",
+        "pytest-cov",
+        "pytest-httpbin",
+        "pytest",
+        "requests>=2.22.0",
+        "tornado",
+        "urllib3",
+        # Needed to un-break httpbin 0.7.0. For httpbin >=0.7.1 and after,
+        # this pin and the dependency itself can be removed, provided
+        # that the related bug in httpbin has been fixed:
+        # https://github.com/kevin1024/vcrpy/issues/645#issuecomment-1562489489
+        # https://github.com/postmanlabs/httpbin/issues/673
+        # https://github.com/postmanlabs/httpbin/pull/674
+        "Werkzeug==2.0.3",
+    ],
+}
+
 setup(
     name="vcrpy",
     version=find_version("vcr", "__init__.py"),
@@ -59,20 +91,22 @@ setup(
     author_email="me@kevinmccarthy.org",
     url="https://github.com/kevin1024/vcrpy",
     packages=find_packages(exclude=["tests*"]),
-    python_requires=">=3.7",
+    python_requires=">=3.8",
     install_requires=install_requires,
     license="MIT",
-    tests_require=["pytest", "mock", "pytest-httpbin"],
+    extras_require=extras_require,
+    tests_require=extras_require["tests"],
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Environment :: Console",
         "Intended Audience :: Developers",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: Implementation :: CPython",
         "Programming Language :: Python :: Implementation :: PyPy",

tests/assertions.py

@@ -11,9 +11,12 @@ def assert_cassette_has_one_response(cass):
     assert cass.play_count == 1
 
 
-def assert_is_json(a_string):
+def assert_is_json_bytes(b: bytes):
+    assert isinstance(b, bytes)
+
     try:
-        json.loads(a_string.decode("utf-8"))
-    except Exception:
-        assert False
+        json.loads(b)
+    except Exception as error:
+        raise AssertionError() from error
+
     assert True

tests/fixtures/migration/new_cassette.json

@@ -15,9 +15,9 @@
             },
             "response": {
                 "status": {
-                    "message": "OK", 
+                    "message": "OK",
                     "code": 200
-                }, 
+                },
                 "headers": {
                     "access-control-allow-origin": ["*"],
                     "content-type": ["application/json"],
@@ -25,7 +25,7 @@
                     "server": ["gunicorn/0.17.4"],
                     "content-length": ["32"],
                     "connection": ["keep-alive"]
-                }, 
+                },
                 "body": {
                     "string": "{\n  \"origin\": \"217.122.164.194\"\n}"
                 }

tests/fixtures/migration/new_cassette.yaml

@@ -2,7 +2,7 @@ version: 1
 interactions:
 - request:
     body: null
-    headers: 
+    headers:
       accept: ['*/*']
       accept-encoding: ['gzip, deflate, compress']
       user-agent: ['python-requests/2.2.1 CPython/2.6.1 Darwin/10.8.0']

tests/fixtures/migration/old_cassette.json

@@ -1,31 +1,31 @@
 [
     {
         "request": {
-            "body": null, 
-            "protocol": "http", 
-            "method": "GET", 
+            "body": null,
+            "protocol": "http",
+            "method": "GET",
             "headers": {
-                "accept-encoding": "gzip, deflate, compress", 
-                "accept": "*/*", 
+                "accept-encoding": "gzip, deflate, compress",
+                "accept": "*/*",
                 "user-agent": "python-requests/2.2.1 CPython/2.6.1 Darwin/10.8.0"
-            }, 
-            "host": "httpbin.org", 
-            "path": "/ip", 
+            },
+            "host": "httpbin.org",
+            "path": "/ip",
             "port": 80
-        }, 
+        },
         "response": {
             "status": {
-                "message": "OK", 
+                "message": "OK",
                 "code": 200
-            }, 
+            },
             "headers": [
-                "access-control-allow-origin: *\r\n", 
-                "content-type: application/json\r\n", 
-                "date: Mon, 21 Apr 2014 23:13:40 GMT\r\n", 
-                "server: gunicorn/0.17.4\r\n", 
-                "content-length: 32\r\n", 
+                "access-control-allow-origin: *\r\n",
+                "content-type: application/json\r\n",
+                "date: Mon, 21 Apr 2014 23:13:40 GMT\r\n",
+                "server: gunicorn/0.17.4\r\n",
+                "content-length: 32\r\n",
                 "connection: keep-alive\r\n"
-            ], 
+            ],
             "body": {
                 "string": "{\n  \"origin\": \"217.122.164.194\"\n}"
             }

tests/fixtures/wild/domain_redirect.yaml

@@ -10,7 +10,7 @@ interactions:
     uri: http://seomoz.org/
   response:
     body: {string: ''}
-    headers: 
+    headers:
       Location: ['http://moz.com/']
       Server: ['BigIP']
       Connection: ['Keep-Alive']

tests/integration/aiohttp_utils.py

@@ -2,28 +2,27 @@
 import asyncio
 
 import aiohttp
-from aiohttp.test_utils import TestClient
 
 
 async def aiohttp_request(loop, method, url, output="text", encoding="utf-8", content_type=None, **kwargs):
-    session = aiohttp.ClientSession(loop=loop)
-    response_ctx = session.request(method, url, **kwargs)
+    async with aiohttp.ClientSession(loop=loop) as session:
+        response_ctx = session.request(method, url, **kwargs)
 
-    response = await response_ctx.__aenter__()
-    if output == "text":
-        content = await response.text()
-    elif output == "json":
-        content_type = content_type or "application/json"
-        content = await response.json(encoding=encoding, content_type=content_type)
-    elif output == "raw":
-        content = await response.read()
-    elif output == "stream":
-        content = await response.content.read()
+        response = await response_ctx.__aenter__()
+        if output == "text":
+            content = await response.text()
+        elif output == "json":
+            content_type = content_type or "application/json"
+            content = await response.json(encoding=encoding, content_type=content_type)
+        elif output == "raw":
+            content = await response.read()
+        elif output == "stream":
+            content = await response.content.read()
 
-    response_ctx._resp.close()
-    await session.close()
+        response_ctx._resp.close()
+        await session.close()
 
-    return response, content
+        return response, content
 
 
 def aiohttp_app():

tests/integration/cassettes/gzip_httpx_old_format.yaml

@@ -0,0 +1,41 @@
+interactions:
+- request:
+    body: ''
+    headers:
+      accept:
+      - '*/*'
+      accept-encoding:
+      - gzip, deflate, br
+      connection:
+      - keep-alive
+      host:
+      - httpbin.org
+      user-agent:
+      - python-httpx/0.23.0
+    method: GET
+    uri: https://httpbin.org/gzip
+  response:
+    content: "{\n  \"gzipped\": true, \n  \"headers\": {\n    \"Accept\": \"*/*\",
+      \n    \"Accept-Encoding\": \"gzip, deflate, br\", \n    \"Host\": \"httpbin.org\",
+      \n    \"User-Agent\": \"python-httpx/0.23.0\", \n    \"X-Amzn-Trace-Id\": \"Root=1-62a62a8d-5f39b5c50c744da821d6ea99\"\n
+      \ }, \n  \"method\": \"GET\", \n  \"origin\": \"146.200.25.115\"\n}\n"
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Encoding:
+      - gzip
+      Content-Length:
+      - '230'
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 12 Jun 2022 18:03:57 GMT
+      Server:
+      - gunicorn/19.9.0
+    http_version: HTTP/1.1
+    status_code: 200
+version: 1

tests/integration/cassettes/gzip_requests.yaml

@@ -0,0 +1,42 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate, br
+      Connection:
+      - keep-alive
+      User-Agent:
+      - python-requests/2.28.0
+    method: GET
+    uri: https://httpbin.org/gzip
+  response:
+    body:
+      string: !!binary |
+        H4sIAKwrpmIA/z2OSwrCMBCG956izLIkfQSxkl2RogfQA9R2bIM1iUkqaOndnYDIrGa+/zELDB9l
+        LfYgg5uRwYhtj86DXKDuOrQBJKR5Cuy38kZ3pld6oHu0sqTH29QGZMnVkepgtMYuKKNJcEe0vJ3U
+        C4mcjI9hpaiygqaUW7ETFYGLR8frAXXE9h1Go7nD54w++FxkYp8VsDJ4IBH6E47NmVzGqUHFkn8g
+        rJsvp2omYs8AAAA=
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - Close
+      Content-Encoding:
+      - gzip
+      Content-Length:
+      - '182'
+      Content-Type:
+      - application/json
+      Date:
+      - Sun, 12 Jun 2022 18:08:44 GMT
+      Server:
+      - Pytest-HTTPBIN/0.1.0
+    status:
+      code: 200
+      message: great
+version: 1

tests/integration/cassettes/test_httpx_test_test_behind_proxy.yml

@@ -13,7 +13,7 @@ interactions:
       user-agent:
       - python-httpx/0.12.1
     method: GET
-    uri: https://httpbin.org/headers
+    uri: https://mockbin.org/headers
   response:
     content: "{\n  \"headers\": {\n    \"Accept\": \"*/*\", \n    \"Accept-Encoding\"\
       : \"gzip, deflate, br\", \n    \"Host\": \"httpbin.org\", \n    \"User-Agent\"\

tests/integration/conftest.py

@@ -0,0 +1,16 @@
+import os
+import ssl
+
+import pytest
+
+
+@pytest.fixture
+def httpbin_ssl_context():
+    ssl_ca_location = os.environ["REQUESTS_CA_BUNDLE"]
+    ssl_cert_location = os.environ["REQUESTS_CA_BUNDLE"].replace("cacert.pem", "cert.pem")
+    ssl_key_location = os.environ["REQUESTS_CA_BUNDLE"].replace("cacert.pem", "key.pem")
+
+    ssl_context = ssl.create_default_context(cafile=ssl_ca_location)
+    ssl_context.load_cert_chain(ssl_cert_location, ssl_key_location)
+
+    return ssl_context

tests/integration/test_aiohttp.py

@@ -1,21 +1,22 @@
-import contextlib
 import logging
 import urllib.parse
 
 import pytest
 
+import vcr
+
 asyncio = pytest.importorskip("asyncio")
 aiohttp = pytest.importorskip("aiohttp")
 
-import vcr  # noqa: E402
+
 from .aiohttp_utils import aiohttp_app, aiohttp_request  # noqa: E402
 
 
 def run_in_loop(fn):
-    with contextlib.closing(asyncio.new_event_loop()) as loop:
-        asyncio.set_event_loop(loop)
-        task = loop.create_task(fn(loop))
-        return loop.run_until_complete(task)
+    async def wrapper():
+        return await fn(asyncio.get_running_loop())
+
+    return asyncio.run(wrapper())
 
 
 def request(method, url, output="text", **kwargs):
@@ -33,14 +34,10 @@ def post(url, output="text", **kwargs):
     return request("POST", url, output="text", **kwargs)
 
 
-@pytest.fixture(params=["https", "http"])
-def scheme(request):
-    """Fixture that returns both http and https."""
-    return request.param
+@pytest.mark.online
+def test_status(tmpdir, httpbin):
+    url = httpbin.url
 
-
-def test_status(tmpdir, scheme):
-    url = scheme + "://httpbin.org"
     with vcr.use_cassette(str(tmpdir.join("status.yaml"))):
         response, _ = get(url)
 
@@ -50,9 +47,10 @@ def test_status(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
+@pytest.mark.online
 @pytest.mark.parametrize("auth", [None, aiohttp.BasicAuth("vcrpy", "test")])
-def test_headers(tmpdir, scheme, auth):
-    url = scheme + "://httpbin.org"
+def test_headers(tmpdir, auth, httpbin):
+    url = httpbin.url
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         response, _ = get(url, auth=auth)
 
@@ -61,14 +59,16 @@ def test_headers(tmpdir, scheme, auth):
             request = cassette.requests[0]
             assert "AUTHORIZATION" in request.headers
         cassette_response, _ = get(url, auth=auth)
-        assert dict(cassette_response.headers) == dict(response.headers)
+        assert cassette_response.headers.items() == response.headers.items()
         assert cassette.play_count == 1
         assert "istr" not in cassette.data[0]
         assert "yarl.URL" not in cassette.data[0]
 
 
-def test_case_insensitive_headers(tmpdir, scheme):
-    url = scheme + "://httpbin.org"
+@pytest.mark.online
+def test_case_insensitive_headers(tmpdir, httpbin):
+    url = httpbin.url
+
     with vcr.use_cassette(str(tmpdir.join("whatever.yaml"))):
         _, _ = get(url)
 
@@ -79,8 +79,10 @@ def test_case_insensitive_headers(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
-def test_text(tmpdir, scheme):
-    url = scheme + "://httpbin.org"
+@pytest.mark.online
+def test_text(tmpdir, httpbin):
+    url = httpbin.url
+
     with vcr.use_cassette(str(tmpdir.join("text.yaml"))):
         _, response_text = get(url)
 
@@ -90,8 +92,9 @@ def test_text(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
-def test_json(tmpdir, scheme):
-    url = scheme + "://httpbin.org/get"
+@pytest.mark.online
+def test_json(tmpdir, httpbin):
+    url = httpbin.url + "/json"
     headers = {"Content-Type": "application/json"}
 
     with vcr.use_cassette(str(tmpdir.join("json.yaml"))):
@@ -103,8 +106,9 @@ def test_json(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
-def test_binary(tmpdir, scheme):
-    url = scheme + "://httpbin.org/image/png"
+@pytest.mark.online
+def test_binary(tmpdir, httpbin):
+    url = httpbin.url + "/image/png"
     with vcr.use_cassette(str(tmpdir.join("binary.yaml"))):
         _, response_binary = get(url, output="raw")
 
@@ -114,23 +118,25 @@ def test_binary(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
-def test_stream(tmpdir, scheme):
-    url = scheme + "://httpbin.org/get"
+@pytest.mark.online
+def test_stream(tmpdir, httpbin):
+    url = httpbin.url
 
     with vcr.use_cassette(str(tmpdir.join("stream.yaml"))):
-        resp, body = get(url, output="raw")  # Do not use stream here, as the stream is exhausted by vcr
+        _, body = get(url, output="raw")  # Do not use stream here, as the stream is exhausted by vcr
 
     with vcr.use_cassette(str(tmpdir.join("stream.yaml"))) as cassette:
-        cassette_resp, cassette_body = get(url, output="stream")
+        _, cassette_body = get(url, output="stream")
         assert cassette_body == body
         assert cassette.play_count == 1
 
 
+@pytest.mark.online
 @pytest.mark.parametrize("body", ["data", "json"])
-def test_post(tmpdir, scheme, body, caplog):
+def test_post(tmpdir, body, caplog, httpbin):
     caplog.set_level(logging.INFO)
     data = {"key1": "value1", "key2": "value2"}
-    url = scheme + "://httpbin.org/post"
+    url = httpbin.url
     with vcr.use_cassette(str(tmpdir.join("post.yaml"))):
         _, response_json = post(url, **{body: data})
 
@@ -145,14 +151,15 @@ def test_post(tmpdir, scheme, body, caplog):
         (
             log
             for log in caplog.records
-            if log.getMessage() == "<Request (POST) {}> not in cassette, sending to real server".format(url)
+            if log.getMessage() == f"<Request (POST) {url}> not in cassette, sending to real server"
         ),
         None,
     ), "Log message not found."
 
 
-def test_params(tmpdir, scheme):
-    url = scheme + "://httpbin.org/get?d=d"
+@pytest.mark.online
+def test_params(tmpdir, httpbin):
+    url = httpbin.url + "/get?d=d"
     headers = {"Content-Type": "application/json"}
     params = {"a": 1, "b": 2, "c": "c"}
 
@@ -166,8 +173,9 @@ def test_params(tmpdir, scheme):
         assert cassette.play_count == 1
 
 
-def test_params_same_url_distinct_params(tmpdir, scheme):
-    url = scheme + "://httpbin.org/get"
+@pytest.mark.online
+def test_params_same_url_distinct_params(tmpdir, httpbin):
+    url = httpbin.url + "/json"
     headers = {"Content-Type": "application/json"}
     params = {"a": 1, "b": 2, "c": "c"}
 
@@ -185,8 +193,9 @@ def test_params_same_url_distinct_params(tmpdir, scheme):
             get(url, output="text", params=other_params)
 
 
-def test_params_on_url(tmpdir, scheme):
-    url = scheme + "://httpbin.org/get?a=1&b=foo"
+@pytest.mark.online
+def test_params_on_url(tmpdir, httpbin):
+    url = httpbin.url + "/get?a=1&b=foo"
     headers = {"Content-Type": "application/json"}
 
     with vcr.use_cassette(str(tmpdir.join("get.yaml"))) as cassette:
@@ -250,8 +259,15 @@ def test_aiohttp_test_client_json(aiohttp_client, tmpdir):
     assert cassette.play_count == 1
 
 
-def test_redirect(aiohttp_client, tmpdir):
-    url = "https://mockbin.org/redirect/302/2"
+def test_cleanup_from_pytest_asyncio():
+    # work around https://github.com/pytest-dev/pytest-asyncio/issues/724
+    asyncio.get_event_loop().close()
+    asyncio.set_event_loop(None)
+
+
+@pytest.mark.online
+def test_redirect(tmpdir, httpbin):
+    url = httpbin.url + "/redirect/2"
 
     with vcr.use_cassette(str(tmpdir.join("redirect.yaml"))):
         response, _ = get(url)
@@ -268,15 +284,14 @@ def test_redirect(aiohttp_client, tmpdir):
     # looking request_info.
     assert cassette_response.request_info.url == response.request_info.url
     assert cassette_response.request_info.method == response.request_info.method
-    assert {k: v for k, v in cassette_response.request_info.headers.items()} == {
-        k: v for k, v in response.request_info.headers.items()
-    }
+    assert cassette_response.request_info.headers.items() == response.request_info.headers.items()
     assert cassette_response.request_info.real_url == response.request_info.real_url
 
 
-def test_not_modified(aiohttp_client, tmpdir):
+@pytest.mark.online
+def test_not_modified(tmpdir, httpbin):
     """It doesn't try to redirect on 304"""
-    url = "https://httpbin.org/status/304"
+    url = httpbin.url + "/status/304"
 
     with vcr.use_cassette(str(tmpdir.join("not_modified.yaml"))):
         response, _ = get(url)
@@ -291,13 +306,14 @@ def test_not_modified(aiohttp_client, tmpdir):
         assert cassette.play_count == 1
 
 
-def test_double_requests(tmpdir):
+@pytest.mark.online
+def test_double_requests(tmpdir, httpbin):
     """We should capture, record, and replay all requests and response chains,
     even if there are duplicate ones.
 
     We should replay in the order we saw them.
     """
-    url = "https://httpbin.org/get"
+    url = httpbin.url
 
     with vcr.use_cassette(str(tmpdir.join("text.yaml"))):
         _, response_text1 = get(url, output="text")
@@ -322,31 +338,41 @@ def test_double_requests(tmpdir):
         assert cassette.play_count == 2
 
 
-def test_cookies(scheme, tmpdir):
+def test_cookies(httpbin_both, httpbin_ssl_context, tmpdir):
     async def run(loop):
-        cookies_url = scheme + (
-            "://httpbin.org/response-headers?"
+        cookies_url = httpbin_both.url + (
+            "/response-headers?"
             "set-cookie=" + urllib.parse.quote("cookie_1=val_1; Path=/") + "&"
             "Set-Cookie=" + urllib.parse.quote("Cookie_2=Val_2; Path=/")
         )
-        home_url = scheme + "://httpbin.org/"
+        home_url = httpbin_both.url + "/"
         tmp = str(tmpdir.join("cookies.yaml"))
         req_cookies = {"Cookie_3": "Val_3"}
         req_headers = {"Cookie": "Cookie_4=Val_4"}
 
         # ------------------------- Record -------------------------- #
         with vcr.use_cassette(tmp) as cassette:
-            async with aiohttp.ClientSession(loop=loop) as session:
-                cookies_resp = await session.get(cookies_url)
-                home_resp = await session.get(home_url, cookies=req_cookies, headers=req_headers)
+            async with aiohttp.ClientSession(loop=loop, cookie_jar=aiohttp.CookieJar(unsafe=True)) as session:
+                cookies_resp = await session.get(cookies_url, ssl=httpbin_ssl_context)
+                home_resp = await session.get(
+                    home_url,
+                    cookies=req_cookies,
+                    headers=req_headers,
+                    ssl=httpbin_ssl_context,
+                )
                 assert cassette.play_count == 0
         assert_responses(cookies_resp, home_resp)
 
         # -------------------------- Play --------------------------- #
         with vcr.use_cassette(tmp, record_mode=vcr.mode.NONE) as cassette:
-            async with aiohttp.ClientSession(loop=loop) as session:
-                cookies_resp = await session.get(cookies_url)
-                home_resp = await session.get(home_url, cookies=req_cookies, headers=req_headers)
+            async with aiohttp.ClientSession(loop=loop, cookie_jar=aiohttp.CookieJar(unsafe=True)) as session:
+                cookies_resp = await session.get(cookies_url, ssl=httpbin_ssl_context)
+                home_resp = await session.get(
+                    home_url,
+                    cookies=req_cookies,
+                    headers=req_headers,
+                    ssl=httpbin_ssl_context,
+                )
                 assert cassette.play_count == 2
         assert_responses(cookies_resp, home_resp)
 
@@ -362,39 +388,41 @@ def test_cookies(scheme, tmpdir):
     run_in_loop(run)
 
 
-def test_cookies_redirect(scheme, tmpdir):
+def test_cookies_redirect(httpbin_both, httpbin_ssl_context, tmpdir):
     async def run(loop):
         # Sets cookie as provided by the query string and redirects
-        cookies_url = scheme + "://httpbin.org/cookies/set?Cookie_1=Val_1"
+        cookies_url = httpbin_both.url + "/cookies/set?Cookie_1=Val_1"
         tmp = str(tmpdir.join("cookies.yaml"))
 
         # ------------------------- Record -------------------------- #
         with vcr.use_cassette(tmp) as cassette:
-            async with aiohttp.ClientSession(loop=loop) as session:
-                cookies_resp = await session.get(cookies_url)
+            async with aiohttp.ClientSession(loop=loop, cookie_jar=aiohttp.CookieJar(unsafe=True)) as session:
+                cookies_resp = await session.get(cookies_url, ssl=httpbin_ssl_context)
                 assert not cookies_resp.cookies
                 cookies = session.cookie_jar.filter_cookies(cookies_url)
                 assert cookies["Cookie_1"].value == "Val_1"
                 assert cassette.play_count == 0
-            cassette.requests[1].headers["Cookie"] == "Cookie_1=Val_1"
+
+            assert cassette.requests[1].headers["Cookie"] == "Cookie_1=Val_1"
 
         # -------------------------- Play --------------------------- #
         with vcr.use_cassette(tmp, record_mode=vcr.mode.NONE) as cassette:
-            async with aiohttp.ClientSession(loop=loop) as session:
-                cookies_resp = await session.get(cookies_url)
+            async with aiohttp.ClientSession(loop=loop, cookie_jar=aiohttp.CookieJar(unsafe=True)) as session:
+                cookies_resp = await session.get(cookies_url, ssl=httpbin_ssl_context)
                 assert not cookies_resp.cookies
                 cookies = session.cookie_jar.filter_cookies(cookies_url)
                 assert cookies["Cookie_1"].value == "Val_1"
                 assert cassette.play_count == 2
-            cassette.requests[1].headers["Cookie"] == "Cookie_1=Val_1"
+
+            assert cassette.requests[1].headers["Cookie"] == "Cookie_1=Val_1"
 
         # Assert that it's ignoring expiration date
         with vcr.use_cassette(tmp, record_mode=vcr.mode.NONE) as cassette:
             cassette.responses[0]["headers"]["set-cookie"] = [
-                "Cookie_1=Val_1; Expires=Wed, 21 Oct 2015 07:28:00 GMT"
+                "Cookie_1=Val_1; Expires=Wed, 21 Oct 2015 07:28:00 GMT",
             ]
-            async with aiohttp.ClientSession(loop=loop) as session:
-                cookies_resp = await session.get(cookies_url)
+            async with aiohttp.ClientSession(loop=loop, cookie_jar=aiohttp.CookieJar(unsafe=True)) as session:
+                cookies_resp = await session.get(cookies_url, ssl=httpbin_ssl_context)
                 assert not cookies_resp.cookies
                 cookies = session.cookie_jar.filter_cookies(cookies_url)
                 assert cookies["Cookie_1"].value == "Val_1"
@@ -402,17 +430,34 @@ def test_cookies_redirect(scheme, tmpdir):
     run_in_loop(run)
 
 
-def test_not_allow_redirects(tmpdir):
-    url = "https://mockbin.org/redirect/308/5"
+@pytest.mark.online
+def test_not_allow_redirects(tmpdir, httpbin):
+    url = httpbin + "/redirect-to?url=.%2F&status_code=308"
     path = str(tmpdir.join("redirects.yaml"))
 
     with vcr.use_cassette(path):
         response, _ = get(url, allow_redirects=False)
-        assert response.url.path == "/redirect/308/5"
+        assert response.url.path == "/redirect-to"
         assert response.status == 308
 
     with vcr.use_cassette(path) as cassette:
         response, _ = get(url, allow_redirects=False)
-        assert response.url.path == "/redirect/308/5"
+        assert response.url.path == "/redirect-to"
         assert response.status == 308
         assert cassette.play_count == 1
+
+
+def test_filter_query_parameters(tmpdir, httpbin):
+    url = httpbin + "?password=secret"
+    path = str(tmpdir.join("query_param_filter.yaml"))
+
+    with vcr.use_cassette(path, filter_query_parameters=["password"]) as cassette:
+        get(url)
+
+    assert "password" not in cassette.requests[0].url
+    assert "secret" not in cassette.requests[0].url
+
+    with open(path) as f:
+        cassette_content = f.read()
+        assert "password" not in cassette_content
+        assert "secret" not in cassette_content

tests/integration/test_basic.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """Basic tests for cassettes"""
 
 # External imports
@@ -40,7 +39,7 @@ def test_basic_json_use(tmpdir, httpbin):
     test_fixture = str(tmpdir.join("synopsis.json"))
     with vcr.use_cassette(test_fixture, serializer="json"):
         response = urlopen(httpbin.url).read()
-        assert b"difficult sometimes" in response
+        assert b"A simple HTTP Request & Response Service." in response
 
 
 def test_patched_content(tmpdir, httpbin):

tests/integration/test_boto.py

@@ -1,79 +0,0 @@
-import pytest
-
-boto = pytest.importorskip("boto")
-
-import boto  # NOQA
-import boto.iam  # NOQA
-from boto.s3.connection import S3Connection  # NOQA
-from boto.s3.key import Key  # NOQA
-from configparser import DuplicateSectionError  # NOQA
-import vcr  # NOQA
-
-
-def test_boto_stubs(tmpdir):
-    with vcr.use_cassette(str(tmpdir.join("boto-stubs.yml"))):
-        # Perform the imports within the patched context so that
-        # CertValidatingHTTPSConnection refers to the patched version.
-        from boto.https_connection import CertValidatingHTTPSConnection
-        from vcr.stubs.boto_stubs import VCRCertValidatingHTTPSConnection
-
-        # Prove that the class was patched by the stub and that we can instantiate it.
-        assert issubclass(CertValidatingHTTPSConnection, VCRCertValidatingHTTPSConnection)
-        CertValidatingHTTPSConnection("hostname.does.not.matter")
-
-
-def test_boto_without_vcr():
-    s3_conn = S3Connection()
-    s3_bucket = s3_conn.get_bucket("boto-demo-1394171994")  # a bucket you can access
-    k = Key(s3_bucket)
-    k.key = "test.txt"
-    k.set_contents_from_string("hello world i am a string")
-
-
-def test_boto_medium_difficulty(tmpdir):
-    s3_conn = S3Connection()
-    s3_bucket = s3_conn.get_bucket("boto-demo-1394171994")  # a bucket you can access
-    with vcr.use_cassette(str(tmpdir.join("boto-medium.yml"))):
-        k = Key(s3_bucket)
-        k.key = "test.txt"
-        k.set_contents_from_string("hello world i am a string")
-
-    with vcr.use_cassette(str(tmpdir.join("boto-medium.yml"))):
-        k = Key(s3_bucket)
-        k.key = "test.txt"
-        k.set_contents_from_string("hello world i am a string")
-
-
-def test_boto_hardcore_mode(tmpdir):
-    with vcr.use_cassette(str(tmpdir.join("boto-hardcore.yml"))):
-        s3_conn = S3Connection()
-        s3_bucket = s3_conn.get_bucket("boto-demo-1394171994")  # a bucket you can access
-        k = Key(s3_bucket)
-        k.key = "test.txt"
-        k.set_contents_from_string("hello world i am a string")
-
-    with vcr.use_cassette(str(tmpdir.join("boto-hardcore.yml"))):
-        s3_conn = S3Connection()
-        s3_bucket = s3_conn.get_bucket("boto-demo-1394171994")  # a bucket you can access
-        k = Key(s3_bucket)
-        k.key = "test.txt"
-        k.set_contents_from_string("hello world i am a string")
-
-
-def test_boto_iam(tmpdir):
-    try:
-        boto.config.add_section("Boto")
-    except DuplicateSectionError:
-        pass
-    # Ensure that boto uses HTTPS
-    boto.config.set("Boto", "is_secure", "true")
-    # Ensure that boto uses CertValidatingHTTPSConnection
-    boto.config.set("Boto", "https_validate_certificates", "true")
-
-    with vcr.use_cassette(str(tmpdir.join("boto-iam.yml"))):
-        iam_conn = boto.iam.connect_to_region("universal")
-        iam_conn.get_all_users()
-
-    with vcr.use_cassette(str(tmpdir.join("boto-iam.yml"))):
-        iam_conn = boto.iam.connect_to_region("universal")
-        iam_conn.get_all_users()

tests/integration/test_boto3.py

@@ -1,14 +1,15 @@
-import pytest
 import os
 
+import pytest
+
+import vcr
+
 boto3 = pytest.importorskip("boto3")
 
-import boto3  # NOQA
-import botocore  # NOQA
-import vcr  # NOQA
+import botocore  # noqa
 
 try:
-    from botocore import awsrequest  # NOQA
+    from botocore import awsrequest  # noqa
 
     botocore_awsrequest = True
 except ImportError:
@@ -18,12 +19,12 @@ except ImportError:
 # https://github.com/boto/botocore/pull/1495
 boto3_skip_vendored_requests = pytest.mark.skipif(
     botocore_awsrequest,
-    reason="botocore version {ver} does not use vendored requests anymore.".format(ver=botocore.__version__),
+    reason=f"botocore version {botocore.__version__} does not use vendored requests anymore.",
 )
 
 boto3_skip_awsrequest = pytest.mark.skipif(
     not botocore_awsrequest,
-    reason="botocore version {ver} still uses vendored requests.".format(ver=botocore.__version__),
+    reason=f"botocore version {botocore.__version__} still uses vendored requests.",
 )
 
 IAM_USER_NAME = "vcrpy"
@@ -55,24 +56,6 @@ def get_user(iam_client):
     return _get_user
 
 
-@boto3_skip_vendored_requests
-def test_boto_vendored_stubs(tmpdir):
-    with vcr.use_cassette(str(tmpdir.join("boto3-stubs.yml"))):
-        # Perform the imports within the patched context so that
-        # HTTPConnection, VerifiedHTTPSConnection refers to the patched version.
-        from botocore.vendored.requests.packages.urllib3.connectionpool import (
-            HTTPConnection,
-            VerifiedHTTPSConnection,
-        )
-        from vcr.stubs.boto3_stubs import VCRRequestsHTTPConnection, VCRRequestsHTTPSConnection
-
-        # Prove that the class was patched by the stub and that we can instantiate it.
-        assert issubclass(HTTPConnection, VCRRequestsHTTPConnection)
-        assert issubclass(VerifiedHTTPSConnection, VCRRequestsHTTPSConnection)
-        HTTPConnection("hostname.does.not.matter")
-        VerifiedHTTPSConnection("hostname.does.not.matter")
-
-
 @pytest.mark.skipif(
     os.environ.get("TRAVIS_PULL_REQUEST") != "false",
     reason="Encrypted Environment Variables from Travis Repository Settings"
@@ -80,7 +63,6 @@ def test_boto_vendored_stubs(tmpdir):
     "https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions",
 )
 def test_boto_medium_difficulty(tmpdir, get_user):
-
     with vcr.use_cassette(str(tmpdir.join("boto3-medium.yml"))):
         response = get_user()
         assert response["User"]["UserName"] == IAM_USER_NAME

tests/integration/test_config.py

@@ -1,16 +1,19 @@
-import os
 import json
-import pytest
-import vcr
+import os
 from urllib.request import urlopen
 
+import pytest
 
+import vcr
+
+
+@pytest.mark.online
 def test_set_serializer_default_config(tmpdir, httpbin):
     my_vcr = vcr.VCR(serializer="json")
 
     with my_vcr.use_cassette(str(tmpdir.join("test.json"))):
         assert my_vcr.serializer == "json"
-        urlopen(httpbin.url + "/get")
+        urlopen(httpbin.url)
 
     with open(str(tmpdir.join("test.json"))) as f:
         file_content = f.read()
@@ -18,27 +21,30 @@ def test_set_serializer_default_config(tmpdir, httpbin):
         assert json.loads(file_content)
 
 
+@pytest.mark.online
 def test_default_set_cassette_library_dir(tmpdir, httpbin):
     my_vcr = vcr.VCR(cassette_library_dir=str(tmpdir.join("subdir")))
 
     with my_vcr.use_cassette("test.json"):
-        urlopen(httpbin.url + "/get")
+        urlopen(httpbin.url)
 
     assert os.path.exists(str(tmpdir.join("subdir").join("test.json")))
 
 
+@pytest.mark.online
 def test_override_set_cassette_library_dir(tmpdir, httpbin):
     my_vcr = vcr.VCR(cassette_library_dir=str(tmpdir.join("subdir")))
 
     cld = str(tmpdir.join("subdir2"))
 
     with my_vcr.use_cassette("test.json", cassette_library_dir=cld):
-        urlopen(httpbin.url + "/get")
+        urlopen(httpbin.url)
 
     assert os.path.exists(str(tmpdir.join("subdir2").join("test.json")))
     assert not os.path.exists(str(tmpdir.join("subdir").join("test.json")))
 
 
+@pytest.mark.online
 def test_override_match_on(tmpdir, httpbin):
     my_vcr = vcr.VCR(match_on=["method"])
 
@@ -46,7 +52,7 @@ def test_override_match_on(tmpdir, httpbin):
         urlopen(httpbin.url)
 
     with my_vcr.use_cassette(str(tmpdir.join("test.json"))) as cass:
-        urlopen(httpbin.url + "/get")
+        urlopen(httpbin.url)
 
     assert len(cass) == 1
     assert cass.play_count == 1
@@ -58,3 +64,24 @@ def test_missing_matcher():
     with pytest.raises(KeyError):
         with my_vcr.use_cassette("test.yaml", match_on=["notawesome"]):
             pass
+
+
+@pytest.mark.online
+def test_dont_record_on_exception(tmpdir, httpbin):
+    my_vcr = vcr.VCR(record_on_exception=False)
+
+    @my_vcr.use_cassette(str(tmpdir.join("dontsave.yml")))
+    def some_test():
+        assert b"Not in content" in urlopen(httpbin.url)
+
+    with pytest.raises(AssertionError):
+        some_test()
+
+    assert not os.path.exists(str(tmpdir.join("dontsave.yml")))
+
+    # Make sure context decorator has the same behavior
+    with pytest.raises(AssertionError):
+        with my_vcr.use_cassette(str(tmpdir.join("dontsave2.yml"))):
+            assert b"Not in content" in urlopen(httpbin.url).read()
+
+    assert not os.path.exists(str(tmpdir.join("dontsave2.yml")))

tests/integration/test_disksaver.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """Basic tests about save behavior"""
 
 # External imports
@@ -6,10 +5,13 @@ import os
 import time
 from urllib.request import urlopen
 
+import pytest
+
 # Internal imports
 import vcr
 
 
+@pytest.mark.online
 def test_disk_saver_nowrite(tmpdir, httpbin):
     """
     Ensure that when you close a cassette without changing it it doesn't
@@ -30,6 +32,7 @@ def test_disk_saver_nowrite(tmpdir, httpbin):
     assert last_mod == last_mod2
 
 
+@pytest.mark.online
 def test_disk_saver_write(tmpdir, httpbin):
     """
     Ensure that when you close a cassette after changing it it does

tests/integration/test_filter.py

@@ -1,11 +1,14 @@
 import base64
-import pytest
-from urllib.request import urlopen, Request
-from urllib.parse import urlencode
-from urllib.error import HTTPError
-import vcr
 import json
-from assertions import assert_cassette_has_one_response, assert_is_json
+from urllib.error import HTTPError
+from urllib.parse import urlencode
+from urllib.request import Request, urlopen
+
+import pytest
+
+import vcr
+
+from ..assertions import assert_cassette_has_one_response, assert_is_json_bytes
 
 
 def _request_with_auth(url, username, password):
@@ -43,13 +46,18 @@ def test_filter_basic_auth(tmpdir, httpbin):
 
 
 def test_filter_querystring(tmpdir, httpbin):
-    url = httpbin.url + "/?foo=bar"
+    url = httpbin.url + "/?password=secret"
     cass_file = str(tmpdir.join("filter_qs.yaml"))
-    with vcr.use_cassette(cass_file, filter_query_parameters=["foo"]):
+    with vcr.use_cassette(cass_file, filter_query_parameters=["password"]):
         urlopen(url)
-    with vcr.use_cassette(cass_file, filter_query_parameters=["foo"]) as cass:
+    with vcr.use_cassette(cass_file, filter_query_parameters=["password"]) as cass:
         urlopen(url)
-        assert "foo" not in cass.requests[0].url
+        assert "password" not in cass.requests[0].url
+        assert "secret" not in cass.requests[0].url
+    with open(cass_file) as f:
+        cassette_content = f.read()
+        assert "password" not in cassette_content
+        assert "secret" not in cassette_content
 
 
 def test_filter_post_data(tmpdir, httpbin):
@@ -103,7 +111,19 @@ def test_decompress_gzip(tmpdir, httpbin):
     with vcr.use_cassette(cass_file) as cass:
         decoded_response = urlopen(url).read()
         assert_cassette_has_one_response(cass)
-    assert_is_json(decoded_response)
+    assert_is_json_bytes(decoded_response)
+
+
+def test_decomptess_empty_body(tmpdir, httpbin):
+    url = httpbin.url + "/gzip"
+    request = Request(url, headers={"Accept-Encoding": ["gzip, deflate"]}, method="HEAD")
+    cass_file = str(tmpdir.join("gzip_empty_response.yaml"))
+    with vcr.use_cassette(cass_file, decode_compressed_response=True):
+        response = urlopen(request).read()
+    with vcr.use_cassette(cass_file) as cass:
+        decoded_response = urlopen(request).read()
+        assert_cassette_has_one_response(cass)
+    assert decoded_response == response
 
 
 def test_decompress_deflate(tmpdir, httpbin):
@@ -115,7 +135,7 @@ def test_decompress_deflate(tmpdir, httpbin):
     with vcr.use_cassette(cass_file) as cass:
         decoded_response = urlopen(url).read()
         assert_cassette_has_one_response(cass)
-    assert_is_json(decoded_response)
+    assert_is_json_bytes(decoded_response)
 
 
 def test_decompress_regular(tmpdir, httpbin):
@@ -127,4 +147,25 @@ def test_decompress_regular(tmpdir, httpbin):
     with vcr.use_cassette(cass_file) as cass:
         resp = urlopen(url).read()
         assert_cassette_has_one_response(cass)
-    assert_is_json(resp)
+    assert_is_json_bytes(resp)
+
+
+def test_before_record_request_corruption(tmpdir, httpbin):
+    """Modifying request in before_record_request should not affect outgoing request"""
+
+    def before_record(request):
+        request.headers.clear()
+        request.body = b""
+        return request
+
+    req = Request(
+        httpbin.url + "/post",
+        data=urlencode({"test": "exists"}).encode(),
+        headers={"X-Test": "exists"},
+    )
+    cass_file = str(tmpdir.join("modified_response.yaml"))
+    with vcr.use_cassette(cass_file, before_record_request=before_record):
+        resp = json.loads(urlopen(req).read())
+
+    assert resp["headers"]["X-Test"] == "exists"
+    assert resp["form"]["test"] == "exists"

tests/integration/test_httplib2.py

@@ -1,15 +1,12 @@
-# -*- coding: utf-8 -*-
 """Integration tests with httplib2"""
-
-import sys
-
 from urllib.parse import urlencode
+
 import pytest
 import pytest_httpbin.certs
 
 import vcr
 
-from assertions import assert_cassette_has_one_response
+from ..assertions import assert_cassette_has_one_response
 
 httplib2 = pytest.importorskip("httplib2")
 
@@ -20,8 +17,6 @@ def http():
     with the certificate replaced by the httpbin one.
     """
     kwargs = {"ca_certs": pytest_httpbin.certs.where()}
-    if sys.version_info[:2] in [(2, 7), (3, 7)]:
-        kwargs["disable_ssl_certificate_validation"] = True
     return httplib2.Http(**kwargs)
 
 
@@ -61,14 +56,15 @@ def test_response_headers(tmpdir, httpbin_both):
         assert set(headers) == set(resp.items())
 
 
-def test_effective_url(tmpdir):
+@pytest.mark.online
+def test_effective_url(tmpdir, httpbin):
     """Ensure that the effective_url is captured"""
-    url = "http://mockbin.org/redirect/301"
+    url = httpbin.url + "/redirect-to?url=.%2F&status_code=301"
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         resp, _ = http().request(url)
         effective_url = resp["content-location"]
-        assert effective_url == "http://mockbin.org/redirect/301/0"
+        assert effective_url == httpbin.url + "/"
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         resp, _ = http().request(url)

tests/integration/test_httpx.py

@@ -1,11 +1,19 @@
-import pytest
 import os
 
+import pytest
+
+import vcr
+
+from ..assertions import assert_is_json_bytes
+
 asyncio = pytest.importorskip("asyncio")
 httpx = pytest.importorskip("httpx")
 
-import vcr  # noqa: E402
-from vcr.stubs.httpx_stubs import HTTPX_REDIRECT_PARAM  # noqa: E402
+
+@pytest.fixture(params=["https", "http"])
+def scheme(request):
+    """Fixture that returns both http and https."""
+    return request.param
 
 
 class BaseDoRequest:
@@ -14,6 +22,7 @@ class BaseDoRequest:
     def __init__(self, *args, **kwargs):
         self._client_args = args
         self._client_kwargs = kwargs
+        self._client_kwargs["follow_redirects"] = self._client_kwargs.get("follow_redirects", True)
 
     def _make_client(self):
         return self._client_class(*self._client_args, **self._client_kwargs)
@@ -23,21 +32,37 @@ class DoSyncRequest(BaseDoRequest):
     _client_class = httpx.Client
 
     def __enter__(self):
+        self._client = self._make_client()
         return self
 
     def __exit__(self, *args):
-        pass
+        self._client.close()
+        del self._client
 
     @property
     def client(self):
         try:
             return self._client
-        except AttributeError:
-            self._client = self._make_client()
-            return self._client
+        except AttributeError as e:
+            raise ValueError('To access sync client, use "with do_request() as client"') from e
 
     def __call__(self, *args, **kwargs):
-        return self.client.request(*args, timeout=60, **kwargs)
+        if hasattr(self, "_client"):
+            return self.client.request(*args, timeout=60, **kwargs)
+
+        # Use one-time context and dispose of the client afterwards
+        with self:
+            return self.client.request(*args, timeout=60, **kwargs)
+
+    def stream(self, *args, **kwargs):
+        if hasattr(self, "_client"):
+            with self.client.stream(*args, **kwargs) as response:
+                return b"".join(response.iter_bytes())
+
+        # Use one-time context and dispose of the client afterwards
+        with self:
+            with self.client.stream(*args, **kwargs) as response:
+                return b"".join(response.iter_bytes())
 
 
 class DoAsyncRequest(BaseDoRequest):
@@ -64,8 +89,8 @@ class DoAsyncRequest(BaseDoRequest):
     def client(self):
         try:
             return self._client
-        except AttributeError:
-            raise ValueError('To access async client, use "with do_request() as client"')
+        except AttributeError as e:
+            raise ValueError('To access async client, use "with do_request() as client"') from e
 
     def __call__(self, *args, **kwargs):
         if hasattr(self, "_loop"):
@@ -73,14 +98,27 @@ class DoAsyncRequest(BaseDoRequest):
 
         # Use one-time context and dispose of the loop/client afterwards
         with self:
-            return self(*args, **kwargs)
+            return self._loop.run_until_complete(self.client.request(*args, **kwargs))
+
+    async def _get_stream(self, *args, **kwargs):
+        async with self.client.stream(*args, **kwargs) as response:
+            content = b""
+            async for c in response.aiter_bytes():
+                content += c
+        return content
+
+    def stream(self, *args, **kwargs):
+        if hasattr(self, "_loop"):
+            return self._loop.run_until_complete(self._get_stream(*args, **kwargs))
+
+        # Use one-time context and dispose of the loop/client afterwards
+        with self:
+            return self._loop.run_until_complete(self._get_stream(*args, **kwargs))
 
 
 def pytest_generate_tests(metafunc):
     if "do_request" in metafunc.fixturenames:
         metafunc.parametrize("do_request", [DoAsyncRequest, DoSyncRequest])
-    if "scheme" in metafunc.fixturenames:
-        metafunc.parametrize("scheme", ["http", "https"])
 
 
 @pytest.fixture
@@ -88,8 +126,10 @@ def yml(tmpdir, request):
     return str(tmpdir.join(request.function.__name__ + ".yaml"))
 
 
-def test_status(tmpdir, scheme, do_request):
-    url = scheme + "://mockbin.org/request"
+@pytest.mark.online
+def test_status(tmpdir, httpbin, do_request):
+    url = httpbin.url
+
     with vcr.use_cassette(str(tmpdir.join("status.yaml"))):
         response = do_request()("GET", url)
 
@@ -99,8 +139,10 @@ def test_status(tmpdir, scheme, do_request):
         assert cassette.play_count == 1
 
 
-def test_case_insensitive_headers(tmpdir, scheme, do_request):
-    url = scheme + "://mockbin.org/request"
+@pytest.mark.online
+def test_case_insensitive_headers(tmpdir, httpbin, do_request):
+    url = httpbin.url
+
     with vcr.use_cassette(str(tmpdir.join("whatever.yaml"))):
         do_request()("GET", url)
 
@@ -111,8 +153,10 @@ def test_case_insensitive_headers(tmpdir, scheme, do_request):
         assert cassette.play_count == 1
 
 
-def test_content(tmpdir, scheme, do_request):
-    url = scheme + "://httpbin.org"
+@pytest.mark.online
+def test_content(tmpdir, httpbin, do_request):
+    url = httpbin.url
+
     with vcr.use_cassette(str(tmpdir.join("cointent.yaml"))):
         response = do_request()("GET", url)
 
@@ -122,21 +166,22 @@ def test_content(tmpdir, scheme, do_request):
         assert cassette.play_count == 1
 
 
-def test_json(tmpdir, scheme, do_request):
-    url = scheme + "://httpbin.org/get"
-    headers = {"Content-Type": "application/json"}
+@pytest.mark.online
+def test_json(tmpdir, httpbin, do_request):
+    url = httpbin.url + "/json"
 
     with vcr.use_cassette(str(tmpdir.join("json.yaml"))):
-        response = do_request(headers=headers)("GET", url)
+        response = do_request()("GET", url)
 
     with vcr.use_cassette(str(tmpdir.join("json.yaml"))) as cassette:
-        cassette_response = do_request(headers=headers)("GET", url)
+        cassette_response = do_request()("GET", url)
         assert cassette_response.json() == response.json()
         assert cassette.play_count == 1
 
 
-def test_params_same_url_distinct_params(tmpdir, scheme, do_request):
-    url = scheme + "://httpbin.org/get"
+@pytest.mark.online
+def test_params_same_url_distinct_params(tmpdir, httpbin, do_request):
+    url = httpbin.url + "/get"
     headers = {"Content-Type": "application/json"}
     params = {"a": 1, "b": False, "c": "c"}
 
@@ -155,46 +200,32 @@ def test_params_same_url_distinct_params(tmpdir, scheme, do_request):
             do_request()("GET", url, params=params, headers=headers)
 
 
-def test_redirect(tmpdir, do_request, yml):
-    url = "https://mockbin.org/redirect/303/2"
+@pytest.mark.online
+def test_redirect(httpbin, yml, do_request):
+    url = httpbin.url + "/redirect-to"
 
-    redirect_kwargs = {HTTPX_REDIRECT_PARAM.name: True}
-
-    response = do_request()("GET", url, **redirect_kwargs)
+    response = do_request()("GET", url)
     with vcr.use_cassette(yml):
-        response = do_request()("GET", url, **redirect_kwargs)
+        response = do_request()("GET", url, params={"url": "./get", "status_code": 302})
 
     with vcr.use_cassette(yml) as cassette:
-        cassette_response = do_request()("GET", url, **redirect_kwargs)
+        cassette_response = do_request()("GET", url, params={"url": "./get", "status_code": 302})
 
         assert cassette_response.status_code == response.status_code
         assert len(cassette_response.history) == len(response.history)
-        assert len(cassette) == 3
-        assert cassette.play_count == 3
+        assert len(cassette) == 2
+        assert cassette.play_count == 2
 
     # Assert that the real response and the cassette response have a similar
     # looking request_info.
     assert cassette_response.request.url == response.request.url
     assert cassette_response.request.method == response.request.method
-    assert {k: v for k, v in cassette_response.request.headers.items()} == {
-        k: v for k, v in response.request.headers.items()
-    }
-
-
-def test_work_with_gzipped_data(tmpdir, do_request, yml):
-    with vcr.use_cassette(yml):
-        do_request()("GET", "https://httpbin.org/gzip")
-
-    with vcr.use_cassette(yml) as cassette:
-        cassette_response = do_request()("GET", "https://httpbin.org/gzip")
-
-        assert "gzip" in cassette_response.json()["headers"]["Accept-Encoding"]
-        assert cassette_response.read()
-        assert cassette.play_count == 1
+    assert cassette_response.request.headers.items() == response.request.headers.items()
 
 
+@pytest.mark.online
 @pytest.mark.parametrize("url", ["https://github.com/kevin1024/vcrpy/issues/" + str(i) for i in range(3, 6)])
-def test_simple_fetching(tmpdir, do_request, yml, url):
+def test_simple_fetching(do_request, yml, url):
     with vcr.use_cassette(yml):
         do_request()("GET", url)
 
@@ -204,96 +235,127 @@ def test_simple_fetching(tmpdir, do_request, yml, url):
         assert cassette.play_count == 1
 
 
-def test_behind_proxy(do_request):
-    # This is recorded because otherwise we should have a live proxy somewhere.
-    yml = (
-        os.path.dirname(os.path.realpath(__file__)) + "/cassettes/" + "test_httpx_test_test_behind_proxy.yml"
-    )
-    url = "https://httpbin.org/headers"
-    proxy = "http://localhost:8080"
-    proxies = {"http://": proxy, "https://": proxy}
-
-    with vcr.use_cassette(yml):
-        response = do_request(proxies=proxies, verify=False)("GET", url)
-
-    with vcr.use_cassette(yml) as cassette:
-        cassette_response = do_request(proxies=proxies, verify=False)("GET", url)
-        assert str(cassette_response.request.url) == url
-        assert cassette.play_count == 1
-
-        assert cassette_response.headers["Via"] == "my_own_proxy", str(cassette_response.headers)
-        assert cassette_response.request.url == response.request.url
-
-
-def test_cookies(tmpdir, scheme, do_request):
+@pytest.mark.online
+def test_cookies(tmpdir, httpbin, do_request):
     def client_cookies(client):
-        return [c for c in client.client.cookies]
+        return list(client.client.cookies)
 
     def response_cookies(response):
-        return [c for c in response.cookies]
+        return list(response.cookies)
 
-    with do_request() as client:
+    url = httpbin.url + "/cookies/set"
+    params = {"k1": "v1", "k2": "v2"}
+
+    with do_request(params=params, follow_redirects=False) as client:
         assert client_cookies(client) == []
 
-        redirect_kwargs = {HTTPX_REDIRECT_PARAM.name: True}
-
-        url = scheme + "://httpbin.org"
         testfile = str(tmpdir.join("cookies.yml"))
         with vcr.use_cassette(testfile):
-            r1 = client("GET", url + "/cookies/set?k1=v1&k2=v2", **redirect_kwargs)
-            assert response_cookies(r1.history[0]) == ["k1", "k2"]
-            assert response_cookies(r1) == []
+            r1 = client("GET", url)
 
-            r2 = client("GET", url + "/cookies", **redirect_kwargs)
-            assert len(r2.json()["cookies"]) == 2
+            assert response_cookies(r1) == ["k1", "k2"]
 
+            r2 = client("GET", url)
+
+            assert response_cookies(r2) == ["k1", "k2"]
             assert client_cookies(client) == ["k1", "k2"]
 
-    with do_request() as new_client:
+    with do_request(params=params, follow_redirects=False) as new_client:
         assert client_cookies(new_client) == []
 
         with vcr.use_cassette(testfile) as cassette:
-            cassette_response = new_client("GET", url + "/cookies/set?k1=v1&k2=v2")
-            assert response_cookies(cassette_response.history[0]) == ["k1", "k2"]
-            assert response_cookies(cassette_response) == []
+            cassette_response = new_client("GET", url)
 
-            assert cassette.play_count == 2
+            assert cassette.play_count == 1
+            assert response_cookies(cassette_response) == ["k1", "k2"]
             assert client_cookies(new_client) == ["k1", "k2"]
 
 
-def test_relative_redirects(tmpdir, scheme, do_request):
-    redirect_kwargs = {HTTPX_REDIRECT_PARAM.name: True}
+@pytest.mark.online
+def test_stream(tmpdir, httpbin, do_request):
+    url = httpbin.url + "/stream-bytes/512"
+    testfile = str(tmpdir.join("stream.yml"))
 
-    url = scheme + "://mockbin.com/redirect/301?to=/redirect/301?to=/request"
-    testfile = str(tmpdir.join("relative_redirects.yml"))
     with vcr.use_cassette(testfile):
-        response = do_request()("GET", url, **redirect_kwargs)
-        assert len(response.history) == 2, response
-        assert response.json()["url"].endswith("request")
+        response_content = do_request().stream("GET", url)
+        assert len(response_content) == 512
 
     with vcr.use_cassette(testfile) as cassette:
-        response = do_request()("GET", url, **redirect_kwargs)
-        assert len(response.history) == 2
-        assert response.json()["url"].endswith("request")
-
-        assert cassette.play_count == 3
+        cassette_content = do_request().stream("GET", url)
+        assert cassette_content == response_content
+        assert len(cassette_content) == 512
+        assert cassette.play_count == 1
 
 
-def test_redirect_wo_allow_redirects(do_request, yml):
-    url = "https://mockbin.org/redirect/308/5"
-
-    redirect_kwargs = {HTTPX_REDIRECT_PARAM.name: False}
-
-    with vcr.use_cassette(yml):
-        response = do_request()("GET", url, **redirect_kwargs)
-
-        assert str(response.url).endswith("308/5")
-        assert response.status_code == 308
+# Regular cassette formats support the status reason,
+# but the old HTTPX cassette format does not.
+@pytest.mark.parametrize(
+    "cassette_name,reason",
+    [
+        ("requests", "great"),
+        ("httpx_old_format", "OK"),
+    ],
+)
+def test_load_cassette_format(do_request, cassette_name, reason):
+    mydir = os.path.dirname(os.path.realpath(__file__))
+    yml = f"{mydir}/cassettes/gzip_{cassette_name}.yaml"
+    url = "https://httpbin.org/gzip"
 
     with vcr.use_cassette(yml) as cassette:
-        response = do_request()("GET", url, **redirect_kwargs)
-
-        assert str(response.url).endswith("308/5")
-        assert response.status_code == 308
-
+        cassette_response = do_request()("GET", url)
+        assert str(cassette_response.request.url) == url
         assert cassette.play_count == 1
+
+        # Should be able to load up the JSON inside,
+        # regardless whether the content is the gzipped
+        # in the cassette or not.
+        json = cassette_response.json()
+        assert json["method"] == "GET", json
+        assert cassette_response.status_code == 200
+        assert cassette_response.reason_phrase == reason
+
+
+def test_gzip__decode_compressed_response_false(tmpdir, httpbin, do_request):
+    """
+    Ensure that httpx is able to automatically decompress the response body.
+    """
+    for _ in range(2):  # one for recording, one for re-playing
+        with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))) as cassette:
+            response = do_request()("GET", httpbin + "/gzip")
+            assert response.headers["content-encoding"] == "gzip"  # i.e. not removed
+            # The content stored in the cassette should be gzipped.
+            assert cassette.responses[0]["body"]["string"][:2] == b"\x1f\x8b"
+            assert_is_json_bytes(response.content)  # i.e. uncompressed bytes
+
+
+def test_gzip__decode_compressed_response_true(do_request, tmpdir, httpbin):
+    url = httpbin + "/gzip"
+
+    expected_response = do_request()("GET", url)
+    expected_content = expected_response.content
+    assert expected_response.headers["content-encoding"] == "gzip"  # self-test
+
+    with vcr.use_cassette(
+        str(tmpdir.join("decode_compressed.yaml")),
+        decode_compressed_response=True,
+    ) as cassette:
+        r = do_request()("GET", url)
+        assert r.headers["content-encoding"] == "gzip"  # i.e. not removed
+        content_length = r.headers["content-length"]
+        assert r.content == expected_content
+
+    # Has the cassette body been decompressed?
+    cassette_response_body = cassette.responses[0]["body"]["string"]
+    assert isinstance(cassette_response_body, str)
+
+    # Content should be JSON.
+    assert cassette_response_body[0:1] == "{"
+
+    with vcr.use_cassette(str(tmpdir.join("decode_compressed.yaml")), decode_compressed_response=True):
+        r = httpx.get(url)
+        assert "content-encoding" not in r.headers  # i.e. removed
+        assert r.content == expected_content
+
+        # As the content is uncompressed, it should have a bigger
+        # length than the compressed version.
+        assert r.headers["content-length"] > content_length

tests/integration/test_ignore.py

@@ -1,6 +1,7 @@
-from urllib.request import urlopen
 import socket
 from contextlib import contextmanager
+from urllib.request import urlopen
+
 import vcr
 
 
@@ -27,9 +28,9 @@ def test_ignore_localhost(tmpdir, httpbin):
     with overridden_dns({"httpbin.org": "127.0.0.1"}):
         cass_file = str(tmpdir.join("filter_qs.yaml"))
         with vcr.use_cassette(cass_file, ignore_localhost=True) as cass:
-            urlopen("http://localhost:{}/".format(httpbin.port))
+            urlopen(f"http://localhost:{httpbin.port}/")
             assert len(cass) == 0
-            urlopen("http://httpbin.org:{}/".format(httpbin.port))
+            urlopen(f"http://httpbin.org:{httpbin.port}/")
             assert len(cass) == 1
 
 
@@ -37,9 +38,9 @@ def test_ignore_httpbin(tmpdir, httpbin):
     with overridden_dns({"httpbin.org": "127.0.0.1"}):
         cass_file = str(tmpdir.join("filter_qs.yaml"))
         with vcr.use_cassette(cass_file, ignore_hosts=["httpbin.org"]) as cass:
-            urlopen("http://httpbin.org:{}/".format(httpbin.port))
+            urlopen(f"http://httpbin.org:{httpbin.port}/")
             assert len(cass) == 0
-            urlopen("http://localhost:{}/".format(httpbin.port))
+            urlopen(f"http://localhost:{httpbin.port}/")
             assert len(cass) == 1
 
 
@@ -47,8 +48,8 @@ def test_ignore_localhost_and_httpbin(tmpdir, httpbin):
     with overridden_dns({"httpbin.org": "127.0.0.1"}):
         cass_file = str(tmpdir.join("filter_qs.yaml"))
         with vcr.use_cassette(cass_file, ignore_hosts=["httpbin.org"], ignore_localhost=True) as cass:
-            urlopen("http://httpbin.org:{}".format(httpbin.port))
-            urlopen("http://localhost:{}".format(httpbin.port))
+            urlopen(f"http://httpbin.org:{httpbin.port}")
+            urlopen(f"http://localhost:{httpbin.port}")
             assert len(cass) == 0
 
 
@@ -56,12 +57,12 @@ def test_ignore_localhost_twice(tmpdir, httpbin):
     with overridden_dns({"httpbin.org": "127.0.0.1"}):
         cass_file = str(tmpdir.join("filter_qs.yaml"))
         with vcr.use_cassette(cass_file, ignore_localhost=True) as cass:
-            urlopen("http://localhost:{}".format(httpbin.port))
+            urlopen(f"http://localhost:{httpbin.port}")
             assert len(cass) == 0
-            urlopen("http://httpbin.org:{}".format(httpbin.port))
+            urlopen(f"http://httpbin.org:{httpbin.port}")
             assert len(cass) == 1
         with vcr.use_cassette(cass_file, ignore_localhost=True) as cass:
             assert len(cass) == 1
-            urlopen("http://localhost:{}".format(httpbin.port))
-            urlopen("http://httpbin.org:{}".format(httpbin.port))
+            urlopen(f"http://localhost:{httpbin.port}")
+            urlopen(f"http://httpbin.org:{httpbin.port}")
             assert len(cass) == 1

tests/integration/test_matchers.py

@@ -1,7 +1,8 @@
-import vcr
-import pytest
 from urllib.request import urlopen
 
+import pytest
+
+import vcr
 
 DEFAULT_URI = "http://httpbin.org/get?p1=q1&p2=q2"  # base uri for testing
 
@@ -35,7 +36,6 @@ def cassette(tmpdir, httpbin, httpbin_secure):
     ],
 )
 def test_matchers(httpbin, httpbin_secure, cassette, matcher, matching_uri, not_matching_uri):
-
     matching_uri = _replace_httpbin(matching_uri, httpbin, httpbin_secure)
     not_matching_uri = _replace_httpbin(not_matching_uri, httpbin, httpbin_secure)
     default_uri = _replace_httpbin(DEFAULT_URI, httpbin, httpbin_secure)
@@ -72,10 +72,14 @@ def test_method_matcher(cassette, httpbin, httpbin_secure):
 
 
 @pytest.mark.parametrize(
-    "uri", [DEFAULT_URI, "http://httpbin.org/get?p2=q2&p1=q1", "http://httpbin.org/get?p2=q2&p1=q1"]
+    "uri",
+    (
+        DEFAULT_URI,
+        "http://httpbin.org/get?p2=q2&p1=q1",
+        "http://httpbin.org/get?p2=q2&p1=q1",
+    ),
 )
 def test_default_matcher_matches(cassette, uri, httpbin, httpbin_secure):
-
     uri = _replace_httpbin(uri, httpbin, httpbin_secure)
 
     with vcr.use_cassette(cassette) as cass:

tests/integration/test_multiple.py

@@ -1,7 +1,10 @@
-import pytest
-import vcr
 from urllib.request import urlopen
 
+import pytest
+
+import vcr
+from vcr.errors import CannotOverwriteExistingCassetteException
+
 
 def test_making_extra_request_raises_exception(tmpdir, httpbin):
     # make two requests in the first request that are considered
@@ -16,5 +19,5 @@ def test_making_extra_request_raises_exception(tmpdir, httpbin):
     with vcr.use_cassette(str(tmpdir.join("test.json")), match_on=["method"]):
         assert urlopen(httpbin.url + "/status/200").getcode() == 200
         assert urlopen(httpbin.url + "/status/201").getcode() == 201
-        with pytest.raises(Exception):
+        with pytest.raises(CannotOverwriteExistingCassetteException):
             urlopen(httpbin.url + "/status/200")

tests/integration/test_proxy.py

@@ -1,15 +1,12 @@
-# -*- coding: utf-8 -*-
 """Test using a proxy."""
 
-# External imports
-import multiprocessing
-import pytest
-
 import http.server
 import socketserver
+import threading
 from urllib.request import urlopen
 
-# Internal imports
+import pytest
+
 import vcr
 
 # Conditional imports
@@ -32,20 +29,22 @@ class Proxy(http.server.SimpleHTTPRequestHandler):
             # In Python 2 the response is an addinfourl instance.
             status = upstream_response.code
             headers = upstream_response.info().items()
-        self.send_response(status, upstream_response.msg)
+        self.log_request(status)
+        self.send_response_only(status, upstream_response.msg)
         for header in headers:
             self.send_header(*header)
         self.end_headers()
         self.copyfile(upstream_response, self.wfile)
 
 
-@pytest.yield_fixture(scope="session")
+@pytest.fixture(scope="session")
 def proxy_server():
-    httpd = socketserver.ThreadingTCPServer(("", 0), Proxy)
-    proxy_process = multiprocessing.Process(target=httpd.serve_forever)
-    proxy_process.start()
-    yield "http://{}:{}".format(*httpd.server_address)
-    proxy_process.terminate()
+    with socketserver.ThreadingTCPServer(("", 0), Proxy) as httpd:
+        proxy_process = threading.Thread(target=httpd.serve_forever)
+        proxy_process.start()
+        yield "http://{}:{}".format(*httpd.server_address)
+        httpd.shutdown()
+        proxy_process.join()
 
 
 def test_use_proxy(tmpdir, httpbin, proxy_server):
@@ -53,8 +52,10 @@ def test_use_proxy(tmpdir, httpbin, proxy_server):
     with vcr.use_cassette(str(tmpdir.join("proxy.yaml"))):
         response = requests.get(httpbin.url, proxies={"http": proxy_server})
 
-    with vcr.use_cassette(str(tmpdir.join("proxy.yaml"))) as cassette:
+    with vcr.use_cassette(str(tmpdir.join("proxy.yaml")), mode="once") as cassette:
         cassette_response = requests.get(httpbin.url, proxies={"http": proxy_server})
 
+    for key in set(cassette_response.headers.keys()) & set(response.headers.keys()):
+        assert cassette_response.headers[key] == response.headers[key]
     assert cassette_response.headers == response.headers
     assert cassette.play_count == 1

tests/integration/test_record_mode.py

@@ -1,7 +1,10 @@
-import pytest
-import vcr
 from urllib.request import urlopen
 
+import pytest
+
+import vcr
+from vcr.errors import CannotOverwriteExistingCassetteException
+
 
 def test_once_record_mode(tmpdir, httpbin):
     testfile = str(tmpdir.join("recordmode.yml"))
@@ -16,7 +19,7 @@ def test_once_record_mode(tmpdir, httpbin):
         # the first time, it's played from the cassette.
         # but, try to access something else from the same cassette, and an
         # exception is raised.
-        with pytest.raises(Exception):
+        with pytest.raises(CannotOverwriteExistingCassetteException):
             urlopen(httpbin.url + "/get").read()
 
 
@@ -57,7 +60,7 @@ def test_new_episodes_record_mode(tmpdir, httpbin):
         assert cass.all_played
 
         # in the "new_episodes" record mode, we can add more requests to
-        # a cassette without repurcussions.
+        # a cassette without repercussions.
         urlopen(httpbin.url + "/get").read()
 
         # one of the responses has been played
@@ -92,7 +95,7 @@ def test_new_episodes_record_mode_two_times(tmpdir, httpbin):
         assert urlopen(url).read() == original_second_response
         # now that we are back in once mode, this should raise
         # an error.
-        with pytest.raises(Exception):
+        with pytest.raises(CannotOverwriteExistingCassetteException):
             urlopen(url).read()
 
 
@@ -108,7 +111,7 @@ def test_all_record_mode(tmpdir, httpbin):
         urlopen(httpbin.url).read()
 
         # in the "all" record mode, we can add more requests to
-        # a cassette without repurcussions.
+        # a cassette without repercussions.
         urlopen(httpbin.url + "/get").read()
 
         # The cassette was never actually played, even though it existed.
@@ -122,7 +125,7 @@ def test_none_record_mode(tmpdir, httpbin):
     # raise hell.
     testfile = str(tmpdir.join("recordmode.yml"))
     with vcr.use_cassette(testfile, record_mode=vcr.mode.NONE):
-        with pytest.raises(Exception):
+        with pytest.raises(CannotOverwriteExistingCassetteException):
             urlopen(httpbin.url).read()
 
 
@@ -138,5 +141,5 @@ def test_none_record_mode_with_existing_cassette(tmpdir, httpbin):
         urlopen(httpbin.url).read()
         assert cass.play_count == 1
         # but if I try to hit the net, raise an exception.
-        with pytest.raises(Exception):
+        with pytest.raises(CannotOverwriteExistingCassetteException):
             urlopen(httpbin.url + "/get").read()

tests/integration/test_register_matcher.py

@@ -1,6 +1,9 @@
-import vcr
 from urllib.request import urlopen
 
+import pytest
+
+import vcr
+
 
 def true_matcher(r1, r2):
     return True
@@ -10,6 +13,7 @@ def false_matcher(r1, r2):
     return False
 
 
+@pytest.mark.online
 def test_registered_true_matcher(tmpdir, httpbin):
     my_vcr = vcr.VCR()
     my_vcr.register_matcher("true", true_matcher)
@@ -21,10 +25,11 @@ def test_registered_true_matcher(tmpdir, httpbin):
 
     with my_vcr.use_cassette(testfile, match_on=["true"]):
         # I can get the response twice even though I only asked for it once
-        urlopen(httpbin.url + "/get")
-        urlopen(httpbin.url + "/get")
+        urlopen(httpbin.url)
+        urlopen(httpbin.url)
 
 
+@pytest.mark.online
 def test_registered_false_matcher(tmpdir, httpbin):
     my_vcr = vcr.VCR()
     my_vcr.register_matcher("false", false_matcher)

tests/integration/test_register_persister.py

@@ -1,16 +1,17 @@
-# -*- coding: utf-8 -*-
 """Tests for cassettes with custom persistence"""
 
 # External imports
 import os
 from urllib.request import urlopen
 
+import pytest
+
 # Internal imports
 import vcr
-from vcr.persisters.filesystem import FilesystemPersister
+from vcr.persisters.filesystem import CassetteDecodeError, CassetteNotFoundError, FilesystemPersister
 
 
-class CustomFilesystemPersister(object):
+class CustomFilesystemPersister:
     """Behaves just like default FilesystemPersister but adds .test extension
     to the cassette file"""
 
@@ -25,6 +26,19 @@ class CustomFilesystemPersister(object):
         FilesystemPersister.save_cassette(cassette_path, cassette_dict, serializer)
 
 
+class BadPersister(FilesystemPersister):
+    """A bad persister that raises different errors."""
+
+    @staticmethod
+    def load_cassette(cassette_path, serializer):
+        if "nonexistent" in cassette_path:
+            raise CassetteNotFoundError()
+        elif "encoding" in cassette_path:
+            raise CassetteDecodeError()
+        else:
+            raise ValueError("buggy persister")
+
+
 def test_save_cassette_with_custom_persister(tmpdir, httpbin):
     """Ensure you can save a cassette using custom persister"""
     my_vcr = vcr.VCR()
@@ -52,4 +66,23 @@ def test_load_cassette_with_custom_persister(tmpdir, httpbin):
 
     with my_vcr.use_cassette(test_fixture, serializer="json"):
         response = urlopen(httpbin.url).read()
-        assert b"difficult sometimes" in response
+        assert b"A simple HTTP Request & Response Service." in response
+
+
+def test_load_cassette_persister_exception_handling(tmpdir, httpbin):
+    """
+    Ensure expected errors from persister are swallowed while unexpected ones
+    are passed up the call stack.
+    """
+    my_vcr = vcr.VCR()
+    my_vcr.register_persister(BadPersister)
+
+    with my_vcr.use_cassette("bad/nonexistent") as cass:
+        assert len(cass) == 0
+
+    with my_vcr.use_cassette("bad/encoding") as cass:
+        assert len(cass) == 0
+
+    with pytest.raises(ValueError):
+        with my_vcr.use_cassette("bad/buggy") as cass:
+            pass

tests/integration/test_request.py

@@ -1,6 +1,7 @@
-import vcr
 from urllib.request import urlopen
 
+import vcr
+
 
 def test_recorded_request_uri_with_redirected_request(tmpdir, httpbin):
     with vcr.use_cassette(str(tmpdir.join("test.yml"))) as cass:

tests/integration/test_requests.py

@@ -1,10 +1,11 @@
 """Test requests' interaction with vcr"""
 import pytest
+
 import vcr
-from assertions import assert_cassette_empty, assert_is_json
+
+from ..assertions import assert_cassette_empty, assert_is_json_bytes
 
 requests = pytest.importorskip("requests")
-from requests.exceptions import ConnectionError  # noqa E402
 
 
 def test_status_code(httpbin_both, tmpdir):
@@ -113,22 +114,6 @@ def test_post_chunked_binary(tmpdir, httpbin):
     assert req1 == req2
 
 
-@pytest.mark.skipif("sys.version_info >= (3, 6)", strict=True, raises=ConnectionError)
-def test_post_chunked_binary_secure(tmpdir, httpbin_secure):
-    """Ensure that we can send chunked binary without breaking while trying to concatenate bytes with str."""
-    data1 = iter([b"data", b"to", b"send"])
-    data2 = iter([b"data", b"to", b"send"])
-    url = httpbin_secure.url + "/post"
-    with vcr.use_cassette(str(tmpdir.join("requests.yaml"))):
-        req1 = requests.post(url, data1).content
-        print(req1)
-
-    with vcr.use_cassette(str(tmpdir.join("requests.yaml"))):
-        req2 = requests.post(url, data2).content
-
-    assert req1 == req2
-
-
 def test_redirects(tmpdir, httpbin_both):
     """Ensure that we can handle redirects"""
     url = httpbin_both + "/redirect-to?url=bytes/1024"
@@ -143,6 +128,17 @@ def test_redirects(tmpdir, httpbin_both):
         assert cass.play_count == 2
 
 
+def test_raw_stream(tmpdir, httpbin):
+    expected_response = requests.get(httpbin.url, stream=True)
+    expected_content = b"".join(expected_response.raw.stream())
+
+    for _ in range(2):  # one for recording, one for cassette reply
+        with vcr.use_cassette(str(tmpdir.join("raw_stream.yaml"))):
+            actual_response = requests.get(httpbin.url, stream=True)
+            actual_content = b"".join(actual_response.raw.stream())
+        assert actual_content == expected_content
+
+
 def test_cross_scheme(tmpdir, httpbin_secure, httpbin):
     """Ensure that requests between schemes are treated separately"""
     # First fetch a url under http, and then again under https and then
@@ -155,20 +151,41 @@ def test_cross_scheme(tmpdir, httpbin_secure, httpbin):
         assert len(cass) == 2
 
 
-def test_gzip(tmpdir, httpbin_both):
+def test_gzip__decode_compressed_response_false(tmpdir, httpbin_both):
     """
     Ensure that requests (actually urllib3) is able to automatically decompress
     the response body
     """
+    for _ in range(2):  # one for recording, one for re-playing
+        with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
+            response = requests.get(httpbin_both + "/gzip")
+            assert response.headers["content-encoding"] == "gzip"  # i.e. not removed
+            assert_is_json_bytes(response.content)  # i.e. uncompressed bytes
+
+
+def test_gzip__decode_compressed_response_true(tmpdir, httpbin_both):
     url = httpbin_both + "/gzip"
-    response = requests.get(url)
 
-    with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
-        response = requests.get(url)
-        assert_is_json(response.content)
+    expected_response = requests.get(url)
+    expected_content = expected_response.content
+    assert expected_response.headers["content-encoding"] == "gzip"  # self-test
 
-    with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
-        assert_is_json(response.content)
+    with vcr.use_cassette(
+        str(tmpdir.join("decode_compressed.yaml")),
+        decode_compressed_response=True,
+    ) as cassette:
+        r = requests.get(url)
+        assert r.headers["content-encoding"] == "gzip"  # i.e. not removed
+        assert r.content == expected_content
+
+    # Has the cassette body been decompressed?
+    cassette_response_body = cassette.responses[0]["body"]["string"]
+    assert isinstance(cassette_response_body, str)
+
+    with vcr.use_cassette(str(tmpdir.join("decode_compressed.yaml")), decode_compressed_response=True):
+        r = requests.get(url)
+        assert "content-encoding" not in r.headers  # i.e. removed
+        assert r.content == expected_content
 
 
 def test_session_and_connection_close(tmpdir, httpbin):
@@ -248,7 +265,7 @@ def test_nested_cassettes_with_session_created_before_nesting(httpbin_both, tmpd
 def test_post_file(tmpdir, httpbin_both):
     """Ensure that we handle posting a file."""
     url = httpbin_both + "/post"
-    with vcr.use_cassette(str(tmpdir.join("post_file.yaml"))) as cass, open("tox.ini", "rb") as f:
+    with vcr.use_cassette(str(tmpdir.join("post_file.yaml"))) as cass, open(".editorconfig", "rb") as f:
         original_response = requests.post(url, f).content
 
     # This also tests that we do the right thing with matching the body when they are files.
@@ -256,10 +273,10 @@ def test_post_file(tmpdir, httpbin_both):
         str(tmpdir.join("post_file.yaml")),
         match_on=("method", "scheme", "host", "port", "path", "query", "body"),
     ) as cass:
-        with open("tox.ini", "rb") as f:
-            tox_content = f.read()
-        assert cass.requests[0].body.read() == tox_content
-        with open("tox.ini", "rb") as f:
+        with open(".editorconfig", "rb") as f:
+            editorconfig = f.read()
+        assert cass.requests[0].body.read() == editorconfig
+        with open(".editorconfig", "rb") as f:
             new_response = requests.post(url, f).content
         assert original_response == new_response
 

tests/integration/test_stubs.py

@@ -1,9 +1,10 @@
-import vcr
-import zlib
-import json
 import http.client as httplib
+import json
+import zlib
 
-from assertions import assert_is_json
+import vcr
+
+from ..assertions import assert_is_json_bytes
 
 
 def _headers_are_case_insensitive(host, port):
@@ -64,7 +65,7 @@ def test_original_decoded_response_is_not_modified(tmpdir, httpbin):
         inside = conn.getresponse()
 
         # Assert that we do not modify the original response while appending
-        # to the casssette.
+        # to the cassette.
         assert "gzip" == inside.headers["content-encoding"]
 
         # They should effectively be the same response.
@@ -83,7 +84,7 @@ def test_original_decoded_response_is_not_modified(tmpdir, httpbin):
         inside = conn.getresponse()
 
         assert "content-encoding" not in inside.headers
-        assert_is_json(inside.read())
+        assert_is_json_bytes(inside.read())
 
 
 def _make_before_record_response(fields, replacement="[REDACTED]"):
@@ -119,8 +120,8 @@ def test_original_response_is_not_modified_by_before_filter(tmpdir, httpbin):
 
         # The scrubbed field should be the same, because no cassette existed.
         # Furthermore, the responses should be identical.
-        inside_body = json.loads(inside.read().decode("utf-8"))
-        outside_body = json.loads(outside.read().decode("utf-8"))
+        inside_body = json.loads(inside.read())
+        outside_body = json.loads(outside.read())
         assert not inside_body[field_to_scrub] == replacement
         assert inside_body[field_to_scrub] == outside_body[field_to_scrub]
 
@@ -130,5 +131,5 @@ def test_original_response_is_not_modified_by_before_filter(tmpdir, httpbin):
         conn.request("GET", "/get")
         inside = conn.getresponse()
 
-        inside_body = json.loads(inside.read().decode("utf-8"))
+        inside_body = json.loads(inside.read())
         assert inside_body[field_to_scrub] == replacement

tests/integration/test_tornado.py

@@ -1,20 +1,44 @@
-# -*- coding: utf-8 -*-
 """Test requests' interaction with vcr"""
-
+import asyncio
+import functools
+import inspect
 import json
 
 import pytest
+
 import vcr
 from vcr.errors import CannotOverwriteExistingCassetteException
 
-from assertions import assert_cassette_empty, assert_is_json
+from ..assertions import assert_cassette_empty, assert_is_json_bytes
 
 tornado = pytest.importorskip("tornado")
+gen = pytest.importorskip("tornado.gen")
 http = pytest.importorskip("tornado.httpclient")
 
 # whether the current version of Tornado supports the raise_error argument for
 # fetch().
 supports_raise_error = tornado.version_info >= (4,)
+raise_error_for_response_code_only = tornado.version_info >= (6,)
+
+
+def gen_test(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        async def coro():
+            return await gen.coroutine(func)(*args, **kwargs)
+
+        return asyncio.run(coro())
+
+    # Patch the signature so pytest can inject fixtures
+    # we can't use wrapt.decorator because it returns a generator function
+    wrapper.__signature__ = inspect.signature(func)
+    return wrapper
+
+
+@pytest.fixture(params=["https", "http"])
+def scheme(request):
+    """Fixture that returns both http and https."""
+    return request.param
 
 
 @pytest.fixture(params=["simple", "curl", "default"])
@@ -44,13 +68,8 @@ def post(client, url, data=None, **kwargs):
     return client.fetch(http.HTTPRequest(url, method="POST", **kwargs))
 
 
-@pytest.fixture(params=["https", "http"])
-def scheme(request):
-    """Fixture that returns both http and https."""
-    return request.param
-
-
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_status_code(get_client, scheme, tmpdir):
     """Ensure that we can read the status code"""
     url = scheme + "://httpbin.org/"
@@ -62,7 +81,8 @@ def test_status_code(get_client, scheme, tmpdir):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_headers(get_client, scheme, tmpdir):
     """Ensure that we can read the headers back"""
     url = scheme + "://httpbin.org/"
@@ -74,7 +94,8 @@ def test_headers(get_client, scheme, tmpdir):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_body(get_client, tmpdir, scheme):
     """Ensure the responses are all identical enough"""
 
@@ -87,20 +108,21 @@ def test_body(get_client, tmpdir, scheme):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
-def test_effective_url(get_client, scheme, tmpdir):
+@gen_test
+def test_effective_url(get_client, tmpdir, httpbin):
     """Ensure that the effective_url is captured"""
-    url = scheme + "://mockbin.org/redirect/301?url=/html"
+    url = httpbin.url + "/redirect/1"
     with vcr.use_cassette(str(tmpdir.join("url.yaml"))):
         effective_url = (yield get(get_client(), url)).effective_url
-        assert effective_url == scheme + "://mockbin.org/redirect/301/0"
+        assert effective_url == httpbin.url + "/get"
 
     with vcr.use_cassette(str(tmpdir.join("url.yaml"))) as cass:
         assert effective_url == (yield get(get_client(), url)).effective_url
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_auth(get_client, tmpdir, scheme):
     """Ensure that we can handle basic auth"""
     auth = ("user", "passwd")
@@ -115,7 +137,8 @@ def test_auth(get_client, tmpdir, scheme):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_auth_failed(get_client, tmpdir, scheme):
     """Ensure that we can save failed auth statuses"""
     auth = ("user", "wrongwrongwrong")
@@ -138,7 +161,8 @@ def test_auth_failed(get_client, tmpdir, scheme):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_post(get_client, tmpdir, scheme):
     """Ensure that we can post and cache the results"""
     data = {"key1": "value1", "key2": "value2"}
@@ -153,10 +177,10 @@ def test_post(get_client, tmpdir, scheme):
     assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
-def test_redirects(get_client, tmpdir, scheme):
+@gen_test
+def test_redirects(get_client, tmpdir, httpbin):
     """Ensure that we can handle redirects"""
-    url = scheme + "://mockbin.org/redirect/301?url=bytes/1024"
+    url = httpbin + "/redirect-to?url=bytes/1024&status_code=301"
     with vcr.use_cassette(str(tmpdir.join("requests.yaml"))):
         content = (yield get(get_client(), url)).body
 
@@ -165,7 +189,8 @@ def test_redirects(get_client, tmpdir, scheme):
         assert cass.play_count == 1
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_cross_scheme(get_client, tmpdir, scheme):
     """Ensure that requests between schemes are treated separately"""
     # First fetch a url under http, and then again under https and then
@@ -184,7 +209,8 @@ def test_cross_scheme(get_client, tmpdir, scheme):
         assert cass.play_count == 2
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_gzip(get_client, tmpdir, scheme):
     """
     Ensure that httpclient is able to automatically decompress the response
@@ -201,15 +227,16 @@ def test_gzip(get_client, tmpdir, scheme):
 
     with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
         response = yield get(get_client(), url, **kwargs)
-        assert_is_json(response.body)
+        assert_is_json_bytes(response.body)
 
     with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))) as cass:
         response = yield get(get_client(), url, **kwargs)
-        assert_is_json(response.body)
+        assert_is_json_bytes(response.body)
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_https_with_cert_validation_disabled(get_client, tmpdir):
     cass_path = str(tmpdir.join("cert_validation_disabled.yaml"))
 
@@ -221,13 +248,13 @@ def test_https_with_cert_validation_disabled(get_client, tmpdir):
         assert 1 == cass.play_count
 
 
-@pytest.mark.gen_test
+@gen_test
 def test_unsupported_features_raises_in_future(get_client, tmpdir):
     """Ensure that the exception for an AsyncHTTPClient feature not being
     supported is raised inside the future."""
 
     def callback(chunk):
-        assert False, "Did not expect to be called."
+        raise AssertionError("Did not expect to be called.")
 
     with vcr.use_cassette(str(tmpdir.join("invalid.yaml"))):
         future = get(get_client(), "http://httpbin.org", streaming_callback=callback)
@@ -239,23 +266,31 @@ def test_unsupported_features_raises_in_future(get_client, tmpdir):
 
 
 @pytest.mark.skipif(not supports_raise_error, reason="raise_error unavailable in tornado <= 3")
-@pytest.mark.gen_test
+@pytest.mark.skipif(
+    raise_error_for_response_code_only,
+    reason="raise_error only ignores HTTPErrors due to response code",
+)
+@gen_test
 def test_unsupported_features_raise_error_disabled(get_client, tmpdir):
     """Ensure that the exception for an AsyncHTTPClient feature not being
     supported is not raised if raise_error=False."""
 
     def callback(chunk):
-        assert False, "Did not expect to be called."
+        raise AssertionError("Did not expect to be called.")
 
     with vcr.use_cassette(str(tmpdir.join("invalid.yaml"))):
         response = yield get(
-            get_client(), "http://httpbin.org", streaming_callback=callback, raise_error=False
+            get_client(),
+            "http://httpbin.org",
+            streaming_callback=callback,
+            raise_error=False,
         )
 
     assert "not yet supported by VCR" in str(response.error)
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_cannot_overwrite_cassette_raises_in_future(get_client, tmpdir):
     """Ensure that CannotOverwriteExistingCassetteException is raised inside
     the future."""
@@ -271,7 +306,11 @@ def test_cannot_overwrite_cassette_raises_in_future(get_client, tmpdir):
 
 
 @pytest.mark.skipif(not supports_raise_error, reason="raise_error unavailable in tornado <= 3")
-@pytest.mark.gen_test
+@pytest.mark.skipif(
+    raise_error_for_response_code_only,
+    reason="raise_error only ignores HTTPErrors due to response code",
+)
+@gen_test
 def test_cannot_overwrite_cassette_raise_error_disabled(get_client, tmpdir):
     """Ensure that CannotOverwriteExistingCassetteException is not raised if
     raise_error=False in the fetch() call."""
@@ -285,14 +324,14 @@ def test_cannot_overwrite_cassette_raise_error_disabled(get_client, tmpdir):
     assert isinstance(response.error, CannotOverwriteExistingCassetteException)
 
 
-@pytest.mark.gen_test
+@gen_test
 @vcr.use_cassette(path_transformer=vcr.default_vcr.ensure_suffix(".yaml"))
 def test_tornado_with_decorator_use_cassette(get_client):
     response = yield get_client().fetch(http.HTTPRequest("http://www.google.com/", method="GET"))
     assert response.body.decode("utf-8") == "not actually google"
 
 
-@pytest.mark.gen_test
+@gen_test
 @vcr.use_cassette(path_transformer=vcr.default_vcr.ensure_suffix(".yaml"))
 def test_tornado_exception_can_be_caught(get_client):
     try:
@@ -306,7 +345,8 @@ def test_tornado_exception_can_be_caught(get_client):
         assert e.code == 404
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_existing_references_get_patched(tmpdir):
     from tornado.httpclient import AsyncHTTPClient
 
@@ -319,7 +359,8 @@ def test_existing_references_get_patched(tmpdir):
         assert cass.play_count == 1
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_existing_instances_get_patched(get_client, tmpdir):
     """Ensure that existing instances of AsyncHTTPClient get patched upon
     entering VCR context."""
@@ -334,7 +375,8 @@ def test_existing_instances_get_patched(get_client, tmpdir):
         assert cass.play_count == 1
 
 
-@pytest.mark.gen_test
+@pytest.mark.online
+@gen_test
 def test_request_time_is_set(get_client, tmpdir):
     """Ensures that the request_time on HTTPResponses is set."""
 

tests/integration/test_urllib2.py

@@ -1,15 +1,16 @@
-# -*- coding: utf-8 -*-
 """Integration tests with urllib2"""
 
 import ssl
-from urllib.request import urlopen
 from urllib.parse import urlencode
+from urllib.request import urlopen
+
 import pytest_httpbin.certs
+from pytest import mark
 
 # Internal imports
 import vcr
 
-from assertions import assert_cassette_has_one_response
+from ..assertions import assert_cassette_has_one_response
 
 
 def urlopen_with_cafile(*args, **kwargs):
@@ -56,13 +57,14 @@ def test_response_headers(httpbin_both, tmpdir):
         assert sorted(open1) == sorted(open2)
 
 
-def test_effective_url(tmpdir):
+@mark.online
+def test_effective_url(tmpdir, httpbin):
     """Ensure that the effective_url is captured"""
-    url = "http://mockbin.org/redirect/301"
+    url = httpbin.url + "/redirect-to?url=.%2F&status_code=301"
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         effective_url = urlopen_with_cafile(url).geturl()
-        assert effective_url == "http://mockbin.org/redirect/301/0"
+        assert effective_url == httpbin.url + "/"
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         assert effective_url == urlopen_with_cafile(url).geturl()

tests/integration/test_urllib3.py

@@ -4,9 +4,12 @@
 
 import pytest
 import pytest_httpbin
+
 import vcr
 from vcr.patch import force_reset
-from assertions import assert_cassette_empty, assert_is_json
+from vcr.stubs.compat import get_headers
+
+from ..assertions import assert_cassette_empty, assert_is_json_bytes
 
 urllib3 = pytest.importorskip("urllib3")
 
@@ -14,7 +17,8 @@ urllib3 = pytest.importorskip("urllib3")
 @pytest.fixture(scope="module")
 def verify_pool_mgr():
     return urllib3.PoolManager(
-        cert_reqs="CERT_REQUIRED", ca_certs=pytest_httpbin.certs.where()  # Force certificate check.
+        cert_reqs="CERT_REQUIRED",
+        ca_certs=pytest_httpbin.certs.where(),  # Force certificate check.
     )
 
 
@@ -40,7 +44,8 @@ def test_headers(tmpdir, httpbin_both, verify_pool_mgr):
         headers = verify_pool_mgr.request("GET", url).headers
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
-        assert headers == verify_pool_mgr.request("GET", url).headers
+        new_headers = verify_pool_mgr.request("GET", url).headers
+        assert sorted(get_headers(headers)) == sorted(get_headers(new_headers))
 
 
 def test_body(tmpdir, httpbin_both, verify_pool_mgr):
@@ -94,9 +99,10 @@ def test_post(tmpdir, httpbin_both, verify_pool_mgr):
     assert req1 == req2
 
 
-def test_redirects(tmpdir, verify_pool_mgr):
+@pytest.mark.online
+def test_redirects(tmpdir, verify_pool_mgr, httpbin):
     """Ensure that we can handle redirects"""
-    url = "http://mockbin.org/redirect/301"
+    url = httpbin.url + "/redirect/1"
 
     with vcr.use_cassette(str(tmpdir.join("verify_pool_mgr.yaml"))):
         content = verify_pool_mgr.request("GET", url).data
@@ -132,10 +138,10 @@ def test_gzip(tmpdir, httpbin_both, verify_pool_mgr):
 
     with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
         response = verify_pool_mgr.request("GET", url)
-        assert_is_json(response.data)
+        assert_is_json_bytes(response.data)
 
     with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))):
-        assert_is_json(response.data)
+        assert_is_json_bytes(response.data)
 
 
 def test_https_with_cert_validation_disabled(tmpdir, httpbin_secure, pool_mgr):
@@ -144,18 +150,18 @@ def test_https_with_cert_validation_disabled(tmpdir, httpbin_secure, pool_mgr):
 
 
 def test_urllib3_force_reset():
-    cpool = urllib3.connectionpool
-    http_original = cpool.HTTPConnection
-    https_original = cpool.HTTPSConnection
-    verified_https_original = cpool.VerifiedHTTPSConnection
+    conn = urllib3.connection
+    http_original = conn.HTTPConnection
+    https_original = conn.HTTPSConnection
+    verified_https_original = conn.VerifiedHTTPSConnection
     with vcr.use_cassette(path="test"):
-        first_cassette_HTTPConnection = cpool.HTTPConnection
-        first_cassette_HTTPSConnection = cpool.HTTPSConnection
-        first_cassette_VerifiedHTTPSConnection = cpool.VerifiedHTTPSConnection
+        first_cassette_HTTPConnection = conn.HTTPConnection
+        first_cassette_HTTPSConnection = conn.HTTPSConnection
+        first_cassette_VerifiedHTTPSConnection = conn.VerifiedHTTPSConnection
         with force_reset():
-            assert cpool.HTTPConnection is http_original
-            assert cpool.HTTPSConnection is https_original
-            assert cpool.VerifiedHTTPSConnection is verified_https_original
-        assert cpool.HTTPConnection is first_cassette_HTTPConnection
-        assert cpool.HTTPSConnection is first_cassette_HTTPSConnection
-        assert cpool.VerifiedHTTPSConnection is first_cassette_VerifiedHTTPSConnection
+            assert conn.HTTPConnection is http_original
+            assert conn.HTTPSConnection is https_original
+            assert conn.VerifiedHTTPSConnection is verified_https_original
+        assert conn.HTTPConnection is first_cassette_HTTPConnection
+        assert conn.HTTPSConnection is first_cassette_HTTPSConnection
+        assert conn.VerifiedHTTPSConnection is first_cassette_VerifiedHTTPSConnection

tests/integration/test_wild.py

@@ -1,12 +1,13 @@
 import http.client as httplib
 import multiprocessing
-import pytest
 from xmlrpc.client import ServerProxy
 from xmlrpc.server import SimpleXMLRPCServer
 
-requests = pytest.importorskip("requests")
+import pytest
 
-import vcr  # NOQA
+import vcr
+
+requests = pytest.importorskip("requests")
 
 
 def test_domain_redirect():
@@ -51,6 +52,7 @@ def test_flickr_multipart_upload(httpbin, tmpdir):
         assert cass.play_count == 1
 
 
+@pytest.mark.online
 def test_flickr_should_respond_with_200(tmpdir):
     testfile = str(tmpdir.join("flickr.yml"))
     with vcr.use_cassette(testfile):
@@ -61,13 +63,15 @@ def test_flickr_should_respond_with_200(tmpdir):
 def test_cookies(tmpdir, httpbin):
     testfile = str(tmpdir.join("cookies.yml"))
     with vcr.use_cassette(testfile):
-        s = requests.Session()
-        s.get(httpbin.url + "/cookies/set?k1=v1&k2=v2")
+        with requests.Session() as s:
+            s.get(httpbin.url + "/cookies/set?k1=v1&k2=v2")
+            assert s.cookies.keys() == ["k1", "k2"]
 
-        r2 = s.get(httpbin.url + "/cookies")
-        assert len(r2.json()["cookies"]) == 2
+            r2 = s.get(httpbin.url + "/cookies")
+            assert sorted(r2.json()["cookies"].keys()) == ["k1", "k2"]
 
 
+@pytest.mark.online
 def test_amazon_doctype(tmpdir):
     # amazon gzips its homepage.  For some reason, in requests 2.7, it's not
     # getting gunzipped.
@@ -83,7 +87,7 @@ def start_rpc_server(q):
     httpd.serve_forever()
 
 
-@pytest.yield_fixture(scope="session")
+@pytest.fixture(scope="session")
 def rpc_server():
     q = multiprocessing.Queue()
     proxy_process = multiprocessing.Process(target=start_rpc_server, args=(q,))

tests/unit/test_cassettes.py

@@ -7,6 +7,7 @@ from unittest import mock
 
 import pytest
 import yaml
+
 from vcr.cassette import Cassette
 from vcr.errors import UnhandledHTTPRequestError
 from vcr.patch import force_reset
@@ -19,15 +20,31 @@ def test_cassette_load(tmpdir):
         yaml.dump(
             {
                 "interactions": [
-                    {"request": {"body": "", "uri": "foo", "method": "GET", "headers": {}}, "response": "bar"}
-                ]
-            }
-        )
+                    {
+                        "request": {"body": "", "uri": "foo", "method": "GET", "headers": {}},
+                        "response": "bar",
+                    },
+                ],
+            },
+        ),
     )
     a_cassette = Cassette.load(path=str(a_file))
     assert len(a_cassette) == 1
 
 
+def test_cassette_load_nonexistent():
+    a_cassette = Cassette.load(path="something/nonexistent.yml")
+    assert len(a_cassette) == 0
+
+
+def test_cassette_load_invalid_encoding(tmpdir):
+    a_file = tmpdir.join("invalid_encoding.yml")
+    with open(a_file, "wb") as fd:
+        fd.write(b"\xda")
+    a_cassette = Cassette.load(path=str(a_file))
+    assert len(a_cassette) == 0
+
+
 def test_cassette_not_played():
     a = Cassette("test")
     assert not a.play_count
@@ -96,7 +113,7 @@ def make_get_request():
 @mock.patch("vcr.stubs.VCRHTTPResponse")
 def test_function_decorated_with_use_cassette_can_be_invoked_multiple_times(*args):
     decorated_function = Cassette.use(path="test")(make_get_request)
-    for i in range(4):
+    for _ in range(4):
         decorated_function()
 
 
@@ -142,7 +159,7 @@ def test_cassette_allow_playback_repeats():
     a = Cassette("test", allow_playback_repeats=True)
     a.append("foo", "bar")
     a.append("other", "resp")
-    for x in range(10):
+    for _ in range(10):
         assert a.play_response("foo") == "bar"
     assert a.play_count == 10
     assert a.all_played is False
@@ -204,7 +221,7 @@ def test_nesting_cassette_context_managers(*args):
     with contextlib.ExitStack() as exit_stack:
         first_cassette = exit_stack.enter_context(Cassette.use(path="test"))
         exit_stack.enter_context(
-            mock.patch.object(first_cassette, "play_response", return_value=first_response)
+            mock.patch.object(first_cassette, "play_response", return_value=first_response),
         )
         assert_get_response_body_is("first_response")
 

tests/unit/test_errors.py

@@ -55,15 +55,18 @@ from vcr.cassette import Cassette
     ],
 )
 def test_CannotOverwriteExistingCassetteException_get_message(
-    mock_find_requests_with_most_matches, most_matches, expected_message
+    mock_find_requests_with_most_matches,
+    most_matches,
+    expected_message,
 ):
     mock_find_requests_with_most_matches.return_value = most_matches
     cassette = Cassette("path")
     failed_request = "request"
     exception_message = errors.CannotOverwriteExistingCassetteException._get_message(cassette, "request")
     expected = (
-        "Can't overwrite existing cassette (%r) in your current record mode (%r).\n"
-        "No match for the request (%r) was found.\n"
-        "%s" % (cassette._path, cassette.record_mode, failed_request, expected_message)
+        f"Can't overwrite existing cassette ({cassette._path!r}) "
+        f"in your current record mode ({cassette.record_mode!r}).\n"
+        f"No match for the request ({failed_request!r}) was found.\n"
+        f"{expected_message}"
     )
     assert exception_message == expected

tests/unit/test_filters.py

@@ -1,18 +1,19 @@
-from io import BytesIO
-from vcr.filters import (
-    remove_headers,
-    replace_headers,
-    remove_query_parameters,
-    replace_query_parameters,
-    remove_post_data_parameters,
-    replace_post_data_parameters,
-    decode_response,
-)
-from vcr.request import Request
 import gzip
 import json
-from unittest import mock
 import zlib
+from io import BytesIO
+from unittest import mock
+
+from vcr.filters import (
+    decode_response,
+    remove_headers,
+    remove_post_data_parameters,
+    remove_query_parameters,
+    replace_headers,
+    replace_post_data_parameters,
+    replace_query_parameters,
+)
+from vcr.request import Request
 
 
 def test_replace_headers():
@@ -196,7 +197,7 @@ def test_replace_json_post_data_parameters():
             ("six", "doesntexist"),
         ],
     )
-    request_data = json.loads(request.body.decode("utf-8"))
+    request_data = json.loads(request.body)
     expected_data = json.loads('{"one": "keep", "three": "tada", "four": "SHOUT"}')
     assert request_data == expected_data
 
@@ -207,8 +208,8 @@ def test_remove_json_post_data_parameters():
     request = Request("POST", "http://google.com", body, {})
     request.headers["Content-Type"] = "application/json"
     remove_post_data_parameters(request, ["id"])
-    request_body_json = json.loads(request.body.decode("utf-8"))
-    expected_json = json.loads(b'{"foo": "bar", "baz": "qux"}'.decode("utf-8"))
+    request_body_json = json.loads(request.body)
+    expected_json = json.loads(b'{"foo": "bar", "baz": "qux"}')
     assert request_body_json == expected_json
 
 
@@ -297,6 +298,18 @@ def test_decode_response_deflate():
     assert decoded_response["headers"]["content-length"] == [str(len(body))]
 
 
+def test_decode_response_deflate_already_decompressed():
+    body = b"deflate message"
+    gzip_response = {
+        "body": {"string": body},
+        "headers": {
+            "content-encoding": ["deflate"],
+        },
+    }
+    decoded_response = decode_response(gzip_response)
+    assert decoded_response["body"]["string"] == body
+
+
 def test_decode_response_gzip():
     body = b"gzip message"
 
@@ -324,3 +337,15 @@ def test_decode_response_gzip():
     decoded_response = decode_response(gzip_response)
     assert decoded_response["body"]["string"] == body
     assert decoded_response["headers"]["content-length"] == [str(len(body))]
+
+
+def test_decode_response_gzip_already_decompressed():
+    body = b"gzip message"
+    gzip_response = {
+        "body": {"string": body},
+        "headers": {
+            "content-encoding": ["gzip"],
+        },
+    }
+    decoded_response = decode_response(gzip_response)
+    assert decoded_response["body"]["string"] == body

tests/unit/test_json_serializer.py

@@ -1,6 +1,7 @@
 import pytest
-from vcr.serializers.jsonserializer import serialize
+
 from vcr.request import Request
+from vcr.serializers.jsonserializer import serialize
 
 
 def test_serialize_binary():

tests/unit/test_matchers.py

@@ -3,8 +3,7 @@ from unittest import mock
 
 import pytest
 
-from vcr import matchers
-from vcr import request
+from vcr import matchers, request
 
 # the dict contains requests with corresponding to its key difference
 # with 'base' request.
@@ -64,6 +63,9 @@ boto3_bytes_headers = {
     "Expect": b"100-continue",
     "Content-Length": "21",
 }
+chunked_headers = {
+    "Transfer-Encoding": "chunked",
+}
 
 
 @pytest.mark.parametrize(
@@ -75,10 +77,16 @@ boto3_bytes_headers = {
         ),
         (
             request.Request(
-                "POST", "http://host.com/", "a=1&b=2", {"Content-Type": "application/x-www-form-urlencoded"}
+                "POST",
+                "http://host.com/",
+                "a=1&b=2",
+                {"Content-Type": "application/x-www-form-urlencoded"},
             ),
             request.Request(
-                "POST", "http://host.com/", "b=2&a=1", {"Content-Type": "application/x-www-form-urlencoded"}
+                "POST",
+                "http://host.com/",
+                "b=2&a=1",
+                {"Content-Type": "application/x-www-form-urlencoded"},
             ),
         ),
         (
@@ -87,23 +95,38 @@ boto3_bytes_headers = {
         ),
         (
             request.Request(
-                "POST", "http://host.com/", "a=1&b=2", {"Content-Type": "application/x-www-form-urlencoded"}
+                "POST",
+                "http://host.com/",
+                "a=1&b=2",
+                {"Content-Type": "application/x-www-form-urlencoded"},
             ),
             request.Request(
-                "POST", "http://host.com/", "b=2&a=1", {"Content-Type": "application/x-www-form-urlencoded"}
+                "POST",
+                "http://host.com/",
+                "b=2&a=1",
+                {"Content-Type": "application/x-www-form-urlencoded"},
             ),
         ),
         (
             request.Request(
-                "POST", "http://host.com/", '{"a": 1, "b": 2}', {"Content-Type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"a": 1, "b": 2}',
+                {"Content-Type": "application/json"},
             ),
             request.Request(
-                "POST", "http://host.com/", '{"b": 2, "a": 1}', {"content-type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"b": 2, "a": 1}',
+                {"content-type": "application/json"},
             ),
         ),
         (
             request.Request(
-                "POST", "http://host.com/", req1_body, {"User-Agent": "xmlrpclib", "Content-Type": "text/xml"}
+                "POST",
+                "http://host.com/",
+                req1_body,
+                {"User-Agent": "xmlrpclib", "Content-Type": "text/xml"},
             ),
             request.Request(
                 "POST",
@@ -114,10 +137,16 @@ boto3_bytes_headers = {
         ),
         (
             request.Request(
-                "POST", "http://host.com/", '{"a": 1, "b": 2}', {"Content-Type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"a": 1, "b": 2}',
+                {"Content-Type": "application/json"},
             ),
             request.Request(
-                "POST", "http://host.com/", '{"b": 2, "a": 1}', {"content-type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"b": 2, "a": 1}',
+                {"content-type": "application/json"},
             ),
         ),
         (
@@ -125,6 +154,36 @@ boto3_bytes_headers = {
             request.Request("POST", "http://aws.custom.com/", b"123", boto3_bytes_headers),
             request.Request("POST", "http://aws.custom.com/", b"123", boto3_bytes_headers),
         ),
+        (
+            # chunked transfer encoding: decoded bytes versus encoded bytes
+            request.Request("POST", "scheme1://host1.test/", b"123456789_123456", chunked_headers),
+            request.Request(
+                "GET",
+                "scheme2://host2.test/",
+                b"10\r\n123456789_123456\r\n0\r\n\r\n",
+                chunked_headers,
+            ),
+        ),
+        (
+            # chunked transfer encoding: bytes iterator versus string iterator
+            request.Request(
+                "POST",
+                "scheme1://host1.test/",
+                iter([b"123456789_", b"123456"]),
+                chunked_headers,
+            ),
+            request.Request("GET", "scheme2://host2.test/", iter(["123456789_", "123456"]), chunked_headers),
+        ),
+        (
+            # chunked transfer encoding: bytes iterator versus single byte iterator
+            request.Request(
+                "POST",
+                "scheme1://host1.test/",
+                iter([b"123456789_", b"123456"]),
+                chunked_headers,
+            ),
+            request.Request("GET", "scheme2://host2.test/", iter(b"123456789_123456"), chunked_headers),
+        ),
     ],
 )
 def test_body_matcher_does_match(r1, r2):
@@ -140,10 +199,16 @@ def test_body_matcher_does_match(r1, r2):
         ),
         (
             request.Request(
-                "POST", "http://host.com/", '{"a": 1, "b": 3}', {"Content-Type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"a": 1, "b": 3}',
+                {"Content-Type": "application/json"},
             ),
             request.Request(
-                "POST", "http://host.com/", '{"b": 2, "a": 1}', {"content-type": "application/json"}
+                "POST",
+                "http://host.com/",
+                '{"b": 2, "a": 1}',
+                {"content-type": "application/json"},
             ),
         ),
         (

tests/unit/test_migration.py

@@ -1,6 +1,7 @@
 import filecmp
 import json
 import shutil
+
 import yaml
 
 import vcr.migration
@@ -16,9 +17,9 @@ def test_try_migrate_with_json(tmpdir):
     cassette = tmpdir.join("cassette.json").strpath
     shutil.copy("tests/fixtures/migration/old_cassette.json", cassette)
     assert vcr.migration.try_migrate(cassette)
-    with open("tests/fixtures/migration/new_cassette.json", "r") as f:
+    with open("tests/fixtures/migration/new_cassette.json") as f:
         expected_json = json.load(f)
-    with open(cassette, "r") as f:
+    with open(cassette) as f:
         actual_json = json.load(f)
     assert actual_json == expected_json
 
@@ -27,9 +28,9 @@ def test_try_migrate_with_yaml(tmpdir):
     cassette = tmpdir.join("cassette.yaml").strpath
     shutil.copy("tests/fixtures/migration/old_cassette.yaml", cassette)
     assert vcr.migration.try_migrate(cassette)
-    with open("tests/fixtures/migration/new_cassette.yaml", "r") as f:
+    with open("tests/fixtures/migration/new_cassette.yaml") as f:
         expected_yaml = yaml.load(f, Loader=Loader)
-    with open(cassette, "r") as f:
+    with open(cassette) as f:
         actual_yaml = yaml.load(f, Loader=Loader)
     assert actual_yaml == expected_yaml
 

tests/unit/test_request.py

@@ -1,6 +1,6 @@
 import pytest
 
-from vcr.request import Request, HeadersDict
+from vcr.request import HeadersDict, Request
 
 
 @pytest.mark.parametrize(
@@ -60,7 +60,6 @@ def test_uri(method, uri):
 
 
 def test_HeadersDict():
-
     # Simple test of CaseInsensitiveDict
     h = HeadersDict()
     assert h == {}

tests/unit/test_response.py

@@ -1,4 +1,3 @@
-# coding: UTF-8
 import io
 
 from vcr.stubs import VCRHTTPResponse
@@ -89,11 +88,11 @@ def test_response_parses_correctly_and_fp_attribute_error_is_not_thrown():
             b"different types of cancer cells. Recently, the first HDACi was\n      "
             b"approved for the "
             b"treatment of cutaneous T cell lymphomas. Most HDACi currently in\n      "
-            b"clinical "
+            b"clinical ",
         },
     }
     vcr_response = VCRHTTPResponse(recorded_response)
-    handle = io.TextIOWrapper(io.BufferedReader(vcr_response), encoding="utf-8")
+    handle = io.TextIOWrapper(vcr_response, encoding="utf-8")
     handle = iter(handle)
-    articles = [line for line in handle]
+    articles = list(handle)
     assert len(articles) > 1

tests/unit/test_serialize.py

@@ -1,32 +1,31 @@
-# -*- encoding: utf-8 -*-
 from unittest import mock
 
 import pytest
 
 from vcr.request import Request
 from vcr.serialize import deserialize, serialize
-from vcr.serializers import yamlserializer, jsonserializer, compat
+from vcr.serializers import compat, jsonserializer, yamlserializer
 
 
 def test_deserialize_old_yaml_cassette():
-    with open("tests/fixtures/migration/old_cassette.yaml", "r") as f:
+    with open("tests/fixtures/migration/old_cassette.yaml") as f:
         with pytest.raises(ValueError):
             deserialize(f.read(), yamlserializer)
 
 
 def test_deserialize_old_json_cassette():
-    with open("tests/fixtures/migration/old_cassette.json", "r") as f:
+    with open("tests/fixtures/migration/old_cassette.json") as f:
         with pytest.raises(ValueError):
             deserialize(f.read(), jsonserializer)
 
 
 def test_deserialize_new_yaml_cassette():
-    with open("tests/fixtures/migration/new_cassette.yaml", "r") as f:
+    with open("tests/fixtures/migration/new_cassette.yaml") as f:
         deserialize(f.read(), yamlserializer)
 
 
 def test_deserialize_new_json_cassette():
-    with open("tests/fixtures/migration/new_cassette.json", "r") as f:
+    with open("tests/fixtures/migration/new_cassette.json") as f:
         deserialize(f.read(), jsonserializer)
 
 

tests/unit/test_stubs.py

@@ -1,8 +1,11 @@
+import contextlib
 from unittest import mock
 
+from pytest import mark
+
 from vcr import mode
-from vcr.stubs import VCRHTTPSConnection
 from vcr.cassette import Cassette
+from vcr.stubs import VCRHTTPSConnection
 
 
 class TestVCRConnection:
@@ -11,9 +14,10 @@ class TestVCRConnection:
         vcr_connection.ssl_version = "example_ssl_version"
         assert vcr_connection.real_connection.ssl_version == "example_ssl_version"
 
+    @mark.online
     @mock.patch("vcr.cassette.Cassette.can_play_response_for", return_value=False)
     def testing_connect(*args):
-        vcr_connection = VCRHTTPSConnection("www.google.com")
-        vcr_connection.cassette = Cassette("test", record_mode=mode.ALL)
-        vcr_connection.real_connection.connect()
-        assert vcr_connection.real_connection.sock is not None
+        with contextlib.closing(VCRHTTPSConnection("www.google.com")) as vcr_connection:
+            vcr_connection.cassette = Cassette("test", record_mode=mode.ALL)
+            vcr_connection.real_connection.connect()
+            assert vcr_connection.real_connection.sock is not None

tests/unit/test_unittest.py

@@ -0,0 +1,199 @@
+import os
+from unittest import TextTestRunner, defaultTestLoader
+from unittest.mock import MagicMock
+from urllib.request import urlopen
+
+import pytest
+
+from vcr.unittest import VCRTestCase
+
+
+def test_defaults():
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+    test = run_testcase(MyTest)[0][0]
+    expected_path = os.path.join(os.path.dirname(__file__), "cassettes")
+    expected_name = "MyTest.test_foo.yaml"
+    assert os.path.dirname(test.cassette._path) == expected_path
+    assert os.path.basename(test.cassette._path) == expected_name
+
+
+def test_disabled():
+    # Baseline vcr_enabled = True
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+    test = run_testcase(MyTest)[0][0]
+    assert hasattr(test, "cassette")
+
+    # Test vcr_enabled = False
+    class MyTest(VCRTestCase):
+        vcr_enabled = False
+
+        def test_foo(self):
+            pass
+
+    test = run_testcase(MyTest)[0][0]
+    assert not hasattr(test, "cassette")
+
+
+def test_cassette_library_dir():
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_cassette_library_dir(self):
+            return "/testing"
+
+    test = run_testcase(MyTest)[0][0]
+    assert test.cassette._path.startswith("/testing/")
+
+
+def test_cassette_name():
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_cassette_name(self):
+            return "my-custom-name"
+
+    test = run_testcase(MyTest)[0][0]
+    assert os.path.basename(test.cassette._path) == "my-custom-name"
+
+
+def test_vcr_kwargs_overridden():
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_vcr_kwargs(self):
+            kwargs = super()._get_vcr_kwargs()
+            kwargs["record_mode"] = "new_episodes"
+            return kwargs
+
+    test = run_testcase(MyTest)[0][0]
+    assert test.cassette.record_mode == "new_episodes"
+
+
+def test_vcr_kwargs_passed():
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_vcr_kwargs(self):
+            return super()._get_vcr_kwargs(
+                record_mode="new_episodes",
+            )
+
+    test = run_testcase(MyTest)[0][0]
+    assert test.cassette.record_mode == "new_episodes"
+
+
+def test_vcr_kwargs_cassette_dir():
+    # Test that _get_cassette_library_dir applies if cassette_library_dir
+    # is absent from vcr kwargs.
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_vcr_kwargs(self):
+            return {
+                "record_mode": "new_episodes",
+            }
+
+        _get_cassette_library_dir = MagicMock(return_value="/testing")
+
+    test = run_testcase(MyTest)[0][0]
+    assert test.cassette._path.startswith("/testing/")
+    assert test._get_cassette_library_dir.call_count == 1
+
+    # Test that _get_cassette_library_dir is ignored if cassette_library_dir
+    # is present in vcr kwargs.
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            pass
+
+        def _get_vcr_kwargs(self):
+            return {
+                "cassette_library_dir": "/testing",
+            }
+
+        _get_cassette_library_dir = MagicMock(return_value="/ignored")
+
+    test = run_testcase(MyTest)[0][0]
+    assert test.cassette._path.startswith("/testing/")
+    assert test._get_cassette_library_dir.call_count == 0
+
+
+@pytest.mark.online
+def test_get_vcr_with_matcher(tmpdir):
+    cassette_dir = tmpdir.mkdir("cassettes")
+    assert len(cassette_dir.listdir()) == 0
+
+    mock_matcher = MagicMock(return_value=True, __name__="MockMatcher")
+
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            self.response = urlopen("http://example.com").read()
+
+        def _get_vcr(self):
+            myvcr = super()._get_vcr()
+            myvcr.register_matcher("mymatcher", mock_matcher)
+            myvcr.match_on = ["mymatcher"]
+            return myvcr
+
+        def _get_cassette_library_dir(self):
+            return str(cassette_dir)
+
+    # First run to fill cassette.
+    test = run_testcase(MyTest)[0][0]
+    assert len(test.cassette.requests) == 1
+    assert not mock_matcher.called  # nothing in cassette
+
+    # Second run to call matcher.
+    test = run_testcase(MyTest)[0][0]
+    assert len(test.cassette.requests) == 1
+    assert mock_matcher.called
+    assert (
+        repr(mock_matcher.mock_calls[0])
+        == "call(<Request (GET) http://example.com>, <Request (GET) http://example.com>)"
+    )
+
+
+@pytest.mark.online
+def test_testcase_playback(tmpdir):
+    cassette_dir = tmpdir.mkdir("cassettes")
+    assert len(cassette_dir.listdir()) == 0
+
+    # First test actually reads from the web.
+
+    class MyTest(VCRTestCase):
+        def test_foo(self):
+            self.response = urlopen("http://example.com").read()
+
+        def _get_cassette_library_dir(self):
+            return str(cassette_dir)
+
+    test = run_testcase(MyTest)[0][0]
+    assert b"illustrative examples" in test.response
+    assert len(test.cassette.requests) == 1
+    assert test.cassette.play_count == 0
+
+    # Second test reads from cassette.
+
+    test2 = run_testcase(MyTest)[0][0]
+    assert test.cassette is not test2.cassette
+    assert b"illustrative examples" in test.response
+    assert len(test2.cassette.requests) == 1
+    assert test2.cassette.play_count == 1
+
+
+def run_testcase(testcase_class):
+    """Run all the tests in a TestCase and return them."""
+    suite = defaultTestLoader.loadTestsFromTestCase(testcase_class)
+    tests = list(suite._tests)
+    result = TextTestRunner().run(suite)
+    return tests, result

tests/unit/test_vcr.py

@@ -1,20 +1,22 @@
-from unittest import mock
+import http.client as httplib
 import os
+from pathlib import Path
+from unittest import mock
 
 import pytest
-import http.client as httplib
 
 from vcr import VCR, mode, use_cassette
+from vcr.patch import _HTTPConnection, force_reset
 from vcr.request import Request
 from vcr.stubs import VCRHTTPSConnection
-from vcr.patch import _HTTPConnection, force_reset
 
 
 def test_vcr_use_cassette():
     record_mode = mock.Mock()
     test_vcr = VCR(record_mode=record_mode)
     with mock.patch(
-        "vcr.cassette.Cassette.load", return_value=mock.MagicMock(inject=False)
+        "vcr.cassette.Cassette.load",
+        return_value=mock.MagicMock(inject=False),
     ) as mock_cassette_load:
 
         @test_vcr.use_cassette("test")
@@ -40,7 +42,7 @@ def test_vcr_use_cassette():
 
 
 def test_vcr_before_record_request_params():
-    base_path = "http://httpbin.org/"
+    base_path = "http://whatever.test/"
 
     def before_record_cb(request):
         if request.path != "/get":
@@ -70,16 +72,19 @@ def test_vcr_before_record_request_params():
 
         # Test filter_headers
         request = Request(
-            "GET", base_path + "?foo=bar", "", {"cookie": "test", "other": "fun", "bert": "nobody"}
+            "GET",
+            base_path + "?foo=bar",
+            "",
+            {"cookie": "test", "other": "fun", "bert": "nobody"},
         )
         assert cassette.filter_request(request).headers == {"other": "fun", "bert": "ernie"}
 
         # Test ignore_hosts
-        request = Request("GET", "http://www.test.com" + "?foo=bar", "", {"cookie": "test", "other": "fun"})
+        request = Request("GET", "http://www.test.com?foo=bar", "", {"cookie": "test", "other": "fun"})
         assert cassette.filter_request(request) is None
 
         # Test ignore_localhost
-        request = Request("GET", "http://localhost:8000" + "?foo=bar", "", {"cookie": "test", "other": "fun"})
+        request = Request("GET", "http://localhost:8000?foo=bar", "", {"cookie": "test", "other": "fun"})
         assert cassette.filter_request(request) is None
 
     with test_vcr.use_cassette("test", before_record_request=None) as cassette:
@@ -95,7 +100,6 @@ def test_vcr_before_record_response_iterable():
 
     # Prevent actually saving the cassette
     with mock.patch("vcr.cassette.FilesystemPersister.save_cassette"):
-
         # Baseline: non-iterable before_record_response should work
         mock_filter = mock.Mock()
         vcr = VCR(before_record_response=mock_filter)
@@ -119,7 +123,6 @@ def test_before_record_response_as_filter():
 
     # Prevent actually saving the cassette
     with mock.patch("vcr.cassette.FilesystemPersister.save_cassette"):
-
         filter_all = mock.Mock(return_value=None)
         vcr = VCR(before_record_response=filter_all)
         with vcr.use_cassette("test") as cassette:
@@ -133,7 +136,6 @@ def test_vcr_path_transformer():
 
     # Prevent actually saving the cassette
     with mock.patch("vcr.cassette.FilesystemPersister.save_cassette"):
-
         # Baseline: path should be unchanged
         vcr = VCR()
         with vcr.use_cassette("test") as cassette:
@@ -261,7 +263,9 @@ def test_cassette_library_dir_with_decoration_and_super_explicit_path():
 def test_cassette_library_dir_with_path_transformer():
     library_dir = "/library_dir"
     vcr = VCR(
-        inject_cassette=True, cassette_library_dir=library_dir, path_transformer=lambda path: path + ".json"
+        inject_cassette=True,
+        cassette_library_dir=library_dir,
+        path_transformer=lambda path: path + ".json",
     )
 
     @vcr.use_cassette()
@@ -360,3 +364,11 @@ def test_dynamically_added(self):
 
 TestVCRClass.test_dynamically_added = test_dynamically_added
 del test_dynamically_added
+
+
+def test_path_class_as_cassette():
+    path = Path(__file__).parent.parent.joinpath(
+        "integration/cassettes/test_httpx_test_test_behind_proxy.yml",
+    )
+    with use_cassette(path):
+        pass

tests/unit/test_vcr_import.py

@@ -2,15 +2,10 @@ import sys
 
 
 def test_vcr_import_deprecation(recwarn):
-
     if "vcr" in sys.modules:
         # Remove imported module entry if already loaded in another test
         del sys.modules["vcr"]
 
     import vcr  # noqa: F401
 
-    if sys.version_info[0] == 2:
-        assert len(recwarn) == 1
-        assert issubclass(recwarn[0].category, DeprecationWarning)
-    else:
-        assert len(recwarn) == 0
+    assert len(recwarn) == 0

tox.ini

@@ -1,105 +0,0 @@
-[tox]
-skip_missing_interpreters=true
-envlist =
-  cov-clean,
-  lint,
-  {py37,py38,py39,py310}-{requests,httplib2,urllib3,tornado4,boto3,aiohttp,httpx},
-  {pypy3}-{requests,httplib2,urllib3,tornado4,boto3},
-  {py310}-httpx019,
-  cov-report
-
-
-[gh-actions]
-python =
-    3.7: py37, lint
-    3.8: py38
-    3.9: py39
-    3.10: py310
-    pypy-3: pypy3
-
-# Coverage environment tasks: cov-clean and cov-report
-# https://pytest-cov.readthedocs.io/en/latest/tox.html
-[testenv:cov-clean]
-deps = coverage
-skip_install=true
-commands = coverage erase
-
-[testenv:cov-report]
-deps = coverage
-skip_install=true
-commands =
-  coverage html
-  coverage report --fail-under=90
-
-[testenv:lint]
-skipsdist = True
-commands =
-    black --version
-    black --check --diff .
-    flake8 --version
-    flake8 --exclude=./docs/conf.py,./.tox/
-    pyflakes ./docs/conf.py
-deps =
-  flake8
-  black
-basepython = python3.7
-
-[testenv:docs]
-# Running sphinx from inside the "docs" directory
-# ensures it will not pick up any stray files that might
-# get into a virtual environment under the top-level directory
-# or other artifacts under build/
-changedir = docs
-# The only dependency is sphinx
-# If we were using extensions packaged separately,
-# we would specify them here.
-# A better practice is to specify a specific version of sphinx.
-deps =
-    sphinx
-    sphinx_rtd_theme
-# This is the sphinx command to generate HTML.
-# In other circumstances, we might want to generate a PDF or an ebook
-commands =
-    sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
-# We use Python 3.7. Tox sometimes tries to autodetect it based on the name of
-# the testenv, but "docs" does not give useful clues so we have to be explicit.
-basepython = python3.7
-
-[testenv]
-# Need to use develop install so that paths
-# for aggregate code coverage combine
-usedevelop=true
-commands =
-    ./runtests.sh --cov=./vcr --cov-branch --cov-report=xml --cov-append {posargs}
-deps =
-    Werkzeug==2.0.3
-    pytest
-    git+https://github.com/immerrr/pytest-httpbin@fix-redirect-location-scheme-for-secure-server
-    pytest-cov
-    PyYAML
-    ipaddress
-    requests: requests>=2.22.0
-    httplib2: httplib2
-    urllib3: urllib3
-    boto3: boto3
-    boto3: urllib3
-    aiohttp: aiohttp
-    aiohttp: pytest-asyncio
-    aiohttp: pytest-aiohttp
-    httpx: httpx
-    {py37,py38,py39,py310}-{httpx}: httpx
-    {py37,py38,py39,py310}-{httpx}: pytest-asyncio
-    httpx: httpx>0.19
-    # httpx==0.19 is the latest version that supports allow_redirects, newer versions use follow_redirects
-    httpx019: httpx==0.19
-    {py37,py38,py39,py310}-{httpx}: pytest-asyncio
-depends =
-  lint,{py37,py38,py39,py310,pypy3}-{requests,httplib2,urllib3,tornado4,boto3},{py37,py38,py39,py310}-{aiohttp},{py37,py38,py39,py310}-{httpx}: cov-clean
-  cov-report: lint,{py37,py38,py39,py310,pypy3}-{requests,httplib2,urllib3,tornado4,boto3},{py37,py38,py39,py310}-{aiohttp}
-passenv =
-    AWS_ACCESS_KEY_ID
-    AWS_DEFAULT_REGION
-    AWS_SECRET_ACCESS_KEY
-
-[flake8]
-max_line_length = 110

vcr/__init__.py

@@ -1,9 +1,10 @@
 import logging
-from .config import VCR
 from logging import NullHandler
-from .record_mode import RecordMode as mode  # noqa import is not used in this file
 
-__version__ = "4.2.0"
+from .config import VCR
+from .record_mode import RecordMode as mode  # noqa: F401
+
+__version__ = "6.0.0"
 
 logging.getLogger(__name__).addHandler(NullHandler())
 

vcr/_handle_coroutine.py

@@ -1,3 +1,3 @@
-async def handle_coroutine(vcr, fn):  # noqa: E999
+async def handle_coroutine(vcr, fn):
     with vcr as cassette:
-        return await fn(cassette)  # noqa: E999
+        return await fn(cassette)

vcr/cassette.py

@@ -1,28 +1,20 @@
 import collections
 import contextlib
 import copy
-import sys
 import inspect
 import logging
+from asyncio import iscoroutinefunction
 
 import wrapt
 
-from .errors import UnhandledHTTPRequestError
-from .matchers import requests_match, uri, method, get_matchers_results
-from .patch import CassettePatcherBuilder
-from .serializers import yamlserializer
-from .persisters.filesystem import FilesystemPersister
-from .util import partition_dict
 from ._handle_coroutine import handle_coroutine
+from .errors import UnhandledHTTPRequestError
+from .matchers import get_matchers_results, method, requests_match, uri
+from .patch import CassettePatcherBuilder
+from .persisters.filesystem import CassetteDecodeError, CassetteNotFoundError, FilesystemPersister
 from .record_mode import RecordMode
-
-try:
-    from asyncio import iscoroutinefunction
-except ImportError:
-
-    def iscoroutinefunction(*args, **kwargs):
-        return False
-
+from .serializers import yamlserializer
+from .util import partition_dict
 
 log = logging.getLogger(__name__)
 
@@ -45,7 +37,11 @@ class CassetteContextDecorator:
     this class as a context manager in ``__exit__``.
     """
 
-    _non_cassette_arguments = ("path_transformer", "func_path_generator")
+    _non_cassette_arguments = (
+        "path_transformer",
+        "func_path_generator",
+        "record_on_exception",
+    )
 
     @classmethod
     def from_args(cls, cassette_class, **kwargs):
@@ -55,6 +51,7 @@ class CassetteContextDecorator:
         self.cls = cls
         self._args_getter = args_getter
         self.__finish = None
+        self.__cassette = None
 
     def _patch_generator(self, cassette):
         with contextlib.ExitStack() as exit_stack:
@@ -64,9 +61,6 @@ class CassetteContextDecorator:
             log.debug(log_format.format(action="Entering", path=cassette._path))
             yield cassette
             log.debug(log_format.format(action="Exiting", path=cassette._path))
-            # TODO(@IvanMalison): Hmmm. it kind of feels like this should be
-            # somewhere else.
-            cassette._save()
 
     def __enter__(self):
         # This assertion is here to prevent the dangerous behavior
@@ -79,15 +73,28 @@ class CassetteContextDecorator:
         #         pass
         assert self.__finish is None, "Cassette already open."
         other_kwargs, cassette_kwargs = partition_dict(
-            lambda key, _: key in self._non_cassette_arguments, self._args_getter()
+            lambda key, _: key in self._non_cassette_arguments,
+            self._args_getter(),
         )
         if other_kwargs.get("path_transformer"):
             transformer = other_kwargs["path_transformer"]
             cassette_kwargs["path"] = transformer(cassette_kwargs["path"])
-        self.__finish = self._patch_generator(self.cls.load(**cassette_kwargs))
+        self.__cassette = self.cls.load(**cassette_kwargs)
+        self.__finish = self._patch_generator(self.__cassette)
         return next(self.__finish)
 
-    def __exit__(self, *args):
+    def __exit__(self, *exc_info):
+        exception_was_raised = any(exc_info)
+        record_on_exception = self._args_getter().get("record_on_exception", True)
+        if record_on_exception or not exception_was_raised:
+            self.__cassette._save()
+            self.__cassette = None
+        # Fellow programmer, don't remove this `next`, if `self.__finish` is
+        # not consumed the unpatcher functions accumulated in the `exit_stack`
+        # object created in `_patch_generator` will not be called until
+        # `exit_stack` is not garbage collected.
+        # This works in CPython but not in Pypy, where the unpatchers will not
+        # be called until much later.
         next(self.__finish, None)
         self.__finish = None
 
@@ -118,20 +125,7 @@ class CassetteContextDecorator:
         duration of the generator.
         """
         with self as cassette:
-            coroutine = fn(cassette)
-            # We don't need to catch StopIteration. The caller (Tornado's
-            # gen.coroutine, for example) will handle that.
-            to_yield = next(coroutine)
-            while True:
-                try:
-                    to_send = yield to_yield
-                except Exception:
-                    to_yield = coroutine.throw(*sys.exc_info())
-                else:
-                    try:
-                        to_yield = coroutine.send(to_send)
-                    except StopIteration:
-                        break
+            yield from fn(cassette)
 
     def _handle_function(self, fn):
         with self as cassette:
@@ -266,7 +260,7 @@ class Cassette:
                 return response
         # The cassette doesn't contain the request asked for.
         raise UnhandledHTTPRequestError(
-            "The cassette (%r) doesn't contain the request (%r) asked for" % (self._path, request)
+            f"The cassette ({self._path!r}) doesn't contain the request ({request!r}) asked for",
         )
 
     def responses_of(self, request):
@@ -281,7 +275,7 @@ class Cassette:
             return responses
         # The cassette doesn't contain the request asked for.
         raise UnhandledHTTPRequestError(
-            "The cassette (%r) doesn't contain the request (%r) asked for" % (self._path, request)
+            f"The cassette ({self._path!r}) doesn't contain the request ({request!r}) asked for",
         )
 
     def rewind(self):
@@ -300,7 +294,7 @@ class Cassette:
         """
         best_matches = []
         request = self._before_record_request(request)
-        for index, (stored_request, response) in enumerate(self.data):
+        for _, (stored_request, _) in enumerate(self.data):
             successes, fails = get_matchers_results(request, stored_request, self._match_on)
             best_matches.append((len(successes), stored_request, successes, fails))
         best_matches.sort(key=lambda t: t[0], reverse=True)
@@ -338,11 +332,11 @@ class Cassette:
                 self.append(request, response)
             self.dirty = False
             self.rewound = True
-        except ValueError:
+        except (CassetteDecodeError, CassetteNotFoundError):
             pass
 
     def __str__(self):
-        return "<Cassette containing {} recorded response(s)>".format(len(self))
+        return f"<Cassette containing {len(self)} recorded response(s)>"
 
     def __len__(self):
         """Return the number of request,response pairs stored in here"""
@@ -350,7 +344,7 @@ class Cassette:
 
     def __contains__(self, request):
         """Return whether or not a request has been stored"""
-        for index, response in self._responses(request):
+        for index, _ in self._responses(request):
             if self.play_counts[index] == 0 or self.allow_playback_repeats:
                 return True
         return False

vcr/config.py

@@ -1,20 +1,17 @@
 import copy
-
-from collections import abc as collections_abc
 import functools
 import inspect
 import os
 import types
+from collections import abc as collections_abc
+from pathlib import Path
 
-import six
-
+from . import filters, matchers
 from .cassette import Cassette
-from .serializers import yamlserializer, jsonserializer
 from .persisters.filesystem import FilesystemPersister
-from .util import compose, auto_decorate
 from .record_mode import RecordMode
-from . import matchers
-from . import filters
+from .serializers import jsonserializer, yamlserializer
+from .util import auto_decorate, compose
 
 
 class VCR:
@@ -50,6 +47,7 @@ class VCR:
         cassette_library_dir=None,
         func_path_generator=None,
         decode_compressed_response=False,
+        record_on_exception=True,
     ):
         self.serializer = serializer
         self.match_on = match_on
@@ -81,13 +79,14 @@ class VCR:
         self.path_transformer = path_transformer
         self.func_path_generator = func_path_generator
         self.decode_compressed_response = decode_compressed_response
+        self.record_on_exception = record_on_exception
         self._custom_patches = tuple(custom_patches)
 
     def _get_serializer(self, serializer_name):
         try:
             serializer = self.serializers[serializer_name]
         except KeyError:
-            raise KeyError("Serializer {} doesn't exist or isn't registered".format(serializer_name))
+            raise KeyError(f"Serializer {serializer_name} doesn't exist or isn't registered") from None
         return serializer
 
     def _get_matchers(self, matcher_names):
@@ -96,11 +95,11 @@ class VCR:
             for m in matcher_names:
                 matchers.append(self.matchers[m])
         except KeyError:
-            raise KeyError("Matcher {} doesn't exist or isn't registered".format(m))
+            raise KeyError(f"Matcher {m} doesn't exist or isn't registered") from None
         return matchers
 
     def use_cassette(self, path=None, **kwargs):
-        if path is not None and not isinstance(path, str):
+        if path is not None and not isinstance(path, (str, Path)):
             function = path
             # Assume this is an attempt to decorate a function
             return self._use_cassette(**kwargs)(function)
@@ -124,6 +123,7 @@ class VCR:
         func_path_generator = kwargs.get("func_path_generator", self.func_path_generator)
         cassette_library_dir = kwargs.get("cassette_library_dir", self.cassette_library_dir)
         additional_matchers = kwargs.get("additional_matchers", ())
+        record_on_exception = kwargs.get("record_on_exception", self.record_on_exception)
 
         if cassette_library_dir:
 
@@ -150,6 +150,7 @@ class VCR:
             "path_transformer": path_transformer,
             "func_path_generator": func_path_generator,
             "allow_playback_repeats": kwargs.get("allow_playback_repeats", False),
+            "record_on_exception": record_on_exception,
         }
         path = kwargs.get("path")
         if path:
@@ -159,7 +160,8 @@ class VCR:
     def _build_before_record_response(self, options):
         before_record_response = options.get("before_record_response", self.before_record_response)
         decode_compressed_response = options.get(
-            "decode_compressed_response", self.decode_compressed_response
+            "decode_compressed_response",
+            self.decode_compressed_response,
         )
         filter_functions = []
         if decode_compressed_response:
@@ -183,10 +185,12 @@ class VCR:
         filter_headers = options.get("filter_headers", self.filter_headers)
         filter_query_parameters = options.get("filter_query_parameters", self.filter_query_parameters)
         filter_post_data_parameters = options.get(
-            "filter_post_data_parameters", self.filter_post_data_parameters
+            "filter_post_data_parameters",
+            self.filter_post_data_parameters,
         )
         before_record_request = options.get(
-            "before_record_request", options.get("before_record", self.before_record_request)
+            "before_record_request",
+            options.get("before_record", self.before_record_request),
         )
         ignore_hosts = options.get("ignore_hosts", self.ignore_hosts)
         ignore_localhost = options.get("ignore_localhost", self.ignore_localhost)
@@ -196,12 +200,12 @@ class VCR:
         if filter_query_parameters:
             replacements = [p if isinstance(p, tuple) else (p, None) for p in filter_query_parameters]
             filter_functions.append(
-                functools.partial(filters.replace_query_parameters, replacements=replacements)
+                functools.partial(filters.replace_query_parameters, replacements=replacements),
             )
         if filter_post_data_parameters:
             replacements = [p if isinstance(p, tuple) else (p, None) for p in filter_post_data_parameters]
             filter_functions.append(
-                functools.partial(filters.replace_post_data_parameters, replacements=replacements)
+                functools.partial(filters.replace_post_data_parameters, replacements=replacements),
             )
 
         hosts_to_ignore = set(ignore_hosts)
@@ -216,7 +220,7 @@ class VCR:
             filter_functions.extend(before_record_request)
 
         def before_record_request(request):
-            request = copy.copy(request)
+            request = copy.deepcopy(request)
             for function in filter_functions:
                 if request is None:
                     break
@@ -250,5 +254,5 @@ class VCR:
 
     def test_case(self, predicate=None):
         predicate = predicate or self.is_test_method
-        # TODO: Remove this reference to `six` in favor of the Python3 equivalent
-        return six.with_metaclass(auto_decorate(self.use_cassette, predicate))
+        metaclass = auto_decorate(self.use_cassette, predicate)
+        return metaclass("temporary_class", (), {})

vcr/errors.py

@@ -13,30 +13,29 @@ class CannotOverwriteExistingCassetteException(Exception):
         best_matches = cassette.find_requests_with_most_matches(failed_request)
         if best_matches:
             # Build a comprehensible message to put in the exception.
-            best_matches_msg = "Found {} similar requests with {} different matcher(s) :\n".format(
-                len(best_matches), len(best_matches[0][2])
+            best_matches_msg = (
+                f"Found {len(best_matches)} similar requests "
+                f"with {len(best_matches[0][2])} different matcher(s) :\n"
             )
 
             for idx, best_match in enumerate(best_matches, start=1):
                 request, succeeded_matchers, failed_matchers_assertion_msgs = best_match
                 best_matches_msg += (
-                    "\n%s - (%r).\n"
-                    "Matchers succeeded : %s\n"
-                    "Matchers failed :\n" % (idx, request, succeeded_matchers)
+                    f"\n{idx} - ({request!r}).\n"
+                    f"Matchers succeeded : {succeeded_matchers}\n"
+                    "Matchers failed :\n"
                 )
                 for failed_matcher, assertion_msg in failed_matchers_assertion_msgs:
-                    best_matches_msg += "%s - assertion failure :\n" "%s\n" % (failed_matcher, assertion_msg)
+                    best_matches_msg += f"{failed_matcher} - assertion failure :\n{assertion_msg}\n"
         else:
             best_matches_msg = "No similar requests, that have not been played, found."
         return (
-            "Can't overwrite existing cassette (%r) in "
-            "your current record mode (%r).\n"
-            "No match for the request (%r) was found.\n"
-            "%s" % (cassette._path, cassette.record_mode, failed_request, best_matches_msg)
+            f"Can't overwrite existing cassette ({cassette._path!r}) in "
+            f"your current record mode ({cassette.record_mode!r}).\n"
+            f"No match for the request ({failed_request!r}) was found.\n"
+            f"{best_matches_msg}"
         )
 
 
 class UnhandledHTTPRequestError(KeyError):
     """Raised when a cassette does not contain the request we want."""
-
-    pass

vcr/filters.py

@@ -1,8 +1,8 @@
-from io import BytesIO
-from urllib.parse import urlparse, urlencode, urlunparse
 import copy
 import json
 import zlib
+from io import BytesIO
+from urllib.parse import urlencode, urlparse, urlunparse
 
 from .util import CaseInsensitiveDict
 
@@ -95,7 +95,7 @@ def replace_post_data_parameters(request, replacements):
                         new_body[k] = rv
             request.body = new_body
         elif request.headers.get("Content-Type") == "application/json":
-            json_data = json.loads(request.body.decode("utf-8"))
+            json_data = json.loads(request.body)
             for k, rv in replacements.items():
                 if k in json_data:
                     ov = json_data.pop(k)
@@ -150,10 +150,18 @@ def decode_response(response):
         """Returns decompressed body according to encoding using zlib.
         to (de-)compress gzip format, use wbits = zlib.MAX_WBITS | 16
         """
+        if not body:
+            return ""
         if encoding == "gzip":
-            return zlib.decompress(body, zlib.MAX_WBITS | 16)
+            try:
+                return zlib.decompress(body, zlib.MAX_WBITS | 16)
+            except zlib.error:
+                return body  # assumes that the data was already decompressed
         else:  # encoding == 'deflate'
-            return zlib.decompress(body)
+            try:
+                return zlib.decompress(body)
+            except zlib.error:
+                return body  # assumes that the data was already decompressed
 
     # Deepcopy here in case `headers` contain objects that could
     # be mutated by a shallow copy and corrupt the real response.

vcr/matchers.py

@@ -1,55 +1,75 @@
 import json
+import logging
 import urllib
 import xmlrpc.client
-from .util import read_body
-import logging
+from string import hexdigits
+from typing import List, Set
 
+from .util import read_body
+
+_HEXDIG_CODE_POINTS: Set[int] = {ord(s.encode("ascii")) for s in hexdigits}
 
 log = logging.getLogger(__name__)
 
 
 def method(r1, r2):
-    assert r1.method == r2.method, "{} != {}".format(r1.method, r2.method)
+    if r1.method != r2.method:
+        raise AssertionError(f"{r1.method} != {r2.method}")
 
 
 def uri(r1, r2):
-    assert r1.uri == r2.uri, "{} != {}".format(r1.uri, r2.uri)
+    if r1.uri != r2.uri:
+        raise AssertionError(f"{r1.uri} != {r2.uri}")
 
 
 def host(r1, r2):
-    assert r1.host == r2.host, "{} != {}".format(r1.host, r2.host)
+    if r1.host != r2.host:
+        raise AssertionError(f"{r1.host} != {r2.host}")
 
 
 def scheme(r1, r2):
-    assert r1.scheme == r2.scheme, "{} != {}".format(r1.scheme, r2.scheme)
+    if r1.scheme != r2.scheme:
+        raise AssertionError(f"{r1.scheme} != {r2.scheme}")
 
 
 def port(r1, r2):
-    assert r1.port == r2.port, "{} != {}".format(r1.port, r2.port)
+    if r1.port != r2.port:
+        raise AssertionError(f"{r1.port} != {r2.port}")
 
 
 def path(r1, r2):
-    assert r1.path == r2.path, "{} != {}".format(r1.path, r2.path)
+    if r1.path != r2.path:
+        raise AssertionError(f"{r1.path} != {r2.path}")
 
 
 def query(r1, r2):
-    assert r1.query == r2.query, "{} != {}".format(r1.query, r2.query)
+    if r1.query != r2.query:
+        raise AssertionError(f"{r1.query} != {r2.query}")
 
 
 def raw_body(r1, r2):
-    assert read_body(r1) == read_body(r2)
+    if read_body(r1) != read_body(r2):
+        raise AssertionError
 
 
 def body(r1, r2):
-    transformer = _get_transformer(r1)
-    r2_transformer = _get_transformer(r2)
-    if transformer != r2_transformer:
-        transformer = _identity
-    assert transformer(read_body(r1)) == transformer(read_body(r2))
+    transformers = list(_get_transformers(r1))
+    if transformers != list(_get_transformers(r2)):
+        transformers = []
+
+    b1 = read_body(r1)
+    b2 = read_body(r2)
+    for transform in transformers:
+        b1 = transform(b1)
+        b2 = transform(b2)
+
+    if b1 != b2:
+        raise AssertionError
 
 
 def headers(r1, r2):
-    assert r1.headers == r2.headers, "{} != {}".format(r1.headers, r2.headers)
+    if r1.headers != r2.headers:
+        raise AssertionError(f"{r1.headers} != {r2.headers}")
 
 
 def _header_checker(value, header="Content-Type"):
@@ -62,17 +82,71 @@ def _header_checker(value, header="Content-Type"):
     return checker
 
 
+def _dechunk(body):
+    if isinstance(body, str):
+        body = body.encode("utf-8")
+    elif isinstance(body, bytearray):
+        body = bytes(body)
+    elif hasattr(body, "__iter__"):
+        body = list(body)
+        if body:
+            if isinstance(body[0], str):
+                body = ("".join(body)).encode("utf-8")
+            elif isinstance(body[0], bytes):
+                body = b"".join(body)
+            elif isinstance(body[0], int):
+                body = bytes(body)
+            else:
+                raise ValueError(f"Body chunk type {type(body[0])} not supported")
+        else:
+            body = None
+
+    if not isinstance(body, bytes):
+        return body
+
+    # Now decode chunked data format (https://en.wikipedia.org/wiki/Chunked_transfer_encoding)
+    # Example input: b"45\r\n<69 bytes>\r\n0\r\n\r\n" where int(b"45", 16) == 69.
+    CHUNK_GAP = b"\r\n"
+    BODY_LEN: int = len(body)
+
+    chunks: List[bytes] = []
+    pos: int = 0
+
+    while True:
+        for i in range(pos, BODY_LEN):
+            if body[i] not in _HEXDIG_CODE_POINTS:
+                break
+
+        if i == 0 or body[i : i + len(CHUNK_GAP)] != CHUNK_GAP:
+            if pos == 0:
+                return body  # i.e. assume non-chunk data
+            raise ValueError("Malformed chunked data")
+
+        size_bytes = int(body[pos:i], 16)
+        if size_bytes == 0:  # i.e. well-formed ending
+            return b"".join(chunks)
+
+        chunk_data_first = i + len(CHUNK_GAP)
+        chunk_data_after_last = chunk_data_first + size_bytes
+
+        if body[chunk_data_after_last : chunk_data_after_last + len(CHUNK_GAP)] != CHUNK_GAP:
+            raise ValueError("Malformed chunked data")
+
+        chunk_data = body[chunk_data_first:chunk_data_after_last]
+        chunks.append(chunk_data)
+
+        pos = chunk_data_after_last + len(CHUNK_GAP)
+
+
 def _transform_json(body):
-    # Request body is always a byte string, but json.loads() wants a text
-    # string. RFC 7159 says the default encoding is UTF-8 (although UTF-16
-    # and UTF-32 are also allowed: hmmmmm).
     if body:
-        return json.loads(body.decode("utf-8"))
+        return json.loads(body)
 
 
 _xml_header_checker = _header_checker("text/xml")
 _xmlrpc_header_checker = _header_checker("xmlrpc", header="User-Agent")
 _checker_transformer_pairs = (
+    (_header_checker("chunked", header="Transfer-Encoding"), _dechunk),
     (
         _header_checker("application/x-www-form-urlencoded"),
         lambda body: urllib.parse.parse_qs(body.decode("ascii")),
@@ -82,22 +156,16 @@ _checker_transformer_pairs = (
 )
 
 
-def _identity(x):
-    return x
-
-
-def _get_transformer(request):
+def _get_transformers(request):
     for checker, transformer in _checker_transformer_pairs:
         if checker(request.headers):
-            return transformer
-    else:
-        return _identity
+            yield transformer
 
 
 def requests_match(r1, r2, matchers):
     successes, failures = get_matchers_results(r1, r2, matchers)
     if failures:
-        log.debug("Requests {} and {} differ.\n" "Failure details:\n" "{}".format(r1, r2, failures))
+        log.debug(f"Requests {r1} and {r2} differ.\nFailure details:\n{failures}")
     return len(failures) == 0
 
 

vcr/migration.py

@@ -7,7 +7,7 @@ It merges and deletes the request obsolete keys (protocol, host, port, path)
 into new 'uri' key.
 Usage::
 
-    python -m vcr.migration PATH
+    python3 -m vcr.migration PATH
 
 The PATH can be path to the directory with cassettes or cassette itself
 """
@@ -17,11 +17,12 @@ import os
 import shutil
 import sys
 import tempfile
+
 import yaml
 
-from .serializers import yamlserializer, jsonserializer
-from .serialize import serialize
 from . import request
+from .serialize import serialize
+from .serializers import jsonserializer, yamlserializer
 from .stubs.compat import get_httpmessage
 
 # Use the libYAML versions if possible
@@ -54,7 +55,7 @@ def build_uri(**parts):
     port = parts["port"]
     scheme = parts["protocol"]
     default_port = {"https": 443, "http": 80}[scheme]
-    parts["port"] = ":{}".format(port) if port != default_port else ""
+    parts["port"] = f":{port}" if port != default_port else ""
     return "{protocol}://{host}{port}{path}".format(**parts)
 
 
@@ -91,7 +92,7 @@ def migrate_json(in_fp, out_fp):
 
 
 def _list_of_tuples_to_dict(fs):
-    return {k: v for k, v in fs[0]}
+    return dict(fs[0])
 
 
 def _already_migrated(data):
@@ -117,7 +118,7 @@ def migrate(file_path, migration_fn):
     # because we assume that original files can be reverted
     # we will try to copy the content. (os.rename not needed)
     with tempfile.TemporaryFile(mode="w+") as out_fp:
-        with open(file_path, "r") as in_fp:
+        with open(file_path) as in_fp:
             if not migration_fn(in_fp, out_fp):
                 return False
         with open(file_path, "w") as in_fp:
@@ -129,7 +130,7 @@ def migrate(file_path, migration_fn):
 def try_migrate(path):
     if path.endswith(".json"):
         return migrate(path, migrate_json)
-    elif path.endswith(".yaml") or path.endswith(".yml"):
+    elif path.endswith((".yaml", ".yml")):
         return migrate(path, migrate_yml)
     return False
 
@@ -137,7 +138,7 @@ def try_migrate(path):
 def main():
     if len(sys.argv) != 2:
         raise SystemExit(
-            "Please provide path to cassettes directory or file. " "Usage: python -m vcr.migration PATH"
+            "Please provide path to cassettes directory or file. Usage: python3 -m vcr.migration PATH",
         )
 
     path = sys.argv[1]
@@ -149,7 +150,7 @@ def main():
     for file_path in files:
         migrated = try_migrate(file_path)
         status = "OK" if migrated else "FAIL"
-        sys.stderr.write("[{}] {}\n".format(status, file_path))
+        sys.stderr.write(f"[{status}] {file_path}\n")
     sys.stderr.write("Done.\n")
 
 

vcr/patch.py

@@ -1,13 +1,12 @@
 """Utilities for patching in cassettes"""
 import contextlib
 import functools
+import http.client as httplib
 import itertools
+import logging
 from unittest import mock
 
 from .stubs import VCRHTTPConnection, VCRHTTPSConnection
-import http.client as httplib
-
-import logging
 
 log = logging.getLogger(__name__)
 # Save some of the original types for the purposes of unpatching
@@ -16,42 +15,47 @@ _HTTPSConnection = httplib.HTTPSConnection
 
 # Try to save the original types for boto3
 try:
-    from botocore.awsrequest import AWSHTTPSConnection, AWSHTTPConnection
-except ImportError:
+    from botocore.awsrequest import AWSHTTPConnection, AWSHTTPSConnection
+except ImportError as e:
     try:
-        import botocore.vendored.requests.packages.urllib3.connectionpool as cpool
+        import botocore.vendored.requests  # noqa: F401
     except ImportError:  # pragma: no cover
         pass
     else:
-        _Boto3VerifiedHTTPSConnection = cpool.VerifiedHTTPSConnection
-        _cpoolBoto3HTTPConnection = cpool.HTTPConnection
-        _cpoolBoto3HTTPSConnection = cpool.HTTPSConnection
+        raise RuntimeError(
+            "vcrpy >=4.2.2 and botocore <1.11.0 are not compatible"
+            "; please upgrade botocore (or downgrade vcrpy)",
+        ) from e
 else:
     _Boto3VerifiedHTTPSConnection = AWSHTTPSConnection
     _cpoolBoto3HTTPConnection = AWSHTTPConnection
     _cpoolBoto3HTTPSConnection = AWSHTTPSConnection
 
 cpool = None
+conn = None
 # Try to save the original types for urllib3
 try:
+    import urllib3.connection as conn
     import urllib3.connectionpool as cpool
 except ImportError:  # pragma: no cover
     pass
 else:
-    _VerifiedHTTPSConnection = cpool.VerifiedHTTPSConnection
-    _cpoolHTTPConnection = cpool.HTTPConnection
-    _cpoolHTTPSConnection = cpool.HTTPSConnection
+    _VerifiedHTTPSConnection = conn.VerifiedHTTPSConnection
+    _connHTTPConnection = conn.HTTPConnection
+    _connHTTPSConnection = conn.HTTPSConnection
 
 # Try to save the original types for requests
 try:
-    if not cpool:
-        import requests.packages.urllib3.connectionpool as cpool
+    import requests
 except ImportError:  # pragma: no cover
     pass
 else:
-    _VerifiedHTTPSConnection = cpool.VerifiedHTTPSConnection
-    _cpoolHTTPConnection = cpool.HTTPConnection
-    _cpoolHTTPSConnection = cpool.HTTPSConnection
+    if requests.__build__ < 0x021602:
+        raise RuntimeError(
+            "vcrpy >=4.2.2 and requests <2.16.2 are not compatible"
+            "; please upgrade requests (or downgrade vcrpy)",
+        )
+
 
 # Try to save the original types for httplib2
 try:
@@ -63,14 +67,6 @@ else:
     _HTTPSConnectionWithTimeout = httplib2.HTTPSConnectionWithTimeout
     _SCHEME_TO_CONNECTION = httplib2.SCHEME_TO_CONNECTION
 
-# Try to save the original types for boto
-try:
-    import boto.https_connection
-except ImportError:  # pragma: no cover
-    pass
-else:
-    _CertValidatingHTTPSConnection = boto.https_connection.CertValidatingHTTPSConnection
-
 # Try to save the original types for Tornado
 try:
     import tornado.simple_httpclient
@@ -99,8 +95,8 @@ try:
 except ImportError:  # pragma: no cover
     pass
 else:
-    _HttpxSyncClient_send = httpx.Client.send
-    _HttpxAsyncClient_send = httpx.AsyncClient.send
+    _HttpxSyncClient_send_single_request = httpx.Client._send_single_request
+    _HttpxAsyncClient_send_single_request = httpx.AsyncClient._send_single_request
 
 
 class CassettePatcherBuilder:
@@ -122,7 +118,6 @@ class CassettePatcherBuilder:
             self._boto3(),
             self._urllib3(),
             self._httplib2(),
-            self._boto(),
             self._tornado(),
             self._aiohttp(),
             self._httpx(),
@@ -140,7 +135,9 @@ class CassettePatcherBuilder:
             return
 
         return mock.patch.object(
-            obj, patched_attribute, self._recursively_apply_get_cassette_subclass(replacement_class)
+            obj,
+            patched_attribute,
+            self._recursively_apply_get_cassette_subclass(replacement_class),
         )
 
     def _recursively_apply_get_cassette_subclass(self, replacement_dict_or_obj):
@@ -182,9 +179,7 @@ class CassettePatcherBuilder:
         bases = (base_class,)
         if not issubclass(base_class, object):  # Check for old style class
             bases += (object,)
-        return type(
-            "{}{}".format(base_class.__name__, self._cassette._path), bases, dict(cassette=self._cassette)
-        )
+        return type(f"{base_class.__name__}{self._cassette._path}", bases, {"cassette": self._cassette})
 
     @_build_patchers_from_mock_triples_decorator
     def _httplib(self):
@@ -196,24 +191,15 @@ class CassettePatcherBuilder:
             from .stubs import requests_stubs
         except ImportError:  # pragma: no cover
             return ()
-        return self._urllib3_patchers(cpool, requests_stubs)
+        return self._urllib3_patchers(cpool, conn, requests_stubs)
 
     @_build_patchers_from_mock_triples_decorator
     def _boto3(self):
-
         try:
             # botocore using awsrequest
             import botocore.awsrequest as cpool
         except ImportError:  # pragma: no cover
-            try:
-                # botocore using vendored requests
-                import botocore.vendored.requests.packages.urllib3.connectionpool as cpool
-            except ImportError:  # pragma: no cover
-                pass
-            else:
-                from .stubs import boto3_stubs
-
-                yield self._urllib3_patchers(cpool, boto3_stubs)
+            pass
         else:
             from .stubs import boto3_stubs
 
@@ -255,12 +241,13 @@ class CassettePatcherBuilder:
 
     def _urllib3(self):
         try:
+            import urllib3.connection as conn
             import urllib3.connectionpool as cpool
         except ImportError:  # pragma: no cover
             return ()
         from .stubs import urllib3_stubs
 
-        return self._urllib3_patchers(cpool, urllib3_stubs)
+        return self._urllib3_patchers(cpool, conn, urllib3_stubs)
 
     @_build_patchers_from_mock_triples_decorator
     def _httplib2(self):
@@ -269,26 +256,18 @@ class CassettePatcherBuilder:
         except ImportError:  # pragma: no cover
             pass
         else:
-            from .stubs.httplib2_stubs import VCRHTTPConnectionWithTimeout
-            from .stubs.httplib2_stubs import VCRHTTPSConnectionWithTimeout
+            from .stubs.httplib2_stubs import VCRHTTPConnectionWithTimeout, VCRHTTPSConnectionWithTimeout
 
             yield cpool, "HTTPConnectionWithTimeout", VCRHTTPConnectionWithTimeout
             yield cpool, "HTTPSConnectionWithTimeout", VCRHTTPSConnectionWithTimeout
-            yield cpool, "SCHEME_TO_CONNECTION", {
-                "http": VCRHTTPConnectionWithTimeout,
-                "https": VCRHTTPSConnectionWithTimeout,
-            }
-
-    @_build_patchers_from_mock_triples_decorator
-    def _boto(self):
-        try:
-            import boto.https_connection as cpool
-        except ImportError:  # pragma: no cover
-            pass
-        else:
-            from .stubs.boto_stubs import VCRCertValidatingHTTPSConnection
-
-            yield cpool, "CertValidatingHTTPSConnection", VCRCertValidatingHTTPSConnection
+            yield (
+                cpool,
+                "SCHEME_TO_CONNECTION",
+                {
+                    "http": VCRHTTPConnectionWithTimeout,
+                    "https": VCRHTTPSConnectionWithTimeout,
+                },
+            )
 
     @_build_patchers_from_mock_triples_decorator
     def _tornado(self):
@@ -332,23 +311,23 @@ class CassettePatcherBuilder:
         else:
             from .stubs.httpx_stubs import async_vcr_send, sync_vcr_send
 
-            new_async_client_send = async_vcr_send(self._cassette, _HttpxAsyncClient_send)
-            yield httpx.AsyncClient, "send", new_async_client_send
+            new_async_client_send = async_vcr_send(self._cassette, _HttpxAsyncClient_send_single_request)
+            yield httpx.AsyncClient, "_send_single_request", new_async_client_send
 
-            new_sync_client_send = sync_vcr_send(self._cassette, _HttpxSyncClient_send)
-            yield httpx.Client, "send", new_sync_client_send
+            new_sync_client_send = sync_vcr_send(self._cassette, _HttpxSyncClient_send_single_request)
+            yield httpx.Client, "_send_single_request", new_sync_client_send
 
-    def _urllib3_patchers(self, cpool, stubs):
+    def _urllib3_patchers(self, cpool, conn, stubs):
         http_connection_remover = ConnectionRemover(
-            self._get_cassette_subclass(stubs.VCRRequestsHTTPConnection)
+            self._get_cassette_subclass(stubs.VCRRequestsHTTPConnection),
         )
         https_connection_remover = ConnectionRemover(
-            self._get_cassette_subclass(stubs.VCRRequestsHTTPSConnection)
+            self._get_cassette_subclass(stubs.VCRRequestsHTTPSConnection),
         )
         mock_triples = (
-            (cpool, "VerifiedHTTPSConnection", stubs.VCRRequestsHTTPSConnection),
-            (cpool, "HTTPConnection", stubs.VCRRequestsHTTPConnection),
-            (cpool, "HTTPSConnection", stubs.VCRRequestsHTTPSConnection),
+            (conn, "VerifiedHTTPSConnection", stubs.VCRRequestsHTTPSConnection),
+            (conn, "HTTPConnection", stubs.VCRRequestsHTTPConnection),
+            (conn, "HTTPSConnection", stubs.VCRRequestsHTTPSConnection),
             (cpool, "is_connection_dropped", mock.Mock(return_value=False)),  # Needed on Windows only
             (cpool.HTTPConnectionPool, "ConnectionCls", stubs.VCRRequestsHTTPConnection),
             (cpool.HTTPSConnectionPool, "ConnectionCls", stubs.VCRRequestsHTTPSConnection),
@@ -393,10 +372,6 @@ class ConnectionRemover:
         if isinstance(connection, self._connection_class):
             self._connection_pool_to_connections.setdefault(pool, set()).add(connection)
 
-    def remove_connection_to_pool_entry(self, pool, connection):
-        if isinstance(connection, self._connection_class):
-            self._connection_pool_to_connections[self._connection_class].remove(connection)
-
     def __enter__(self):
         return self
 
@@ -407,10 +382,13 @@ class ConnectionRemover:
                 connection = pool.pool.get()
                 if isinstance(connection, self._connection_class):
                     connections.remove(connection)
+                    connection.close()
                 else:
                     readd_connections.append(connection)
             for connection in readd_connections:
                 pool._put_conn(connection)
+            for connection in connections:
+                connection.close()
 
 
 def reset_patchers():
@@ -418,69 +396,23 @@ def reset_patchers():
     yield mock.patch.object(httplib, "HTTPSConnection", _HTTPSConnection)
 
     try:
-        import requests
-
-        if requests.__build__ < 0x021603:
-            # Avoid double unmock if requests 2.16.3
-            # First, this is pointless, requests.packages.urllib3 *IS* urllib3 (see packages.py)
-            # Second, this is unmocking twice the same classes with different namespaces
-            # and is creating weird issues and bugs:
-            # > AssertionError: assert <class 'urllib3.connection.HTTPConnection'>
-            # >   is <class 'requests.packages.urllib3.connection.HTTPConnection'>
-            # This assert should work!!!
-            # Note that this also means that now, requests.packages is never imported
-            # if requests 2.16.3 or greater is used with VCRPy.
-            import requests.packages.urllib3.connectionpool as cpool
-        else:
-            raise ImportError("Skip requests not vendored anymore")
-    except ImportError:  # pragma: no cover
-        pass
-    else:
-        # unpatch requests v1.x
-        yield mock.patch.object(cpool, "VerifiedHTTPSConnection", _VerifiedHTTPSConnection)
-        yield mock.patch.object(cpool, "HTTPConnection", _cpoolHTTPConnection)
-        # unpatch requests v2.x
-        if hasattr(cpool.HTTPConnectionPool, "ConnectionCls"):
-            yield mock.patch.object(cpool.HTTPConnectionPool, "ConnectionCls", _cpoolHTTPConnection)
-            yield mock.patch.object(cpool.HTTPSConnectionPool, "ConnectionCls", _cpoolHTTPSConnection)
-
-        if hasattr(cpool, "HTTPSConnection"):
-            yield mock.patch.object(cpool, "HTTPSConnection", _cpoolHTTPSConnection)
-
-    try:
+        import urllib3.connection as conn
         import urllib3.connectionpool as cpool
     except ImportError:  # pragma: no cover
         pass
     else:
-        yield mock.patch.object(cpool, "VerifiedHTTPSConnection", _VerifiedHTTPSConnection)
-        yield mock.patch.object(cpool, "HTTPConnection", _cpoolHTTPConnection)
-        yield mock.patch.object(cpool, "HTTPSConnection", _cpoolHTTPSConnection)
+        yield mock.patch.object(conn, "VerifiedHTTPSConnection", _VerifiedHTTPSConnection)
+        yield mock.patch.object(conn, "HTTPConnection", _connHTTPConnection)
+        yield mock.patch.object(conn, "HTTPSConnection", _connHTTPSConnection)
         if hasattr(cpool.HTTPConnectionPool, "ConnectionCls"):
-            yield mock.patch.object(cpool.HTTPConnectionPool, "ConnectionCls", _cpoolHTTPConnection)
-            yield mock.patch.object(cpool.HTTPSConnectionPool, "ConnectionCls", _cpoolHTTPSConnection)
+            yield mock.patch.object(cpool.HTTPConnectionPool, "ConnectionCls", _connHTTPConnection)
+            yield mock.patch.object(cpool.HTTPSConnectionPool, "ConnectionCls", _connHTTPSConnection)
 
     try:
         # unpatch botocore with awsrequest
         import botocore.awsrequest as cpool
     except ImportError:  # pragma: no cover
-        try:
-            # unpatch botocore with vendored requests
-            import botocore.vendored.requests.packages.urllib3.connectionpool as cpool
-        except ImportError:  # pragma: no cover
-            pass
-        else:
-            # unpatch requests v1.x
-            yield mock.patch.object(cpool, "VerifiedHTTPSConnection", _Boto3VerifiedHTTPSConnection)
-            yield mock.patch.object(cpool, "HTTPConnection", _cpoolBoto3HTTPConnection)
-            # unpatch requests v2.x
-            if hasattr(cpool.HTTPConnectionPool, "ConnectionCls"):
-                yield mock.patch.object(cpool.HTTPConnectionPool, "ConnectionCls", _cpoolBoto3HTTPConnection)
-                yield mock.patch.object(
-                    cpool.HTTPSConnectionPool, "ConnectionCls", _cpoolBoto3HTTPSConnection
-                )
-
-            if hasattr(cpool, "HTTPSConnection"):
-                yield mock.patch.object(cpool, "HTTPSConnection", _cpoolBoto3HTTPSConnection)
+        pass
     else:
         if hasattr(cpool.AWSHTTPConnectionPool, "ConnectionCls"):
             yield mock.patch.object(cpool.AWSHTTPConnectionPool, "ConnectionCls", _cpoolBoto3HTTPConnection)
@@ -498,13 +430,6 @@ def reset_patchers():
         yield mock.patch.object(cpool, "HTTPSConnectionWithTimeout", _HTTPSConnectionWithTimeout)
         yield mock.patch.object(cpool, "SCHEME_TO_CONNECTION", _SCHEME_TO_CONNECTION)
 
-    try:
-        import boto.https_connection as cpool
-    except ImportError:  # pragma: no cover
-        pass
-    else:
-        yield mock.patch.object(cpool, "CertValidatingHTTPSConnection", _CertValidatingHTTPSConnection)
-
     try:
         import tornado.simple_httpclient as simple
     except ImportError:  # pragma: no cover

vcr/persisters/filesystem.py

@@ -1,25 +1,40 @@
 # .. _persister_example:
 
-import os
-from ..serialize import serialize, deserialize
+from pathlib import Path
+
+from ..serialize import deserialize, serialize
+
+
+class CassetteNotFoundError(FileNotFoundError):
+    pass
+
+
+class CassetteDecodeError(ValueError):
+    pass
 
 
 class FilesystemPersister:
     @classmethod
     def load_cassette(cls, cassette_path, serializer):
+        cassette_path = Path(cassette_path)  # if cassette path is already Path this is no operation
+        if not cassette_path.is_file():
+            raise CassetteNotFoundError()
         try:
-            with open(cassette_path) as f:
-                cassette_content = f.read()
-        except OSError:
-            raise ValueError("Cassette not found.")
-        cassette = deserialize(cassette_content, serializer)
-        return cassette
+            with cassette_path.open() as f:
+                data = f.read()
+        except UnicodeDecodeError as err:
+            raise CassetteDecodeError("Can't read Cassette, Encoding is broken") from err
+
+        return deserialize(data, serializer)
 
     @staticmethod
     def save_cassette(cassette_path, cassette_dict, serializer):
         data = serialize(cassette_dict, serializer)
-        dirname, filename = os.path.split(cassette_path)
-        if dirname and not os.path.exists(dirname):
-            os.makedirs(dirname)
-        with open(cassette_path, "w") as f:
+        cassette_path = Path(cassette_path)  # if cassette path is already Path this is no operation
+
+        cassette_folder = cassette_path.parent
+        if not cassette_folder.exists():
+            cassette_folder.mkdir(parents=True)
+
+        with cassette_path.open("w") as f:
             f.write(data)

vcr/request.py

@@ -1,8 +1,9 @@
+import logging
 import warnings
 from io import BytesIO
-from urllib.parse import urlparse, parse_qsl
+from urllib.parse import parse_qsl, urlparse
+
 from .util import CaseInsensitiveDict
-import logging
 
 log = logging.getLogger(__name__)
 
@@ -45,8 +46,9 @@ class Request:
 
     def add_header(self, key, value):
         warnings.warn(
-            "Request.add_header is deprecated. " "Please assign to request.headers instead.",
+            "Request.add_header is deprecated. Please assign to request.headers instead.",
             DeprecationWarning,
+            stacklevel=2,
         )
         self.headers[key] = value
 
@@ -89,7 +91,7 @@ class Request:
         return self.scheme
 
     def __str__(self):
-        return "<Request ({}) {}>".format(self.method, self.uri)
+        return f"<Request ({self.method}) {self.uri}>"
 
     def __repr__(self):
         return self.__str__()

vcr/serialize.py

@@ -1,7 +1,8 @@
-from vcr.serializers import compat
-from vcr.request import Request
 import yaml
 
+from vcr.request import Request
+from vcr.serializers import compat
+
 # version 1 cassettes started with VCR 1.0.x.
 # Before 1.0.x, there was no versioning.
 CASSETTE_FORMAT_VERSION = 1
@@ -27,7 +28,7 @@ def _warn_about_old_cassette_format():
     raise ValueError(
         "Your cassette files were generated in an older version "
         "of VCR. Delete your cassettes or run the migration script."
-        "See http://git.io/mHhLBg for more details."
+        "See http://git.io/mHhLBg for more details.",
     )
 
 

vcr/serializers/compat.py

@@ -56,7 +56,7 @@ def convert_body_to_unicode(resp):
     If the request or responses body is bytes, decode it to a string
     (for python3 support)
     """
-    if type(resp) is not dict:
+    if not isinstance(resp, dict):
         # Some of the tests just serialize and deserialize a string.
         return _convert_string_to_unicode(resp)
     else:

vcr/serializers/jsonserializer.py

@@ -1,7 +1,4 @@
-try:
-    import simplejson as json
-except ImportError:
-    import json
+import json
 
 
 def deserialize(cassette_string):
@@ -17,13 +14,5 @@ def serialize(cassette_dict):
 
     try:
         return json.dumps(cassette_dict, indent=4) + "\n"
-    except UnicodeDecodeError as original:  # py2
-        raise UnicodeDecodeError(
-            original.encoding,
-            b"Error serializing cassette to JSON",
-            original.start,
-            original.end,
-            original.args[-1] + error_message,
-        )
-    except TypeError:  # py3
-        raise TypeError(error_message)
+    except TypeError:
+        raise TypeError(error_message) from None

vcr/serializers/yamlserializer.py

@@ -2,9 +2,10 @@ import yaml
 
 # Use the libYAML versions if possible
 try:
-    from yaml import CLoader as Loader, CDumper as Dumper
+    from yaml import CDumper as Dumper
+    from yaml import CLoader as Loader
 except ImportError:
-    from yaml import Loader, Dumper
+    from yaml import Dumper, Loader
 
 
 def deserialize(cassette_string):

vcr/stubs/__init__.py

@@ -1,14 +1,12 @@
 """Stubs for patching HTTP and HTTPS requests"""
 
 import logging
-from http.client import (
-    HTTPConnection,
-    HTTPSConnection,
-    HTTPResponse,
-)
+from http.client import HTTPConnection, HTTPResponse, HTTPSConnection
 from io import BytesIO
-from vcr.request import Request
+
 from vcr.errors import CannotOverwriteExistingCassetteException
+from vcr.request import Request
+
 from . import compat
 
 log = logging.getLogger(__name__)
@@ -49,8 +47,9 @@ def parse_headers(header_list):
 
 
 def serialize_headers(response):
+    headers = response.headers if response.msg is None else response.msg
     out = {}
-    for key, values in compat.get_headers(response.msg):
+    for key, values in compat.get_headers(headers):
         out.setdefault(key, [])
         out[key].extend(values)
     return out
@@ -69,6 +68,7 @@ class VCRHTTPResponse(HTTPResponse):
         self.version = None
         self._content = BytesIO(self.recorded_response["body"]["string"])
         self._closed = False
+        self._original_response = self  # for requests.session.Session cookie extraction
 
         headers = self.recorded_response["headers"]
         # Since we are loading a response that has already been serialized, our
@@ -87,12 +87,15 @@ class VCRHTTPResponse(HTTPResponse):
     def closed(self):
         # in python3, I can't change the value of self.closed.  So I'
         # twiddling self._closed and using this property to shadow the real
-        # self.closed from the superclas
+        # self.closed from the superclass
         return self._closed
 
     def read(self, *args, **kwargs):
         return self._content.read(*args, **kwargs)
 
+    def read1(self, *args, **kwargs):
+        return self._content.read1(*args, **kwargs)
+
     def readall(self):
         return self._content.readall()
 
@@ -145,6 +148,35 @@ class VCRHTTPResponse(HTTPResponse):
     def readable(self):
         return self._content.readable()
 
+    @property
+    def length_remaining(self):
+        return self._content.getbuffer().nbytes - self._content.tell()
+
+    def get_redirect_location(self):
+        """
+        Returns (a) redirect location string if we got a redirect
+        status code and valid location, (b) None if redirect status and
+        no location, (c) False if not a redirect status code.
+        See https://urllib3.readthedocs.io/en/stable/reference/urllib3.response.html .
+        """
+        if not (300 <= self.status <= 399):
+            return False
+        return self.getheader("Location")
+
+    @property
+    def data(self):
+        return self._content.getbuffer().tobytes()
+
+    def drain_conn(self):
+        pass
+
+    def stream(self, amt=65536, decode_content=None):
+        while True:
+            b = self._content.read(amt)
+            yield b
+            if not b:
+                break
+
 
 class VCRConnection:
     # A reference to the cassette that's currently being patched in
@@ -156,26 +188,26 @@ class VCRConnection:
         """
         port = self.real_connection.port
         default_port = {"https": 443, "http": 80}[self._protocol]
-        return ":{}".format(port) if port != default_port else ""
+        return f":{port}" if port != default_port else ""
 
     def _uri(self, url):
         """Returns request absolute URI"""
         if url and not url.startswith("/"):
             # Then this must be a proxy request.
             return url
-        uri = "{}://{}{}{}".format(self._protocol, self.real_connection.host, self._port_postfix(), url)
+        uri = f"{self._protocol}://{self.real_connection.host}{self._port_postfix()}{url}"
         log.debug("Absolute URI: %s", uri)
         return uri
 
     def _url(self, uri):
         """Returns request selector url from absolute URI"""
-        prefix = "{}://{}{}".format(self._protocol, self.real_connection.host, self._port_postfix())
+        prefix = f"{self._protocol}://{self.real_connection.host}{self._port_postfix()}"
         return uri.replace(prefix, "", 1)
 
     def request(self, method, url, body=None, headers=None, *args, **kwargs):
         """Persist the request metadata in self._vcr_request"""
         self._vcr_request = Request(method=method, uri=self._uri(url), body=body, headers=headers or {})
-        log.debug("Got {}".format(self._vcr_request))
+        log.debug(f"Got {self._vcr_request}")
 
         # Note: The request may not actually be finished at this point, so
         # I'm not sending the actual request until getresponse().  This
@@ -191,7 +223,7 @@ class VCRConnection:
         of putheader() calls.
         """
         self._vcr_request = Request(method=method, uri=self._uri(url), body="", headers={})
-        log.debug("Got {}".format(self._vcr_request))
+        log.debug(f"Got {self._vcr_request}")
 
     def putheader(self, header, *values):
         self._vcr_request.headers[header] = values
@@ -223,19 +255,20 @@ class VCRConnection:
         # Check to see if the cassette has a response for this request. If so,
         # then return it
         if self.cassette.can_play_response_for(self._vcr_request):
-            log.info("Playing response for {} from cassette".format(self._vcr_request))
+            log.info(f"Playing response for {self._vcr_request} from cassette")
             response = self.cassette.play_response(self._vcr_request)
             return VCRHTTPResponse(response)
         else:
             if self.cassette.write_protected and self.cassette.filter_request(self._vcr_request):
                 raise CannotOverwriteExistingCassetteException(
-                    cassette=self.cassette, failed_request=self._vcr_request
+                    cassette=self.cassette,
+                    failed_request=self._vcr_request,
                 )
 
             # Otherwise, we should send the request, then get the response
             # and return it.
 
-            log.info("{} not in cassette, sending to real server".format(self._vcr_request))
+            log.info(f"{self._vcr_request} not in cassette, sending to real server")
             # This is imported here to avoid circular import.
             # TODO(@IvanMalison): Refactor to allow normal import.
             from vcr.patch import force_reset
@@ -250,12 +283,13 @@ class VCRConnection:
 
             # get the response
             response = self.real_connection.getresponse()
+            response_data = response.data if hasattr(response, "data") else response.read()
 
             # put the response into the cassette
             response = {
                 "status": {"code": response.status, "message": response.reason},
                 "headers": serialize_headers(response),
-                "body": {"string": response.read()},
+                "body": {"string": response_data},
             }
             self.cassette.append(self._vcr_request, response)
         return VCRHTTPResponse(response)
@@ -355,6 +389,8 @@ class VCRHTTPConnection(VCRConnection):
 
     _baseclass = HTTPConnection
     _protocol = "http"
+    debuglevel = _baseclass.debuglevel
+    _http_vsn = _baseclass._http_vsn
 
 
 class VCRHTTPSConnection(VCRConnection):
@@ -363,3 +399,5 @@ class VCRHTTPSConnection(VCRConnection):
     _baseclass = HTTPSConnection
     _protocol = "https"
     is_verified = True
+    debuglevel = _baseclass.debuglevel
+    _http_vsn = _baseclass._http_vsn

vcr/stubs/aiohttp_stubs.py

@@ -1,15 +1,14 @@
 """Stubs for aiohttp HTTP clients"""
 import asyncio
 import functools
-import logging
 import json
-
-from aiohttp import ClientConnectionError, ClientResponse, RequestInfo, streams
-from aiohttp import hdrs, CookieJar
+import logging
 from http.cookies import CookieError, Morsel, SimpleCookie
+from typing import Mapping, Union
+
+from aiohttp import ClientConnectionError, ClientResponse, CookieJar, RequestInfo, hdrs, streams
 from aiohttp.helpers import strip_auth_from_url
 from multidict import CIMultiDict, CIMultiDictProxy, MultiDict
-from typing import Union, Mapping
 from yarl import URL
 
 from vcr.errors import CannotOverwriteExistingCassetteException
@@ -36,7 +35,7 @@ class MockClientResponse(ClientResponse):
             session=None,
         )
 
-    async def json(self, *, encoding="utf-8", loads=json.loads, **kwargs):  # NOQA: E999
+    async def json(self, *, encoding="utf-8", loads=json.loads, **kwargs):
         stripped = self._body.strip()
         if not stripped:
             return None
@@ -67,7 +66,7 @@ def build_response(vcr_request, vcr_response, history):
         headers=_deserialize_headers(vcr_request.headers),
         real_url=URL(vcr_request.url),
     )
-    response = MockClientResponse(vcr_request.method, URL(vcr_response.get("url")), request_info=request_info)
+    response = MockClientResponse(vcr_request.method, URL(vcr_request.url), request_info=request_info)
     response.status = vcr_response["status"]["code"]
     response._body = vcr_response["body"].get("string", b"")
     response.reason = vcr_response["status"]["message"]
@@ -163,8 +162,7 @@ async def record_response(cassette, vcr_request, response):
     vcr_response = {
         "status": {"code": response.status, "message": response.reason},
         "headers": _serialize_headers(response.headers),
-        "body": body,  # NOQA: E999
-        "url": str(response.url),
+        "body": body,
     }
 
     cassette.append(vcr_request, vcr_response)
@@ -177,14 +175,14 @@ async def record_responses(cassette, vcr_request, response):
     to the final destination.
     """
 
-    for past_response in response.history:
+    for i, past_response in enumerate(response.history):
         aiohttp_request = past_response.request_info
 
-        # No data because it's following a redirect.
         past_request = Request(
             aiohttp_request.method,
             str(aiohttp_request.url),
-            None,
+            # Record body of first request, rest are following a redirect.
+            None if i else vcr_request.body,
             _serialize_headers(aiohttp_request.headers),
         )
         await record_response(cassette, past_request, past_response)
@@ -262,7 +260,7 @@ def vcr_request(cassette, real_request):
         vcr_request = Request(method, str(request_url), data, _serialize_headers(headers))
 
         if cassette.can_play_response_for(vcr_request):
-            log.info("Playing response for {} from cassette".format(vcr_request))
+            log.info(f"Playing response for {vcr_request} from cassette")
             response = play_responses(cassette, vcr_request, kwargs)
             for redirect in response.history:
                 self._cookie_jar.update_cookies(redirect.cookies, redirect.url)
@@ -274,7 +272,7 @@ def vcr_request(cassette, real_request):
 
         log.info("%s not in cassette, sending to real server", vcr_request)
 
-        response = await real_request(self, method, url, **kwargs)  # NOQA: E999
+        response = await real_request(self, method, url, **kwargs)
         await record_responses(cassette, vcr_request, response)
         return response
 

vcr/stubs/boto3_stubs.py

@@ -1,17 +1,6 @@
 """Stubs for boto3"""
-try:
-    # boto using awsrequest
-    from botocore.awsrequest import AWSHTTPConnection as HTTPConnection
-    from botocore.awsrequest import AWSHTTPSConnection as VerifiedHTTPSConnection
-
-except ImportError:  # pragma: nocover
-    # boto using vendored requests
-    # urllib3 defines its own HTTPConnection classes, which boto3 goes ahead and assumes
-    # you're using.  It includes some polyfills for newer features missing in older pythons.
-    try:
-        from urllib3.connectionpool import HTTPConnection, VerifiedHTTPSConnection
-    except ImportError:  # pragma: nocover
-        from requests.packages.urllib3.connectionpool import HTTPConnection, VerifiedHTTPSConnection
+from botocore.awsrequest import AWSHTTPConnection as HTTPConnection
+from botocore.awsrequest import AWSHTTPSConnection as VerifiedHTTPSConnection
 
 from ..stubs import VCRHTTPConnection, VCRHTTPSConnection
 

vcr/stubs/boto_stubs.py

@@ -1,8 +0,0 @@
-"""Stubs for boto"""
-
-from boto.https_connection import CertValidatingHTTPSConnection
-from ..stubs import VCRHTTPSConnection
-
-
-class VCRCertValidatingHTTPSConnection(VCRHTTPSConnection):
-    _baseclass = CertValidatingHTTPSConnection

vcr/stubs/compat.py

@@ -1,6 +1,5 @@
-from io import BytesIO
 import http.client
-
+from io import BytesIO
 
 """
 The python3 http.client api moved some stuff around, so this is an abstraction
@@ -13,7 +12,7 @@ def get_header(message, name):
 
 
 def get_header_items(message):
-    for (key, values) in get_headers(message):
+    for key, values in get_headers(message):
         for value in values:
             yield key, value
 

vcr/stubs/httplib2_stubs.py

@@ -1,6 +1,7 @@
 """Stubs for httplib2"""
 
 from httplib2 import HTTPConnectionWithTimeout, HTTPSConnectionWithTimeout
+
 from ..stubs import VCRHTTPConnection, VCRHTTPSConnection
 
 
@@ -27,7 +28,6 @@ class VCRHTTPSConnectionWithTimeout(VCRHTTPSConnection, HTTPSConnectionWithTimeo
     _baseclass = HTTPSConnectionWithTimeout
 
     def __init__(self, *args, **kwargs):
-
         # Delete the keyword arguments that HTTPSConnection would not recognize
         safe_keys = {
             "host",

vcr/stubs/httpx_stubs.py

@@ -1,11 +1,15 @@
+import asyncio
 import functools
+import inspect
 import logging
-from unittest.mock import patch, MagicMock
+from unittest.mock import MagicMock, patch
 
 import httpx
-from vcr.request import Request as VcrRequest
+
 from vcr.errors import CannotOverwriteExistingCassetteException
-import inspect
+from vcr.filters import decode_response
+from vcr.request import Request as VcrRequest
+from vcr.serializers.compat import convert_body_to_bytes
 
 _httpx_signature = inspect.signature(httpx.Client.request)
 
@@ -32,14 +36,29 @@ def _transform_headers(httpx_response):
     return out
 
 
-def _to_serialized_response(httpx_response):
-    return {
-        "status_code": httpx_response.status_code,
-        "http_version": httpx_response.http_version,
-        "headers": _transform_headers(httpx_response),
-        "content": httpx_response.content.decode("utf-8", "ignore"),
+async def _to_serialized_response(resp, aread):
+    # The content shouldn't already have been read in by HTTPX.
+    assert not hasattr(resp, "_decoder")
+
+    # Retrieve the content, but without decoding it.
+    with patch.dict(resp.headers, {"Content-Encoding": ""}):
+        if aread:
+            await resp.aread()
+        else:
+            resp.read()
+
+    result = {
+        "status": {"code": resp.status_code, "message": resp.reason_phrase},
+        "headers": _transform_headers(resp),
+        "body": {"string": resp.content},
     }
 
+    # As the content wasn't decoded, we restore the response to a state which
+    # will be capable of decoding the content for the consumer.
+    del resp._decoder
+    resp._content = resp._get_content_decoder().decode(resp.content)
+    return result
+
 
 def _from_serialized_headers(headers):
     """
@@ -56,15 +75,32 @@ def _from_serialized_headers(headers):
 @patch("httpx.Response.close", MagicMock())
 @patch("httpx.Response.read", MagicMock())
 def _from_serialized_response(request, serialized_response, history=None):
-    content = serialized_response.get("content").encode()
+    # Cassette format generated for HTTPX requests by older versions of
+    # vcrpy. We restructure the content to resemble what a regular
+    # cassette looks like.
+    if "status_code" in serialized_response:
+        serialized_response = decode_response(
+            convert_body_to_bytes(
+                {
+                    "headers": serialized_response["headers"],
+                    "body": {"string": serialized_response["content"]},
+                    "status": {"code": serialized_response["status_code"]},
+                },
+            ),
+        )
+        extensions = None
+    else:
+        extensions = {"reason_phrase": serialized_response["status"]["message"].encode()}
+
     response = httpx.Response(
-        status_code=serialized_response.get("status_code"),
+        status_code=serialized_response["status"]["code"],
         request=request,
-        headers=_from_serialized_headers(serialized_response.get("headers")),
-        content=content,
+        headers=_from_serialized_headers(serialized_response["headers"]),
+        content=serialized_response["body"]["string"],
         history=history or [],
+        extensions=extensions,
     )
-    response._content = content
+
     return response
 
 
@@ -90,45 +126,23 @@ def _shared_vcr_send(cassette, real_send, *args, **kwargs):
     return vcr_request, None
 
 
-def _record_responses(cassette, vcr_request, real_response):
+async def _record_responses(cassette, vcr_request, real_response, aread):
     for past_real_response in real_response.history:
         past_vcr_request = _make_vcr_request(past_real_response.request)
-        cassette.append(past_vcr_request, _to_serialized_response(past_real_response))
+        cassette.append(past_vcr_request, await _to_serialized_response(past_real_response, aread))
 
     if real_response.history:
         # If there was a redirection keep we want the request which will hold the
         # final redirect value
         vcr_request = _make_vcr_request(real_response.request)
 
-    cassette.append(vcr_request, _to_serialized_response(real_response))
+    cassette.append(vcr_request, await _to_serialized_response(real_response, aread))
     return real_response
 
 
 def _play_responses(cassette, request, vcr_request, client, kwargs):
-    history = []
-
-    allow_redirects = kwargs.get(
-        HTTPX_REDIRECT_PARAM.name,
-        HTTPX_REDIRECT_PARAM.default,
-    )
     vcr_response = cassette.play_response(vcr_request)
     response = _from_serialized_response(request, vcr_response)
-
-    while allow_redirects and 300 <= response.status_code <= 399:
-        next_url = response.headers.get("location")
-        if not next_url:
-            break
-
-        vcr_request = VcrRequest("GET", next_url, None, dict(response.headers))
-        vcr_request = cassette.find_requests_with_most_matches(vcr_request)[0][0]
-
-        history.append(response)
-        # add cookies from response to session cookie store
-        client.cookies.extract_cookies(response)
-
-        vcr_response = cassette.play_response(vcr_request)
-        response = _from_serialized_response(vcr_request, vcr_response, history)
-
     return response
 
 
@@ -140,7 +154,8 @@ async def _async_vcr_send(cassette, real_send, *args, **kwargs):
         return response
 
     real_response = await real_send(*args, **kwargs)
-    return _record_responses(cassette, vcr_request, real_response)
+    await _record_responses(cassette, vcr_request, real_response, aread=True)
+    return real_response
 
 
 def async_vcr_send(cassette, real_send):
@@ -159,7 +174,8 @@ def _sync_vcr_send(cassette, real_send, *args, **kwargs):
         return response
 
     real_response = real_send(*args, **kwargs)
-    return _record_responses(cassette, vcr_request, real_response)
+    asyncio.run(_record_responses(cassette, vcr_request, real_response, aread=False))
+    return real_response
 
 
 def sync_vcr_send(cassette, real_send):

vcr/stubs/requests_stubs.py

@@ -1,9 +1,6 @@
 """Stubs for requests"""
 
-try:
-    from urllib3.connectionpool import HTTPConnection, VerifiedHTTPSConnection
-except ImportError:
-    from requests.packages.urllib3.connectionpool import HTTPConnection, VerifiedHTTPSConnection
+from urllib3.connection import HTTPConnection, VerifiedHTTPSConnection
 
 from ..stubs import VCRHTTPConnection, VCRHTTPSConnection
 

vcr/stubs/tornado_stubs.py

@@ -29,9 +29,9 @@ def vcr_fetch_impl(cassette, real_fetch_impl):
                 request,
                 599,
                 error=Exception(
-                    "The request (%s) uses AsyncHTTPClient functionality "
+                    f"The request ({request!r}) uses AsyncHTTPClient functionality "
                     "that is not yet supported by VCR.py. Please make the "
-                    "request outside a VCR.py context." % repr(request)
+                    "request outside a VCR.py context.",
                 ),
                 request_time=self.io_loop.time() - request.start_time,
             )
@@ -65,7 +65,8 @@ def vcr_fetch_impl(cassette, real_fetch_impl):
                     request,
                     599,
                     error=CannotOverwriteExistingCassetteException(
-                        cassette=cassette, failed_request=vcr_request
+                        cassette=cassette,
+                        failed_request=vcr_request,
                     ),
                     request_time=self.io_loop.time() - request.start_time,
                 )

vcr/stubs/urllib3_stubs.py

@@ -1,6 +1,7 @@
 """Stubs for urllib3"""
 
-from urllib3.connectionpool import HTTPConnection, VerifiedHTTPSConnection
+from urllib3.connection import HTTPConnection, VerifiedHTTPSConnection
+
 from ..stubs import VCRHTTPConnection, VCRHTTPSConnection
 
 # urllib3 defines its own HTTPConnection classes. It includes some polyfills

vcr/unittest.py

@@ -0,0 +1,39 @@
+import inspect
+import os
+import unittest
+
+from .config import VCR
+
+
+class VCRMixin:
+    """A TestCase mixin that provides VCR integration."""
+
+    vcr_enabled = True
+
+    def setUp(self):
+        super().setUp()
+        if self.vcr_enabled:
+            kwargs = self._get_vcr_kwargs()
+            myvcr = self._get_vcr(**kwargs)
+            cm = myvcr.use_cassette(self._get_cassette_name())
+            self.cassette = cm.__enter__()
+            self.addCleanup(cm.__exit__, None, None, None)
+
+    def _get_vcr(self, **kwargs):
+        if "cassette_library_dir" not in kwargs:
+            kwargs["cassette_library_dir"] = self._get_cassette_library_dir()
+        return VCR(**kwargs)
+
+    def _get_vcr_kwargs(self, **kwargs):
+        return kwargs
+
+    def _get_cassette_library_dir(self):
+        testdir = os.path.dirname(inspect.getfile(self.__class__))
+        return os.path.join(testdir, "cassettes")
+
+    def _get_cassette_name(self):
+        return f"{self.__class__.__name__}.{self._testMethodName}.yaml"
+
+
+class VCRTestCase(VCRMixin, unittest.TestCase):
+    pass

vcr/util.py

@@ -1,9 +1,5 @@
 import types
-
-try:
-    from collections.abc import Mapping, MutableMapping
-except ImportError:
-    from collections import Mapping, MutableMapping
+from collections.abc import Mapping, MutableMapping
 
 
 # Shamelessly stolen from https://github.com/kennethreitz/requests/blob/master/requests/structures.py
@@ -31,7 +27,7 @@ class CaseInsensitiveDict(MutableMapping):
     """
 
     def __init__(self, data=None, **kwargs):
-        self._store = dict()
+        self._store = {}
         if data is None:
             data = {}
         self.update(data, **kwargs)