Merge pull request #3 from Significant-Gravitas/pull-upstream

Pull upstream

.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@v3
+      - 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@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - 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,24 +5,18 @@ 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", "3.11", "pypy-3.8"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "pypy-3.8"]
 
     steps:
-      - name: Install libgnutls28-dev
-        run: |
-          sudo apt update -q
-          sudo apt install -q -y libgnutls28-dev libcurl4-gnutls-dev
-
-      - uses: actions/[email protected]
+      - uses: actions/[email protected]
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
@@ -31,11 +25,19 @@ jobs:
 
       - name: Install project dependencies
         run: |
-          pip install --upgrade pip
-          pip install codecov tox tox-gh-actions
+          pip3 install --upgrade pip
+          pip3 install codecov tox tox-gh-actions
 
-      - name: Run tests with tox
-        run: tox
+      - name: Run online tests with tox
+        run: tox -- -m online
+
+      - name: Run offline tests with tox with no access to the Internet
+        run: |
+          # We're using unshare to take Internet access
+          # away from tox 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; tox -- -m "not online"'
 
       - name: Run coverage
         run: codecov

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .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.11"
+
+# 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

docs/advanced.rst

@@ -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
@@ -411,7 +412,7 @@ 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 succeedes, set the Cassette
+If you want to save the cassette only when the test succeeds, set the Cassette
 ``record_on_exception`` option to ``False``.
 
 .. code:: python

docs/changelog.rst

@@ -7,6 +7,45 @@ 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.
 
+-  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

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.

docs/contributing.rst

@@ -74,7 +74,7 @@ The PR reviewer is a second set of eyes to see if:
 **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/
 
@@ -96,11 +96,11 @@ The test suite is pretty big and slow, but you can tell tox to only run specific
 
     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
+    tox -e py38-requests -- -v -k "'test_status_code or test_gzip'"
+    tox -e py38-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
+``test_gzip`` in the test suite, and only in the python 3.8 environment
 that has ``requests`` installed.
 
 Also, in order for the boto tests to run, you will need an AWS key.
@@ -127,20 +127,20 @@ in this example::
     eval "$(pyenv init -)"
 
     # Setup your local system tox tooling
-    pip install tox tox-pyenv
+    pip3 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.8.0 pypy3.8
 
     # This activates them
-    pyenv local 3.7.5 3.8.0 pypy3.8
+    pyenv local 3.8.0 pypy3.8
 
     # Run the whole test suite
     tox
 
     # Run the whole test suite or just part of it
     tox -e lint
-    tox -e py37-requests
+    tox -e py38-requests
 
 
 Troubleshooting on MacOSX

docs/installation.rst

@@ -4,12 +4,12 @@ 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:
 
@@ -18,7 +18,7 @@ The following HTTP libraries are supported:
 -  ``boto3``
 -  ``http.client``
 -  ``httplib2``
--  ``requests`` (both 1.x and 2.x versions)
+-  ``requests`` (>=2.16.2 versions)
 -  ``tornado.httpclient``
 -  ``urllib2``
 -  ``urllib3``
@@ -35,7 +35,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 +46,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 +61,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==1.2.2