Apply PR feedback

* fix: usage of io-like interface with VCR.py

* Update tests/integration/test_aiohttp.py

Co-authored-by: Jair Henrique <jair.henrique@gmail.com>

---------

Co-authored-by: Jair Henrique <jair.henrique@gmail.com>

.github/workflows/codespell.yml

@@ -13,10 +13,10 @@ permissions:
 jobs:
   codespell:
     name: Check for spelling errors
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Codespell
         uses: codespell-project/actions-codespell@v2

.github/workflows/docs.yml

@@ -7,11 +7,11 @@ on:
 
 jobs:
   validate:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 

.github/workflows/main.yml

@@ -6,50 +6,45 @@ on:
       - master
   pull_request:
   schedule:
-    - cron: '0 16 * * 5'  # Every Friday 4pm
+    - cron: "0 16 * * 5" # Every Friday 4pm
   workflow_dispatch:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
-          - "pypy-3.9"
-          - "pypy-3.10"
-        urllib3-requirement:
-          - "urllib3>=2"
-          - "urllib3<2"
-
-        exclude:
-          - 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"
+          - "pypy-3.11"
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-          cache: pip
           allow-prereleases: true
 
       - name: Install project dependencies
         run: |
-          pip install --upgrade pip setuptools
-          pip install codecov '.[tests]' '${{ matrix.urllib3-requirement }}'
-          pip check
+          uv pip install --system --upgrade pip setuptools
+          uv pip install --system codecov '.[tests]'
+          uv pip check
+
+      - name: Allow creation of user namespaces (e.g. to the unshare command)
+        run: |
+          # .. so that we don't get error:
+          # unshare: write failed /proc/self/uid_map: Operation not permitted
+          # Idea from https://github.com/YoYoGames/GameMaker-Bugs/issues/6015#issuecomment-2135552784 .
+          sudo sysctl kernel.apparmor_restrict_unprivileged_userns=0
 
       - name: Run online tests
         run: ./runtests.sh --cov=./vcr --cov-branch --cov-report=xml --cov-append -m online

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

@@ -16,12 +16,12 @@ permissions:
 jobs:
   pre_commit_detect_outdated:
     name: Detect outdated pre-commit hooks
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Python 3.12
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: 3.12
 

.github/workflows/pre-commit.yml

@@ -11,10 +11,10 @@ on:
 jobs:
   pre-commit:
     name: Run pre-commit
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
         python-version: 3.12
     - uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -3,14 +3,14 @@
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.4
+    rev: v0.14.6
     hooks:
       - id: ruff
         args: ["--output-format=full"]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-merge-conflict
       - id: end-of-file-fixer

.readthedocs.yaml

@@ -7,7 +7,7 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
     python: "3.12"
 

docs/advanced.rst

@@ -427,3 +427,16 @@ If you want to save the cassette only when the test succeeds, set the Cassette
 
     # Since there was an exception, the cassette file hasn't been created.
     assert not os.path.exists('fixtures/vcr_cassettes/synopsis.yaml')
+
+Drop unused requests
+--------------------
+
+Even if any HTTP request is changed or removed from tests, previously recorded
+interactions remain in the cassette file.  If set the ``drop_unused_requests``
+option to ``True``, VCR will not save old HTTP interactions if they are not used.
+
+.. code:: python
+
+    my_vcr = VCR(drop_unused_requests=True)
+    with my_vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml'):
+        ...  # your HTTP interactions here

docs/changelog.rst

@@ -7,6 +7,22 @@ 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.
 
+-  8.0.0
+    - BREAKING: Drop support for Python 3.9 (major version bump) - thanks @jairhenrique
+    - BREAKING: Drop support for urllib3 < 2 - fixes CVE warnings from urllib3 1.x (#926, #880) - thanks @jairhenrique
+    - New feature: ``drop_unused_requests`` option to remove unused interactions from cassettes (#763) - thanks @danielnsilva
+    - Rewrite httpx support to patch httpcore instead of httpx (#943) - thanks @seowalex
+        - Fixes ``httpx.ResponseNotRead`` exceptions (#832, #834)
+        - Fixes ``KeyError: 'follow_redirects'`` (#945)
+        - Adds support for custom httpx transports
+    - Fix HTTPS proxy handling - proxy address no longer ends up in cassette URIs (#809, #914) - thanks @alga
+    - Fix ``iscoroutinefunction`` deprecation warning on Python 3.14 - thanks @kloczek
+    - Only log message if response is appended - thanks @talfus-laddus
+    - Optimize urllib.parse calls - thanks @Martin-Brunthaler
+    - Fix CI for Ubuntu 24.04 - thanks @hartwork
+    - Various CI improvements: migrate to uv, update GitHub Actions - thanks @jairhenrique
+    - Various linting and test improvements - thanks @jairhenrique and @hartwork
+
 -  7.0.0
     - Drop support for python 3.8 (major version bump) - thanks @jairhenrique
     - Various linting and test fixes - thanks @jairhenrique

docs/conf.py

@@ -316,5 +316,5 @@ texinfo_documents = [
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"https://docs.python.org/": None}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 html_theme = "alabaster"

docs/installation.rst

@@ -22,6 +22,7 @@ The following HTTP libraries are supported:
 -  ``urllib2``
 -  ``urllib3``
 -  ``httpx``
+-  ``httpcore``
 
 Speed
 -----

docs/requirements.txt

@@ -1,2 +1,2 @@
 sphinx<9
-sphinx_rtd_theme==2.0.0
+sphinx_rtd_theme==3.0.2

pyproject.toml

@@ -1,23 +1,16 @@
 [tool.codespell]
 skip = '.git,*.pdf,*.svg,.tox'
 ignore-regex = "\\\\[fnrstv]"
-#
-# ignore-words-list = ''
 
-[tool.pytest.ini_options]
-addopts = [
-    "--strict-config",
-    "--strict-markers",
-]
+[tool.pytest]
+addopts = ["--strict-config", "--strict-markers"]
+asyncio_default_fixture_loop_scope = "session"
+asyncio_default_test_loop_scope = "session"
 markers = ["online"]
-filterwarnings = [
-    "error",
-    '''ignore:datetime\.datetime\.utcfromtimestamp\(\) is deprecated and scheduled for removal in a future version.*:DeprecationWarning''',
-]
 
 [tool.ruff]
 line-length = 110
-target-version = "py39"
+target-version = "py310"
 
 [tool.ruff.lint]
 select = [
@@ -32,6 +25,7 @@ select = [
     "RUF", # Ruff-specific rules
     "UP",  # pyupgrade
     "W",   # pycodestyle warning
+    "SIM",
 ]
 
 [tool.ruff.lint.isort]

setup.py

@@ -3,10 +3,11 @@
 import codecs
 import os
 import re
+from pathlib import Path
 
 from setuptools import find_packages, setup
 
-long_description = open("README.rst").read()
+long_description = Path("README.rst").read_text()
 here = os.path.abspath(os.path.dirname(__file__))
 
 
@@ -29,42 +30,27 @@ def find_version(*file_paths):
 install_requires = [
     "PyYAML",
     "wrapt",
-    "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'",
-    # Workaround for Poetry with CPython >= 3.10, problem description at:
-    # https://github.com/kevin1024/vcrpy/pull/826
-    "urllib3; platform_python_implementation !='PyPy' and python_version >='3.10'",
 ]
 
 extras_require = {
     "tests": [
         "aiohttp",
         "boto3",
+        "cryptography",
+        "httpbin",
+        "httpcore",
         "httplib2",
         "httpx",
+        "pycurl; platform_python_implementation !='PyPy'",
+        "pytest",
         "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",
+        "werkzeug==2.0.3",
     ],
 }
 
@@ -78,7 +64,7 @@ setup(
     author_email="me@kevinmccarthy.org",
     url="https://github.com/kevin1024/vcrpy",
     packages=find_packages(exclude=["tests*"]),
-    python_requires=">=3.9",
+    python_requires=">=3.10",
     install_requires=install_requires,
     license="MIT",
     extras_require=extras_require,
@@ -89,7 +75,6 @@ setup(
         "Intended Audience :: Developers",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",

tests/integration/test_aiohttp.py

@@ -1,3 +1,4 @@
+import io
 import logging
 import ssl
 import urllib.parse
@@ -193,9 +194,11 @@ def test_params_same_url_distinct_params(tmpdir, httpbin):
         assert cassette.play_count == 1
 
     other_params = {"other": "params"}
-    with vcr.use_cassette(str(tmpdir.join("get.yaml"))) as cassette:
-        with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-            get(url, output="text", params=other_params)
+    with (
+        vcr.use_cassette(str(tmpdir.join("get.yaml"))) as cassette,
+        pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException),
+    ):
+        get(url, output="text", params=other_params)
 
 
 @pytest.mark.online
@@ -264,12 +267,6 @@ def test_aiohttp_test_client_json(aiohttp_client, tmpdir):
     assert cassette.play_count == 1
 
 
-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"
@@ -466,3 +463,19 @@ def test_filter_query_parameters(tmpdir, httpbin):
         cassette_content = f.read()
         assert "password" not in cassette_content
         assert "secret" not in cassette_content
+
+
+@pytest.mark.online
+def test_use_cassette_with_io(tmpdir, caplog, httpbin):
+    url = httpbin.url + "/post"
+
+    # test without cassettes
+    data = io.BytesIO(b"hello")
+    _, response_json = request("POST", url, output="json", data=data)
+    assert response_json["data"] == "hello"
+
+    # test with cassettes
+    data = io.BytesIO(b"hello")
+    with vcr.use_cassette(str(tmpdir.join("post.yaml"))):
+        _, response_json = request("POST", url, output="json", data=data)
+        assert response_json["data"] == "hello"

tests/integration/test_config.py

@@ -5,6 +5,7 @@ from urllib.request import urlopen
 import pytest
 
 import vcr
+from vcr.cassette import Cassette
 
 
 @pytest.mark.online
@@ -61,9 +62,8 @@ def test_override_match_on(tmpdir, httpbin):
 def test_missing_matcher():
     my_vcr = vcr.VCR()
     my_vcr.register_matcher("awesome", object)
-    with pytest.raises(KeyError):
-        with my_vcr.use_cassette("test.yaml", match_on=["notawesome"]):
-            pass
+    with pytest.raises(KeyError), my_vcr.use_cassette("test.yaml", match_on=["notawesome"]):
+        pass
 
 
 @pytest.mark.online
@@ -80,8 +80,25 @@ def test_dont_record_on_exception(tmpdir, httpbin):
     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()
+    with pytest.raises(AssertionError), 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")))
+
+
+def test_set_drop_unused_requests(tmpdir, httpbin):
+    my_vcr = vcr.VCR(drop_unused_requests=True)
+    file = str(tmpdir.join("test.yaml"))
+
+    with my_vcr.use_cassette(file):
+        urlopen(httpbin.url)
+        urlopen(httpbin.url + "/get")
+
+    cassette = Cassette.load(path=file)
+    assert len(cassette) == 2
+
+    with my_vcr.use_cassette(file):
+        urlopen(httpbin.url)
+
+    cassette = Cassette.load(path=file)
+    assert len(cassette) == 1

tests/integration/test_filter.py

@@ -7,6 +7,7 @@ from urllib.request import Request, urlopen
 import pytest
 
 import vcr
+from vcr.filters import brotli
 
 from ..assertions import assert_cassette_has_one_response, assert_is_json_bytes
 
@@ -138,6 +139,22 @@ def test_decompress_deflate(tmpdir, httpbin):
     assert_is_json_bytes(decoded_response)
 
 
+def test_decompress_brotli(tmpdir, httpbin):
+    if brotli is None:
+        # XXX: this is never true, because brotlipy is installed with "httpbin"
+        pytest.skip("Brotli is not installed")
+
+    url = httpbin.url + "/brotli"
+    request = Request(url, headers={"Accept-Encoding": ["gzip, deflate, br"]})
+    cass_file = str(tmpdir.join("brotli_response.yaml"))
+    with vcr.use_cassette(cass_file, decode_compressed_response=True):
+        urlopen(request)
+    with vcr.use_cassette(cass_file) as cass:
+        decoded_response = urlopen(url).read()
+        assert_cassette_has_one_response(cass)
+    assert_is_json_bytes(decoded_response)
+
+
 def test_decompress_regular(tmpdir, httpbin):
     """Test that it doesn't try to decompress content that isn't compressed"""
     url = httpbin.url + "/get"

tests/integration/test_httpx.py

@@ -60,9 +60,8 @@ class DoSyncRequest(BaseDoRequest):
                 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())
+        with self, self.client.stream(*args, **kwargs) as response:
+            return b"".join(response.iter_bytes())
 
 
 class DoAsyncRequest(BaseDoRequest):
@@ -195,9 +194,11 @@ def test_params_same_url_distinct_params(tmpdir, httpbin, do_request):
         assert cassette.play_count == 1
 
     params = {"other": "params"}
-    with vcr.use_cassette(str(tmpdir.join("get.yaml"))) as cassette:
-        with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-            do_request()("GET", url, params=params, headers=headers)
+    with (
+        vcr.use_cassette(str(tmpdir.join("get.yaml"))) as cassette,
+        pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException),
+    ):
+        do_request()("GET", url, params=params, headers=headers)
 
 
 @pytest.mark.online

tests/integration/test_matchers.py

@@ -51,9 +51,11 @@ def test_matchers(httpbin, httpbin_secure, cassette, matcher, matching_uri, not_
         assert cass.play_count == 1
 
     # play cassette with not matching on uri, it should fail
-    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-        with vcr.use_cassette(cassette, match_on=[matcher]) as cass:
-            urlopen(not_matching_uri)
+    with (
+        pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException),
+        vcr.use_cassette(cassette, match_on=[matcher]) as cass,
+    ):
+        urlopen(not_matching_uri)
 
 
 def test_method_matcher(cassette, httpbin, httpbin_secure):
@@ -65,10 +67,12 @@ def test_method_matcher(cassette, httpbin, httpbin_secure):
         assert cass.play_count == 1
 
     # should fail if method does not match
-    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-        with vcr.use_cassette(cassette, match_on=["method"]) as cass:
-            # is a POST request
-            urlopen(default_uri, data=b"")
+    with (
+        pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException),
+        vcr.use_cassette(cassette, match_on=["method"]) as cass,
+    ):
+        # is a POST request
+        urlopen(default_uri, data=b"")
 
 
 @pytest.mark.parametrize(
@@ -98,14 +102,12 @@ def test_default_matcher_matches(cassette, uri, httpbin, httpbin_secure):
 )
 def test_default_matcher_does_not_match(cassette, uri, httpbin, httpbin_secure):
     uri = _replace_httpbin(uri, httpbin, httpbin_secure)
-    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-        with vcr.use_cassette(cassette):
-            urlopen(uri)
+    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException), vcr.use_cassette(cassette):
+        urlopen(uri)
 
 
 def test_default_matcher_does_not_match_on_method(cassette, httpbin, httpbin_secure):
     default_uri = _replace_httpbin(DEFAULT_URI, httpbin, httpbin_secure)
-    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException):
-        with vcr.use_cassette(cassette):
-            # is a POST request
-            urlopen(default_uri, data=b"")
+    with pytest.raises(vcr.errors.CannotOverwriteExistingCassetteException), vcr.use_cassette(cassette):
+        # is a POST request
+        urlopen(default_uri, data=b"")

tests/integration/test_proxy.py

@@ -1,5 +1,6 @@
 """Test using a proxy."""
 
+import asyncio
 import http.server
 import socketserver
 import threading
@@ -36,6 +37,35 @@ class Proxy(http.server.SimpleHTTPRequestHandler):
         self.end_headers()
         self.copyfile(upstream_response, self.wfile)
 
+    def do_CONNECT(self):
+        host, port = self.path.split(":")
+
+        asyncio.run(self._tunnel(host, port, self.connection))
+
+    async def _tunnel(self, host, port, client_sock):
+        target_r, target_w = await asyncio.open_connection(host=host, port=port)
+
+        self.send_response(http.HTTPStatus.OK)
+        self.end_headers()
+
+        source_r, source_w = await asyncio.open_connection(sock=client_sock)
+
+        async def channel(reader, writer):
+            while True:
+                data = await reader.read(1024)
+                if not data:
+                    break
+                writer.write(data)
+                await writer.drain()
+
+            writer.close()
+            await writer.wait_closed()
+
+        await asyncio.gather(
+            channel(target_r, source_w),
+            channel(source_r, target_w),
+        )
+
 
 @pytest.fixture(scope="session")
 def proxy_server():
@@ -52,10 +82,26 @@ 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")), mode="once") as cassette:
+    with vcr.use_cassette(str(tmpdir.join("proxy.yaml")), mode="none") 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
+
+
+def test_use_https_proxy(tmpdir, httpbin_secure, proxy_server):
+    """Ensure that it works with an HTTPS proxy."""
+    with vcr.use_cassette(str(tmpdir.join("proxy.yaml"))):
+        response = requests.get(httpbin_secure.url, proxies={"https": proxy_server})
+
+    with vcr.use_cassette(str(tmpdir.join("proxy.yaml")), mode="none") as cassette:
+        cassette_response = requests.get(
+            httpbin_secure.url,
+            proxies={"https": proxy_server},
+        )
+
+    assert cassette_response.headers == response.headers
+    assert cassette.play_count == 1
+
+    # The cassette URL points to httpbin, not the proxy
+    assert cassette.requests[0].url == httpbin_secure.url + "/"

tests/integration/test_record_mode.py

@@ -124,9 +124,11 @@ def test_none_record_mode(tmpdir, httpbin):
     # Cassette file doesn't exist, yet we are trying to make a request.
     # raise hell.
     testfile = str(tmpdir.join("recordmode.yml"))
-    with vcr.use_cassette(testfile, record_mode=vcr.mode.NONE):
-        with pytest.raises(CannotOverwriteExistingCassetteException):
-            urlopen(httpbin.url).read()
+    with (
+        vcr.use_cassette(testfile, record_mode=vcr.mode.NONE),
+        pytest.raises(CannotOverwriteExistingCassetteException),
+    ):
+        urlopen(httpbin.url).read()
 
 
 def test_none_record_mode_with_existing_cassette(tmpdir, httpbin):

tests/integration/test_register_persister.py

@@ -83,6 +83,5 @@ def test_load_cassette_persister_exception_handling(tmpdir, httpbin):
     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
+    with pytest.raises(ValueError), my_vcr.use_cassette("bad/buggy") as cass:
+        pass

tests/integration/test_stubs.py

@@ -66,7 +66,7 @@ def test_original_decoded_response_is_not_modified(tmpdir, httpbin):
 
         # Assert that we do not modify the original response while appending
         # to the cassette.
-        assert "gzip" == inside.headers["content-encoding"]
+        assert inside.headers["content-encoding"] == "gzip"
 
         # They should effectively be the same response.
         inside_headers = (h for h in inside.headers.items() if h[0].lower() != "date")
@@ -122,7 +122,7 @@ def test_original_response_is_not_modified_by_before_filter(tmpdir, httpbin):
         # Furthermore, the responses should be identical.
         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] != replacement
         assert inside_body[field_to_scrub] == outside_body[field_to_scrub]
 
     # Ensure that when a cassette exists, the scrubbed response is returned.

tests/integration/test_tornado.py

@@ -4,6 +4,8 @@ import asyncio
 import functools
 import inspect
 import json
+import os
+import ssl
 
 import pytest
 
@@ -36,23 +38,23 @@ def gen_test(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"])
 def get_client(request):
+    ca_bundle_path = os.environ.get("REQUESTS_CA_BUNDLE")
+    ssl_ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH)
+    ssl_ctx.load_verify_locations(cafile=ca_bundle_path)
+    ssl_ctx.verify_mode = ssl.CERT_REQUIRED
+
     if request.param == "simple":
         from tornado import simple_httpclient as simple
 
-        return lambda: simple.SimpleAsyncHTTPClient()
-    elif request.param == "curl":
+        return lambda: simple.SimpleAsyncHTTPClient(defaults={"ssl_options": ssl_ctx})
+
+    if request.param == "curl":
         curl = pytest.importorskip("tornado.curl_httpclient")
-        return lambda: curl.CurlAsyncHTTPClient()
-    else:
-        return lambda: http.AsyncHTTPClient()
+        return lambda: curl.CurlAsyncHTTPClient(defaults={"ca_certs": ca_bundle_path})
+
+    return lambda: http.AsyncHTTPClient(defaults={"ssl_options": ssl_ctx})
 
 
 def get(client, url, **kwargs):
@@ -71,42 +73,42 @@ def post(client, url, data=None, **kwargs):
 
 @pytest.mark.online
 @gen_test
-def test_status_code(get_client, scheme, tmpdir):
+def test_status_code(get_client, tmpdir, httpbin_both):
     """Ensure that we can read the status code"""
-    url = scheme + "://httpbin.org/"
+    url = httpbin_both.url
     with vcr.use_cassette(str(tmpdir.join("atts.yaml"))):
         status_code = (yield get(get_client(), url)).code
 
     with vcr.use_cassette(str(tmpdir.join("atts.yaml"))) as cass:
         assert status_code == (yield get(get_client(), url)).code
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_headers(get_client, scheme, tmpdir):
+def test_headers(get_client, httpbin_both, tmpdir):
     """Ensure that we can read the headers back"""
-    url = scheme + "://httpbin.org/"
+    url = httpbin_both.url
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
         headers = (yield get(get_client(), url)).headers
 
     with vcr.use_cassette(str(tmpdir.join("headers.yaml"))) as cass:
         assert headers == (yield get(get_client(), url)).headers
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_body(get_client, tmpdir, scheme):
+def test_body(get_client, tmpdir, httpbin_both):
     """Ensure the responses are all identical enough"""
 
-    url = scheme + "://httpbin.org/bytes/1024"
+    url = httpbin_both.url + "/bytes/1024"
     with vcr.use_cassette(str(tmpdir.join("body.yaml"))):
         content = (yield get(get_client(), url)).body
 
     with vcr.use_cassette(str(tmpdir.join("body.yaml"))) as cass:
         assert content == (yield get(get_client(), url)).body
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @gen_test
@@ -119,15 +121,15 @@ def test_effective_url(get_client, tmpdir, httpbin):
 
     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
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_auth(get_client, tmpdir, scheme):
+def test_auth(get_client, tmpdir, httpbin_both):
     """Ensure that we can handle basic auth"""
     auth = ("user", "passwd")
-    url = scheme + "://httpbin.org/basic-auth/user/passwd"
+    url = httpbin_both.url + "/basic-auth/user/passwd"
     with vcr.use_cassette(str(tmpdir.join("auth.yaml"))):
         one = yield get(get_client(), url, auth_username=auth[0], auth_password=auth[1])
 
@@ -135,15 +137,15 @@ def test_auth(get_client, tmpdir, scheme):
         two = yield get(get_client(), url, auth_username=auth[0], auth_password=auth[1])
         assert one.body == two.body
         assert one.code == two.code
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_auth_failed(get_client, tmpdir, scheme):
+def test_auth_failed(get_client, tmpdir, httpbin_both):
     """Ensure that we can save failed auth statuses"""
     auth = ("user", "wrongwrongwrong")
-    url = scheme + "://httpbin.org/basic-auth/user/passwd"
+    url = httpbin_both.url + "/basic-auth/user/passwd"
     with vcr.use_cassette(str(tmpdir.join("auth-failed.yaml"))) as cass:
         # Ensure that this is empty to begin with
         assert_cassette_empty(cass)
@@ -159,15 +161,15 @@ def test_auth_failed(get_client, tmpdir, scheme):
         assert exc_info.value.code == 401
         assert one.body == two.body
         assert one.code == two.code == 401
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_post(get_client, tmpdir, scheme):
+def test_post(get_client, tmpdir, httpbin_both):
     """Ensure that we can post and cache the results"""
     data = {"key1": "value1", "key2": "value2"}
-    url = scheme + "://httpbin.org/post"
+    url = httpbin_both.url + "/post"
     with vcr.use_cassette(str(tmpdir.join("requests.yaml"))):
         req1 = (yield post(get_client(), url, data)).body
 
@@ -175,7 +177,7 @@ def test_post(get_client, tmpdir, scheme):
         req2 = (yield post(get_client(), url, data)).body
 
     assert req1 == req2
-    assert 1 == cass.play_count
+    assert cass.play_count == 1
 
 
 @gen_test
@@ -192,32 +194,36 @@ def test_redirects(get_client, tmpdir, httpbin):
 
 @pytest.mark.online
 @gen_test
-def test_cross_scheme(get_client, tmpdir, scheme):
+def test_cross_scheme(get_client, tmpdir, httpbin, httpbin_secure):
     """Ensure that requests between schemes are treated separately"""
     # First fetch a url under http, and then again under https and then
     # ensure that we haven't served anything out of cache, and we have two
     # requests / response pairs in the cassette
+
+    url = httpbin.url
+    url_secure = httpbin_secure.url
+
     with vcr.use_cassette(str(tmpdir.join("cross_scheme.yaml"))) as cass:
-        yield get(get_client(), "https://httpbin.org/")
-        yield get(get_client(), "http://httpbin.org/")
+        yield get(get_client(), url)
+        yield get(get_client(), url_secure)
         assert cass.play_count == 0
         assert len(cass) == 2
 
     # Then repeat the same requests and ensure both were replayed.
     with vcr.use_cassette(str(tmpdir.join("cross_scheme.yaml"))) as cass:
-        yield get(get_client(), "https://httpbin.org/")
-        yield get(get_client(), "http://httpbin.org/")
+        yield get(get_client(), url)
+        yield get(get_client(), url_secure)
         assert cass.play_count == 2
 
 
 @pytest.mark.online
 @gen_test
-def test_gzip(get_client, tmpdir, scheme):
+def test_gzip(get_client, tmpdir, httpbin_both):
     """
     Ensure that httpclient is able to automatically decompress the response
     body
     """
-    url = scheme + "://httpbin.org/gzip"
+    url = httpbin_both + "/gzip"
 
     # use_gzip was renamed to decompress_response in 4.0
     kwargs = {}
@@ -233,24 +239,26 @@ def test_gzip(get_client, tmpdir, scheme):
     with vcr.use_cassette(str(tmpdir.join("gzip.yaml"))) as cass:
         response = yield get(get_client(), url, **kwargs)
         assert_is_json_bytes(response.body)
-        assert 1 == cass.play_count
+        assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_https_with_cert_validation_disabled(get_client, tmpdir):
+def test_https_with_cert_validation_disabled(get_client, tmpdir, httpbin_secure):
     cass_path = str(tmpdir.join("cert_validation_disabled.yaml"))
 
+    url = httpbin_secure.url
+
     with vcr.use_cassette(cass_path):
-        yield get(get_client(), "https://httpbin.org", validate_cert=False)
+        yield get(get_client(), url, validate_cert=False)
 
     with vcr.use_cassette(cass_path) as cass:
-        yield get(get_client(), "https://httpbin.org", validate_cert=False)
-        assert 1 == cass.play_count
+        yield get(get_client(), url, validate_cert=False)
+        assert cass.play_count == 1
 
 
 @gen_test
-def test_unsupported_features_raises_in_future(get_client, tmpdir):
+def test_unsupported_features_raises_in_future(get_client, tmpdir, httpbin):
     """Ensure that the exception for an AsyncHTTPClient feature not being
     supported is raised inside the future."""
 
@@ -258,7 +266,7 @@ def test_unsupported_features_raises_in_future(get_client, tmpdir):
         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)
+        future = get(get_client(), httpbin.url, streaming_callback=callback)
 
     with pytest.raises(Exception) as excinfo:
         yield future
@@ -292,15 +300,17 @@ def test_unsupported_features_raise_error_disabled(get_client, tmpdir):
 
 @pytest.mark.online
 @gen_test
-def test_cannot_overwrite_cassette_raises_in_future(get_client, tmpdir):
+def test_cannot_overwrite_cassette_raises_in_future(get_client, tmpdir, httpbin):
     """Ensure that CannotOverwriteExistingCassetteException is raised inside
     the future."""
 
-    with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
-        yield get(get_client(), "http://httpbin.org/get")
+    url = httpbin.url
 
     with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
-        future = get(get_client(), "http://httpbin.org/headers")
+        yield get(get_client(), url + "/get")
+
+    with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
+        future = get(get_client(), url + "/headers")
 
     with pytest.raises(CannotOverwriteExistingCassetteException):
         yield future
@@ -312,15 +322,17 @@ def test_cannot_overwrite_cassette_raises_in_future(get_client, tmpdir):
     reason="raise_error only ignores HTTPErrors due to response code",
 )
 @gen_test
-def test_cannot_overwrite_cassette_raise_error_disabled(get_client, tmpdir):
+def test_cannot_overwrite_cassette_raise_error_disabled(get_client, tmpdir, httpbin):
     """Ensure that CannotOverwriteExistingCassetteException is not raised if
     raise_error=False in the fetch() call."""
 
-    with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
-        yield get(get_client(), "http://httpbin.org/get", raise_error=False)
+    url = httpbin.url
 
     with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
-        response = yield get(get_client(), "http://httpbin.org/headers", raise_error=False)
+        yield get(get_client(), url + "/get", raise_error=False)
+
+    with vcr.use_cassette(str(tmpdir.join("overwrite.yaml"))):
+        response = yield get(get_client(), url + "/headers", raise_error=False)
 
     assert isinstance(response.error, CannotOverwriteExistingCassetteException)
 
@@ -348,46 +360,51 @@ def test_tornado_exception_can_be_caught(get_client):
 
 @pytest.mark.online
 @gen_test
-def test_existing_references_get_patched(tmpdir):
+def test_existing_references_get_patched(tmpdir, httpbin):
     from tornado.httpclient import AsyncHTTPClient
 
+    url = httpbin.url + "/get"
+
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))):
         client = AsyncHTTPClient()
-        yield get(client, "http://httpbin.org/get")
+        yield get(client, url)
 
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))) as cass:
-        yield get(client, "http://httpbin.org/get")
+        yield get(client, url)
         assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_existing_instances_get_patched(get_client, tmpdir):
+def test_existing_instances_get_patched(get_client, tmpdir, httpbin):
     """Ensure that existing instances of AsyncHTTPClient get patched upon
     entering VCR context."""
 
+    url = httpbin.url + "/get"
     client = get_client()
 
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))):
-        yield get(client, "http://httpbin.org/get")
+        yield get(client, url)
 
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))) as cass:
-        yield get(client, "http://httpbin.org/get")
+        yield get(client, url)
         assert cass.play_count == 1
 
 
 @pytest.mark.online
 @gen_test
-def test_request_time_is_set(get_client, tmpdir):
+def test_request_time_is_set(get_client, tmpdir, httpbin):
     """Ensures that the request_time on HTTPResponses is set."""
 
+    url = httpbin.url + "/get"
+
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))):
         client = get_client()
-        response = yield get(client, "http://httpbin.org/get")
+        response = yield get(client, url)
         assert response.request_time is not None
 
     with vcr.use_cassette(str(tmpdir.join("data.yaml"))) as cass:
         client = get_client()
-        response = yield get(client, "http://httpbin.org/get")
+        response = yield get(client, url)
         assert response.request_time is not None
         assert cass.play_count == 1

tests/integration/test_urllib2.py

@@ -1,147 +0,0 @@
-"""Integration tests with urllib2"""
-
-import ssl
-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
-
-
-def urlopen_with_cafile(*args, **kwargs):
-    context = ssl.create_default_context(cafile=pytest_httpbin.certs.where())
-    context.check_hostname = False
-    kwargs["context"] = context
-    try:
-        return urlopen(*args, **kwargs)
-    except TypeError:
-        # python2/pypi don't let us override this
-        del kwargs["cafile"]
-        return urlopen(*args, **kwargs)
-
-
-def test_response_code(httpbin_both, tmpdir):
-    """Ensure we can read a response code from a fetch"""
-    url = httpbin_both.url
-    with vcr.use_cassette(str(tmpdir.join("atts.yaml"))):
-        code = urlopen_with_cafile(url).getcode()
-
-    with vcr.use_cassette(str(tmpdir.join("atts.yaml"))):
-        assert code == urlopen_with_cafile(url).getcode()
-
-
-def test_random_body(httpbin_both, tmpdir):
-    """Ensure we can read the content, and that it's served from cache"""
-    url = httpbin_both.url + "/bytes/1024"
-    with vcr.use_cassette(str(tmpdir.join("body.yaml"))):
-        body = urlopen_with_cafile(url).read()
-
-    with vcr.use_cassette(str(tmpdir.join("body.yaml"))):
-        assert body == urlopen_with_cafile(url).read()
-
-
-def test_response_headers(httpbin_both, tmpdir):
-    """Ensure we can get information from the response"""
-    url = httpbin_both.url
-    with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
-        open1 = urlopen_with_cafile(url).info().items()
-
-    with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
-        open2 = urlopen_with_cafile(url).info().items()
-
-        assert sorted(open1) == sorted(open2)
-
-
-@mark.online
-def test_effective_url(tmpdir, httpbin):
-    """Ensure that the effective_url is captured"""
-    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 == httpbin.url + "/"
-
-    with vcr.use_cassette(str(tmpdir.join("headers.yaml"))):
-        assert effective_url == urlopen_with_cafile(url).geturl()
-
-
-def test_multiple_requests(httpbin_both, tmpdir):
-    """Ensure that we can cache multiple requests"""
-    urls = [httpbin_both.url, httpbin_both.url, httpbin_both.url + "/get", httpbin_both.url + "/bytes/1024"]
-    with vcr.use_cassette(str(tmpdir.join("multiple.yaml"))) as cass:
-        [urlopen_with_cafile(url) for url in urls]
-    assert len(cass) == len(urls)
-
-
-def test_get_data(httpbin_both, tmpdir):
-    """Ensure that it works with query data"""
-    data = urlencode({"some": 1, "data": "here"})
-    url = httpbin_both.url + "/get?" + data
-    with vcr.use_cassette(str(tmpdir.join("get_data.yaml"))):
-        res1 = urlopen_with_cafile(url).read()
-
-    with vcr.use_cassette(str(tmpdir.join("get_data.yaml"))):
-        res2 = urlopen_with_cafile(url).read()
-    assert res1 == res2
-
-
-def test_post_data(httpbin_both, tmpdir):
-    """Ensure that it works when posting data"""
-    data = urlencode({"some": 1, "data": "here"}).encode("utf-8")
-    url = httpbin_both.url + "/post"
-    with vcr.use_cassette(str(tmpdir.join("post_data.yaml"))):
-        res1 = urlopen_with_cafile(url, data).read()
-
-    with vcr.use_cassette(str(tmpdir.join("post_data.yaml"))) as cass:
-        res2 = urlopen_with_cafile(url, data).read()
-        assert len(cass) == 1
-
-    assert res1 == res2
-    assert_cassette_has_one_response(cass)
-
-
-def test_post_unicode_data(httpbin_both, tmpdir):
-    """Ensure that it works when posting unicode data"""
-    data = urlencode({"snowman": "☃".encode()}).encode("utf-8")
-    url = httpbin_both.url + "/post"
-    with vcr.use_cassette(str(tmpdir.join("post_data.yaml"))):
-        res1 = urlopen_with_cafile(url, data).read()
-
-    with vcr.use_cassette(str(tmpdir.join("post_data.yaml"))) as cass:
-        res2 = urlopen_with_cafile(url, data).read()
-        assert len(cass) == 1
-
-    assert res1 == res2
-    assert_cassette_has_one_response(cass)
-
-
-def test_cross_scheme(tmpdir, httpbin_secure, httpbin):
-    """Ensure that requests between schemes are treated separately"""
-    # First fetch a url under https, and then again under https and then
-    # ensure that we haven't served anything out of cache, and we have two
-    # requests / response pairs in the cassette
-    with vcr.use_cassette(str(tmpdir.join("cross_scheme.yaml"))) as cass:
-        urlopen_with_cafile(httpbin_secure.url)
-        urlopen_with_cafile(httpbin.url)
-        assert len(cass) == 2
-        assert cass.play_count == 0
-
-
-def test_decorator(httpbin_both, tmpdir):
-    """Test the decorator version of VCR.py"""
-    url = httpbin_both.url
-
-    @vcr.use_cassette(str(tmpdir.join("atts.yaml")))
-    def inner1():
-        return urlopen_with_cafile(url).getcode()
-
-    @vcr.use_cassette(str(tmpdir.join("atts.yaml")))
-    def inner2():
-        return urlopen_with_cafile(url).getcode()
-
-    assert inner1() == inner2()

tests/integration/test_wild.py

@@ -62,13 +62,12 @@ def test_flickr_should_respond_with_200(tmpdir):
 
 def test_cookies(tmpdir, httpbin):
     testfile = str(tmpdir.join("cookies.yml"))
-    with vcr.use_cassette(testfile):
-        with requests.Session() as s:
-            s.get(httpbin.url + "/cookies/set?k1=v1&k2=v2")
-            assert s.cookies.keys() == ["k1", "k2"]
+    with vcr.use_cassette(testfile), 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 sorted(r2.json()["cookies"].keys()) == ["k1", "k2"]
+        r2 = s.get(httpbin.url + "/cookies")
+        assert sorted(r2.json()["cookies"].keys()) == ["k1", "k2"]
 
 
 @pytest.mark.online

tests/unit/test_cassettes.py

@@ -11,6 +11,7 @@ import yaml
 from vcr.cassette import Cassette
 from vcr.errors import UnhandledHTTPRequestError
 from vcr.patch import force_reset
+from vcr.request import Request
 from vcr.stubs import VCRHTTPSConnection
 
 
@@ -226,9 +227,11 @@ def test_nesting_cassette_context_managers(*args):
         assert_get_response_body_is("first_response")
 
         # Make sure a second cassette can supersede the first
-        with Cassette.use(path="test") as second_cassette:
-            with mock.patch.object(second_cassette, "play_response", return_value=second_response):
-                assert_get_response_body_is("second_response")
+        with (
+            Cassette.use(path="test") as second_cassette,
+            mock.patch.object(second_cassette, "play_response", return_value=second_response),
+        ):
+            assert_get_response_body_is("second_response")
 
         # Now the first cassette should be back in effect
         assert_get_response_body_is("first_response")
@@ -410,3 +413,25 @@ def test_find_requests_with_most_matches_many_similar_requests(mock_get_matchers
         (1, ["method", "path"], [("query", "failed : query")]),
         (3, ["method", "path"], [("query", "failed : query")]),
     ]
+
+
+def test_used_interactions(tmpdir):
+    interactions = [
+        {"request": {"body": "", "uri": "foo1", "method": "GET", "headers": {}}, "response": "bar1"},
+        {"request": {"body": "", "uri": "foo2", "method": "GET", "headers": {}}, "response": "bar2"},
+        {"request": {"body": "", "uri": "foo3", "method": "GET", "headers": {}}, "response": "bar3"},
+    ]
+    file = tmpdir.join("test_cassette.yml")
+    file.write(yaml.dump({"interactions": [interactions[0], interactions[1]]}))
+
+    cassette = Cassette.load(path=str(file))
+    request = Request._from_dict(interactions[1]["request"])
+    cassette.play_response(request)
+    assert len(cassette._played_interactions) < len(cassette._old_interactions)
+
+    request = Request._from_dict(interactions[2]["request"])
+    cassette.append(request, interactions[2]["response"])
+    assert len(cassette._new_interactions()) == 1
+
+    used_interactions = cassette._played_interactions + cassette._new_interactions()
+    assert len(used_interactions) == 2

tests/unit/test_serialize.py

@@ -8,15 +8,13 @@ from vcr.serializers import compat, jsonserializer, yamlserializer
 
 
 def test_deserialize_old_yaml_cassette():
-    with open("tests/fixtures/migration/old_cassette.yaml") as f:
-        with pytest.raises(ValueError):
-            deserialize(f.read(), yamlserializer)
+    with open("tests/fixtures/migration/old_cassette.yaml") as f, pytest.raises(ValueError):
+        deserialize(f.read(), yamlserializer)
 
 
 def test_deserialize_old_json_cassette():
-    with open("tests/fixtures/migration/old_cassette.json") as f:
-        with pytest.raises(ValueError):
-            deserialize(f.read(), jsonserializer)
+    with open("tests/fixtures/migration/old_cassette.json") as f, pytest.raises(ValueError):
+        deserialize(f.read(), jsonserializer)
 
 
 def test_deserialize_new_yaml_cassette():
@@ -76,7 +74,7 @@ def test_deserialize_py2py3_yaml_cassette(tmpdir, req_body, expect):
     cfile = tmpdir.join("test_cassette.yaml")
     cfile.write(REQBODY_TEMPLATE.format(req_body=req_body))
     with open(str(cfile)) as f:
-        (requests, responses) = deserialize(f.read(), yamlserializer)
+        (requests, _) = deserialize(f.read(), yamlserializer)
     assert requests[0].body == expect
 
 

tests/unit/test_unittest.py

@@ -178,7 +178,7 @@ def test_testcase_playback(tmpdir):
             return str(cassette_dir)
 
     test = run_testcase(MyTest)[0][0]
-    assert b"illustrative examples" in test.response
+    assert b"Example Domain" in test.response
     assert len(test.cassette.requests) == 1
     assert test.cassette.play_count == 0
 
@@ -186,7 +186,7 @@ def test_testcase_playback(tmpdir):
 
     test2 = run_testcase(MyTest)[0][0]
     assert test.cassette is not test2.cassette
-    assert b"illustrative examples" in test.response
+    assert b"Example Domain" in test.response
     assert len(test2.cassette.requests) == 1
     assert test2.cassette.play_count == 1
 

vcr/__init__.py

@@ -4,7 +4,7 @@ from logging import NullHandler
 from .config import VCR
 from .record_mode import RecordMode as mode  # noqa: F401
 
-__version__ = "7.0.0"
+__version__ = "8.0.0"
 
 logging.getLogger(__name__).addHandler(NullHandler())
 

vcr/cassette.py

@@ -3,7 +3,7 @@ import contextlib
 import copy
 import inspect
 import logging
-from asyncio import iscoroutinefunction
+from inspect import iscoroutinefunction
 
 import wrapt
 
@@ -177,6 +177,7 @@ class Cassette:
         custom_patches=(),
         inject=False,
         allow_playback_repeats=False,
+        drop_unused_requests=False,
     ):
         self._persister = persister or FilesystemPersister
         self._path = path
@@ -189,6 +190,7 @@ class Cassette:
         self.record_mode = record_mode
         self.custom_patches = custom_patches
         self.allow_playback_repeats = allow_playback_repeats
+        self.drop_unused_requests = drop_unused_requests
 
         # self.data is the list of (req, resp) tuples
         self.data = []
@@ -196,6 +198,10 @@ class Cassette:
         self.dirty = False
         self.rewound = False
 
+        # Subsets of self.data to store old and played interactions
+        self._old_interactions = []
+        self._played_interactions = []
+
     @property
     def play_count(self):
         return sum(self.play_counts.values())
@@ -219,10 +225,10 @@ class Cassette:
 
     def append(self, request, response):
         """Add a request, response pair to this cassette"""
-        log.info("Appending request %s and response %s", request, response)
         request = self._before_record_request(request)
         if not request:
             return
+        log.info("Appending request %s and response %s", request, response)
         # Deepcopy is here because mutation of `response` will corrupt the
         # real response.
         response = copy.deepcopy(response)
@@ -257,6 +263,7 @@ class Cassette:
         for index, response in self._responses(request):
             if self.play_counts[index] == 0 or self.allow_playback_repeats:
                 self.play_counts[index] += 1
+                self._played_interactions.append((request, response))
                 return response
         # The cassette doesn't contain the request asked for.
         raise UnhandledHTTPRequestError(
@@ -317,19 +324,44 @@ class Cassette:
 
         return final_best_matches
 
+    def _new_interactions(self):
+        """List of new HTTP interactions (request/response tuples)"""
+        new_interactions = []
+        for request, response in self.data:
+            if all(
+                not requests_match(request, old_request, self._match_on)
+                for old_request, _ in self._old_interactions
+            ):
+                new_interactions.append((request, response))
+        return new_interactions
+
     def _as_dict(self):
         return {"requests": self.requests, "responses": self.responses}
 
+    def _build_used_interactions_dict(self):
+        interactions = self._played_interactions + self._new_interactions()
+        cassete_dict = {
+            "requests": [request for request, _ in interactions],
+            "responses": [response for _, response in interactions],
+        }
+        return cassete_dict
+
     def _save(self, force=False):
+        if self.drop_unused_requests and len(self._played_interactions) < len(self._old_interactions):
+            cassete_dict = self._build_used_interactions_dict()
+            force = True
+        else:
+            cassete_dict = self._as_dict()
         if force or self.dirty:
-            self._persister.save_cassette(self._path, self._as_dict(), serializer=self._serializer)
+            self._persister.save_cassette(self._path, cassete_dict, serializer=self._serializer)
             self.dirty = False
 
     def _load(self):
         try:
             requests, responses = self._persister.load_cassette(self._path, serializer=self._serializer)
-            for request, response in zip(requests, responses):
+            for request, response in zip(requests, responses, strict=False):
                 self.append(request, response)
+                self._old_interactions.append((request, response))
             self.dirty = False
             self.rewound = True
         except (CassetteDecodeError, CassetteNotFoundError):

vcr/config.py

@@ -48,6 +48,7 @@ class VCR:
         func_path_generator=None,
         decode_compressed_response=False,
         record_on_exception=True,
+        drop_unused_requests=False,
     ):
         self.serializer = serializer
         self.match_on = match_on
@@ -81,6 +82,7 @@ class VCR:
         self.decode_compressed_response = decode_compressed_response
         self.record_on_exception = record_on_exception
         self._custom_patches = tuple(custom_patches)
+        self.drop_unused_requests = drop_unused_requests
 
     def _get_serializer(self, serializer_name):
         try:
@@ -151,6 +153,7 @@ class VCR:
             "func_path_generator": func_path_generator,
             "allow_playback_repeats": kwargs.get("allow_playback_repeats", False),
             "record_on_exception": record_on_exception,
+            "drop_unused_requests": kwargs.get("drop_unused_requests", self.drop_unused_requests),
         }
         path = kwargs.get("path")
         if path:

vcr/filters.py

@@ -6,6 +6,49 @@ from urllib.parse import urlencode, urlparse, urlunparse
 
 from .util import CaseInsensitiveDict
 
+try:
+    # This supports both brotli & brotlipy packages
+    import brotli
+except ImportError:
+    try:
+        import brotlicffi as brotli
+    except ImportError:
+        brotli = None
+
+
+def decompress_deflate(body):
+    try:
+        return zlib.decompress(body)
+    except zlib.error:
+        # Assume the response was already decompressed
+        return body
+
+
+def decompress_gzip(body):
+    # To (de-)compress gzip format, use wbits = zlib.MAX_WBITS | 16.
+    try:
+        return zlib.decompress(body, zlib.MAX_WBITS | 16)
+    except zlib.error:
+        # Assume the response was already decompressed
+        return body
+
+
+AVAILABLE_DECOMPRESSORS = {
+    "deflate": decompress_deflate,
+    "gzip": decompress_gzip,
+}
+
+if brotli is not None:
+
+    def decompress_brotli(body):
+        try:
+            return brotli.decompress(body)
+        except brotli.error:
+            # Assume the response was already decompressed
+            return body
+
+    AVAILABLE_DECOMPRESSORS["br"] = decompress_brotli
+
 
 def replace_headers(request, replacements):
     """Replace headers in request according to replacements.
@@ -136,45 +179,30 @@ def remove_post_data_parameters(request, post_data_parameters_to_remove):
 
 def decode_response(response):
     """
-    If the response is compressed with gzip or deflate:
+    If the response is compressed with any supported compression (gzip,
+    deflate, br if available):
       1. decompress the response body
       2. delete the content-encoding header
       3. update content-length header to decompressed length
     """
 
-    def is_compressed(headers):
-        encoding = headers.get("content-encoding", [])
-        return encoding and encoding[0] in ("gzip", "deflate")
-
-    def decompress_body(body, encoding):
-        """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":
-            try:
-                return zlib.decompress(body, zlib.MAX_WBITS | 16)
-            except zlib.error:
-                return body  # assumes that the data was already decompressed
-        else:  # encoding == 'deflate'
-            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.
     response = copy.deepcopy(response)
     headers = CaseInsensitiveDict(response["headers"])
-    if is_compressed(headers):
-        encoding = headers["content-encoding"][0]
-        headers["content-encoding"].remove(encoding)
-        if not headers["content-encoding"]:
-            del headers["content-encoding"]
+    content_encoding = headers.get("content-encoding")
+    if not content_encoding:
+        return response
+    decompressor = AVAILABLE_DECOMPRESSORS.get(content_encoding[0])
+    if not decompressor:
+        return response
 
-        new_body = decompress_body(response["body"]["string"], encoding)
-        response["body"]["string"] = new_body
-        headers["content-length"] = [str(len(new_body))]
-        response["headers"] = dict(headers)
+    headers["content-encoding"].remove(content_encoding[0])
+    if not headers["content-encoding"]:
+        del headers["content-encoding"]
+
+    new_body = decompressor(response["body"]["string"])
+    response["body"]["string"] = new_body
+    headers["content-length"] = [str(len(new_body))]
+    response["headers"] = dict(headers)
     return response

vcr/matchers.py

@@ -162,7 +162,7 @@ def _get_transformers(request):
 
 
 def requests_match(r1, r2, matchers):
-    successes, failures = get_matchers_results(r1, r2, matchers)
+    _, failures = get_matchers_results(r1, r2, matchers)
     if failures:
         log.debug(f"Requests {r1} and {r2} differ.\nFailure details:\n{failures}")
     return len(failures) == 0

vcr/patch.py

@@ -92,12 +92,12 @@ else:
 
 
 try:
-    import httpx
+    import httpcore
 except ImportError:  # pragma: no cover
     pass
 else:
-    _HttpxSyncClient_send_single_request = httpx.Client._send_single_request
-    _HttpxAsyncClient_send_single_request = httpx.AsyncClient._send_single_request
+    _HttpcoreConnectionPool_handle_request = httpcore.ConnectionPool.handle_request
+    _HttpcoreAsyncConnectionPool_handle_async_request = httpcore.AsyncConnectionPool.handle_async_request
 
 
 class CassettePatcherBuilder:
@@ -121,7 +121,7 @@ class CassettePatcherBuilder:
             self._httplib2(),
             self._tornado(),
             self._aiohttp(),
-            self._httpx(),
+            self._httpcore(),
             self._build_patchers_from_mock_triples(self._cassette.custom_patches),
         )
 
@@ -304,19 +304,22 @@ class CassettePatcherBuilder:
             yield client.ClientSession, "_request", new_request
 
     @_build_patchers_from_mock_triples_decorator
-    def _httpx(self):
+    def _httpcore(self):
         try:
-            import httpx
+            import httpcore
         except ImportError:  # pragma: no cover
             return
         else:
-            from .stubs.httpx_stubs import async_vcr_send, sync_vcr_send
+            from .stubs.httpcore_stubs import vcr_handle_async_request, vcr_handle_request
 
-            new_async_client_send = async_vcr_send(self._cassette, _HttpxAsyncClient_send_single_request)
-            yield httpx.AsyncClient, "_send_single_request", new_async_client_send
+            new_handle_async_request = vcr_handle_async_request(
+                self._cassette,
+                _HttpcoreAsyncConnectionPool_handle_async_request,
+            )
+            yield httpcore.AsyncConnectionPool, "handle_async_request", new_handle_async_request
 
-            new_sync_client_send = sync_vcr_send(self._cassette, _HttpxSyncClient_send_single_request)
-            yield httpx.Client, "_send_single_request", new_sync_client_send
+            new_handle_request = vcr_handle_request(self._cassette, _HttpcoreConnectionPool_handle_request)
+            yield httpcore.ConnectionPool, "handle_request", new_handle_request
 
     def _urllib3_patchers(self, cpool, conn, stubs):
         http_connection_remover = ConnectionRemover(

vcr/request.py

@@ -1,5 +1,6 @@
 import logging
 import warnings
+from contextlib import suppress
 from io import BytesIO
 from urllib.parse import parse_qsl, urlparse
 
@@ -19,7 +20,12 @@ class Request:
         self._was_file = hasattr(body, "read")
         self._was_iter = _is_nonsequence_iterator(body)
         if self._was_file:
-            self.body = body.read()
+            if hasattr(body, "tell"):
+                tell = body.tell()
+                self.body = body.read()
+                body.seek(tell)
+            else:
+                self.body = body.read()
         elif self._was_iter:
             self.body = list(body)
         else:
@@ -27,6 +33,15 @@ class Request:
         self.headers = headers
         log.debug("Invoking Request %s", self.uri)
 
+    @property
+    def uri(self):
+        return self._uri
+
+    @uri.setter
+    def uri(self, uri):
+        self._uri = uri
+        self.parsed_uri = urlparse(uri)
+
     @property
     def headers(self):
         return self._headers
@@ -61,30 +76,28 @@ class Request:
 
     @property
     def scheme(self):
-        return urlparse(self.uri).scheme
+        return self.parsed_uri.scheme
 
     @property
     def host(self):
-        return urlparse(self.uri).hostname
+        return self.parsed_uri.hostname
 
     @property
     def port(self):
-        parse_uri = urlparse(self.uri)
-        port = parse_uri.port
+        port = self.parsed_uri.port
         if port is None:
-            try:
-                port = {"https": 443, "http": 80}[parse_uri.scheme]
-            except KeyError:
-                pass
+            with suppress(KeyError):
+                port = {"https": 443, "http": 80}[self.parsed_uri.scheme]
+
         return port
 
     @property
     def path(self):
-        return urlparse(self.uri).path
+        return self.parsed_uri.path
 
     @property
     def query(self):
-        q = urlparse(self.uri).query
+        q = self.parsed_uri.query
         return sorted(parse_qsl(q))
 
     # alias for backwards compatibility

vcr/serialize.py

@@ -53,7 +53,7 @@ def serialize(cassette_dict, serializer):
             "request": compat.convert_to_unicode(request._to_dict()),
             "response": compat.convert_to_unicode(response),
         }
-        for request, response in zip(cassette_dict["requests"], cassette_dict["responses"])
+        for request, response in zip(cassette_dict["requests"], cassette_dict["responses"], strict=False)
     ]
     data = {"version": CASSETTE_FORMAT_VERSION, "interactions": interactions}
     return serializer.serialize(data)

vcr/stubs/__init__.py

@@ -1,6 +1,7 @@
 """Stubs for patching HTTP and HTTPS requests"""
 
 import logging
+from contextlib import suppress
 from http.client import HTTPConnection, HTTPResponse, HTTPSConnection
 from io import BytesIO
 
@@ -77,7 +78,7 @@ class VCRHTTPResponse(HTTPResponse):
         # libraries trying to process a chunked response.  By removing the
         # transfer-encoding: chunked header, this should cause the downstream
         # libraries to process this as a non-chunked response.
-        te_key = [h for h in headers.keys() if h.upper() == "TRANSFER-ENCODING"]
+        te_key = [h for h in headers if h.upper() == "TRANSFER-ENCODING"]
         if te_key:
             del headers[te_key[0]]
         self.headers = self.msg = parse_headers(headers)
@@ -187,22 +188,34 @@ class VCRConnection:
         """
         Returns empty string for the default port and ':port' otherwise
         """
-        port = self.real_connection.port
+        port = (
+            self.real_connection.port
+            if not self.real_connection._tunnel_host
+            else self.real_connection._tunnel_port
+        )
         default_port = {"https": 443, "http": 80}[self._protocol]
         return f":{port}" if port != default_port else ""
 
+    def _real_host(self):
+        """Returns the request host"""
+        if self.real_connection._tunnel_host:
+            # The real connection is to an HTTPS proxy
+            return self.real_connection._tunnel_host
+        else:
+            return self.real_connection.host
+
     def _uri(self, url):
         """Returns request absolute URI"""
         if url and not url.startswith("/"):
             # Then this must be a proxy request.
             return url
-        uri = f"{self._protocol}://{self.real_connection.host}{self._port_postfix()}{url}"
+        uri = f"{self._protocol}://{self._real_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 = f"{self._protocol}://{self.real_connection.host}{self._port_postfix()}"
+        prefix = f"{self._protocol}://{self._real_host()}{self._port_postfix()}"
         return uri.replace(prefix, "", 1)
 
     def request(self, method, url, body=None, headers=None, *args, **kwargs):
@@ -358,12 +371,8 @@ class VCRConnection:
         TODO: Separately setting the attribute on the two instances is not
         ideal. We should switch to a proxying implementation.
         """
-        try:
+        with suppress(AttributeError):
             setattr(self.real_connection, name, value)
-        except AttributeError:
-            # raised if real_connection has not been set yet, such as when
-            # we're setting the real_connection itself for the first time
-            pass
 
         super().__setattr__(name, value)
 

vcr/stubs/aiohttp_stubs.py

@@ -6,7 +6,6 @@ import json
 import logging
 from collections.abc import Mapping
 from http.cookies import CookieError, Morsel, SimpleCookie
-from typing import Union
 
 from aiohttp import ClientConnectionError, ClientResponse, CookieJar, RequestInfo, hdrs, streams
 from aiohttp.helpers import strip_auth_from_url
@@ -230,7 +229,7 @@ def _build_cookie_header(session, cookies, cookie_header, url):
     return c.output(header="", sep=";").strip()
 
 
-def _build_url_with_params(url_str: str, params: Mapping[str, Union[str, int, float]]) -> URL:
+def _build_url_with_params(url_str: str, params: Mapping[str, str | int | float]) -> URL:
     # This code is basically a copy&paste of aiohttp.
     # https://github.com/aio-libs/aiohttp/blob/master/aiohttp/client_reqrep.py#L225
     url = URL(url_str)

vcr/stubs/httpcore_stubs.py

@@ -0,0 +1,215 @@
+import asyncio
+import functools
+import logging
+from collections import defaultdict
+from collections.abc import AsyncIterable, Iterable
+
+from httpcore import Response
+from httpcore._models import ByteStream
+
+from vcr.errors import CannotOverwriteExistingCassetteException
+from vcr.filters import decode_response
+from vcr.request import Request as VcrRequest
+from vcr.serializers.compat import convert_body_to_bytes
+
+_logger = logging.getLogger(__name__)
+
+
+async def _convert_byte_stream(stream):
+    if isinstance(stream, Iterable):
+        return list(stream)
+
+    if isinstance(stream, AsyncIterable):
+        return [part async for part in stream]
+
+    raise TypeError(
+        f"_convert_byte_stream: stream must be Iterable or AsyncIterable, got {type(stream).__name__}",
+    )
+
+
+def _serialize_headers(real_response):
+    """
+    Some headers can appear multiple times, like "Set-Cookie".
+    Therefore serialize every header key to a list of values.
+    """
+
+    headers = defaultdict(list)
+
+    for name, value in real_response.headers:
+        headers[name.decode("ascii")].append(value.decode("ascii"))
+
+    return dict(headers)
+
+
+async def _serialize_response(real_response):
+    # The reason_phrase may not exist
+    try:
+        reason_phrase = real_response.extensions["reason_phrase"].decode("ascii")
+    except KeyError:
+        reason_phrase = None
+
+    # Reading the response stream consumes the iterator, so we need to restore it afterwards
+    content = b"".join(await _convert_byte_stream(real_response.stream))
+    real_response.stream = ByteStream(content)
+
+    return {
+        "status": {"code": real_response.status, "message": reason_phrase},
+        "headers": _serialize_headers(real_response),
+        "body": {"string": content},
+    }
+
+
+def _deserialize_headers(headers):
+    """
+    httpcore accepts headers as list of tuples of header key and value.
+    """
+
+    return [
+        (name.encode("ascii"), value.encode("ascii")) for name, values in headers.items() for value in values
+    ]
+
+
+def _deserialize_response(vcr_response):
+    # 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 vcr_response:
+        vcr_response = decode_response(
+            convert_body_to_bytes(
+                {
+                    "headers": vcr_response["headers"],
+                    "body": {"string": vcr_response["content"]},
+                    "status": {"code": vcr_response["status_code"]},
+                },
+            ),
+        )
+        extensions = None
+    else:
+        extensions = (
+            {"reason_phrase": vcr_response["status"]["message"].encode("ascii")}
+            if vcr_response["status"]["message"]
+            else None
+        )
+
+    return Response(
+        vcr_response["status"]["code"],
+        headers=_deserialize_headers(vcr_response["headers"]),
+        content=vcr_response["body"]["string"],
+        extensions=extensions,
+    )
+
+
+async def _make_vcr_request(real_request):
+    # Reading the request stream consumes the iterator, so we need to restore it afterwards
+    body = b"".join(await _convert_byte_stream(real_request.stream))
+    real_request.stream = ByteStream(body)
+
+    uri = bytes(real_request.url).decode("ascii")
+
+    # As per HTTPX: If there are multiple headers with the same key, then we concatenate them with commas
+    headers = defaultdict(list)
+
+    for name, value in real_request.headers:
+        headers[name.decode("ascii")].append(value.decode("ascii"))
+
+    headers = {name: ", ".join(values) for name, values in headers.items()}
+
+    return VcrRequest(real_request.method.decode("ascii"), uri, body, headers)
+
+
+async def _vcr_request(cassette, real_request):
+    vcr_request = await _make_vcr_request(real_request)
+
+    if cassette.can_play_response_for(vcr_request):
+        return vcr_request, _play_responses(cassette, vcr_request)
+
+    if cassette.write_protected and cassette.filter_request(vcr_request):
+        raise CannotOverwriteExistingCassetteException(
+            cassette=cassette,
+            failed_request=vcr_request,
+        )
+
+    _logger.info("%s not in cassette, sending to real server", vcr_request)
+
+    return vcr_request, None
+
+
+async def _record_responses(cassette, vcr_request, real_response):
+    cassette.append(vcr_request, await _serialize_response(real_response))
+
+
+def _play_responses(cassette, vcr_request):
+    vcr_response = cassette.play_response(vcr_request)
+    real_response = _deserialize_response(vcr_response)
+
+    return real_response
+
+
+async def _vcr_handle_async_request(
+    cassette,
+    real_handle_async_request,
+    self,
+    real_request,
+):
+    vcr_request, vcr_response = await _vcr_request(cassette, real_request)
+
+    if vcr_response:
+        return vcr_response
+
+    real_response = await real_handle_async_request(self, real_request)
+    await _record_responses(cassette, vcr_request, real_response)
+
+    return real_response
+
+
+def vcr_handle_async_request(cassette, real_handle_async_request):
+    @functools.wraps(real_handle_async_request)
+    def _inner_handle_async_request(self, real_request):
+        return _vcr_handle_async_request(
+            cassette,
+            real_handle_async_request,
+            self,
+            real_request,
+        )
+
+    return _inner_handle_async_request
+
+
+def _run_async_function(sync_func, *args, **kwargs):
+    """
+    Safely run an asynchronous function from a synchronous context.
+    Handles both cases:
+    - An event loop is already running.
+    - No event loop exists yet.
+    """
+    try:
+        asyncio.get_running_loop()
+    except RuntimeError:
+        return asyncio.run(sync_func(*args, **kwargs))
+    else:
+        # If inside a running loop, create a task and wait for it
+        return asyncio.ensure_future(sync_func(*args, **kwargs))
+
+
+def _vcr_handle_request(cassette, real_handle_request, self, real_request):
+    vcr_request, vcr_response = _run_async_function(
+        _vcr_request,
+        cassette,
+        real_request,
+    )
+
+    if vcr_response:
+        return vcr_response
+
+    real_response = real_handle_request(self, real_request)
+    _run_async_function(_record_responses, cassette, vcr_request, real_response)
+
+    return real_response
+
+
+def vcr_handle_request(cassette, real_handle_request):
+    @functools.wraps(real_handle_request)
+    def _inner_handle_request(self, real_request):
+        return _vcr_handle_request(cassette, real_handle_request, self, real_request)
+
+    return _inner_handle_request

vcr/stubs/httpx_stubs.py

@@ -1,202 +0,0 @@
-import asyncio
-import functools
-import inspect
-import logging
-from unittest.mock import MagicMock, patch
-
-import httpx
-
-from vcr.errors import CannotOverwriteExistingCassetteException
-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)
-
-try:
-    HTTPX_REDIRECT_PARAM = _httpx_signature.parameters["follow_redirects"]
-except KeyError:
-    HTTPX_REDIRECT_PARAM = _httpx_signature.parameters["allow_redirects"]
-
-
-_logger = logging.getLogger(__name__)
-
-
-def _transform_headers(httpx_response):
-    """
-    Some headers can appear multiple times, like "Set-Cookie".
-    Therefore transform to every header key to list of values.
-    """
-
-    out = {}
-    for key, var in httpx_response.headers.raw:
-        decoded_key = key.decode("utf-8")
-        out.setdefault(decoded_key, [])
-        out[decoded_key].append(var.decode("utf-8"))
-    return out
-
-
-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):
-    """
-    httpx accepts headers as list of tuples of header key and value.
-    """
-
-    header_list = []
-    for key, values in headers.items():
-        for v in values:
-            header_list.append((key, v))
-    return header_list
-
-
-@patch("httpx.Response.close", MagicMock())
-@patch("httpx.Response.read", MagicMock())
-def _from_serialized_response(request, serialized_response, history=None):
-    # 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["status"]["code"],
-        request=request,
-        headers=_from_serialized_headers(serialized_response["headers"]),
-        content=serialized_response["body"]["string"],
-        history=history or [],
-        extensions=extensions,
-    )
-
-    return response
-
-
-def _make_vcr_request(httpx_request, **kwargs):
-    body = httpx_request.read().decode("utf-8")
-    uri = str(httpx_request.url)
-    headers = dict(httpx_request.headers)
-    return VcrRequest(httpx_request.method, uri, body, headers)
-
-
-def _shared_vcr_send(cassette, real_send, *args, **kwargs):
-    real_request = args[1]
-
-    vcr_request = _make_vcr_request(real_request, **kwargs)
-
-    if cassette.can_play_response_for(vcr_request):
-        return vcr_request, _play_responses(cassette, real_request, vcr_request, args[0], kwargs)
-
-    if cassette.write_protected and cassette.filter_request(vcr_request):
-        raise CannotOverwriteExistingCassetteException(cassette=cassette, failed_request=vcr_request)
-
-    _logger.info("%s not in cassette, sending to real server", vcr_request)
-    return vcr_request, None
-
-
-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, 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, await _to_serialized_response(real_response, aread))
-    return real_response
-
-
-def _play_responses(cassette, request, vcr_request, client, kwargs):
-    vcr_response = cassette.play_response(vcr_request)
-    response = _from_serialized_response(request, vcr_response)
-    return response
-
-
-async def _async_vcr_send(cassette, real_send, *args, **kwargs):
-    vcr_request, response = _shared_vcr_send(cassette, real_send, *args, **kwargs)
-    if response:
-        # add cookies from response to session cookie store
-        args[0].cookies.extract_cookies(response)
-        return response
-
-    real_response = await real_send(*args, **kwargs)
-    await _record_responses(cassette, vcr_request, real_response, aread=True)
-    return real_response
-
-
-def async_vcr_send(cassette, real_send):
-    @functools.wraps(real_send)
-    def _inner_send(*args, **kwargs):
-        return _async_vcr_send(cassette, real_send, *args, **kwargs)
-
-    return _inner_send
-
-
-def _run_async_function(sync_func, *args, **kwargs):
-    """
-    Safely run an asynchronous function from a synchronous context.
-    Handles both cases:
-    - An event loop is already running.
-    - No event loop exists yet.
-    """
-    try:
-        asyncio.get_running_loop()
-    except RuntimeError:
-        return asyncio.run(sync_func(*args, **kwargs))
-    else:
-        # If inside a running loop, create a task and wait for it
-        return asyncio.ensure_future(sync_func(*args, **kwargs))
-
-
-def _sync_vcr_send(cassette, real_send, *args, **kwargs):
-    vcr_request, response = _shared_vcr_send(cassette, real_send, *args, **kwargs)
-    if response:
-        # add cookies from response to session cookie store
-        args[0].cookies.extract_cookies(response)
-        return response
-
-    real_response = real_send(*args, **kwargs)
-    _run_async_function(_record_responses, cassette, vcr_request, real_response, aread=False)
-    return real_response
-
-
-def sync_vcr_send(cassette, real_send):
-    @functools.wraps(real_send)
-    def _inner_send(*args, **kwargs):
-        return _sync_vcr_send(cassette, real_send, *args, **kwargs)
-
-    return _inner_send

vcr/stubs/tornado_stubs.py

@@ -74,7 +74,7 @@ def vcr_fetch_impl(cassette, real_fetch_impl):
                 return callback(response)
 
             def new_callback(response):
-                headers = [(k, response.headers.get_list(k)) for k in response.headers.keys()]
+                headers = [(k, response.headers.get_list(k)) for k in response.headers]
 
                 vcr_response = {
                     "status": {"code": response.code, "message": response.reason},