Merge pull request #4341 from pallets/test-min-dev

test against minimum/dev versions of Pallets libraries

.github/workflows/tests.yaml

@@ -33,6 +33,8 @@ jobs:
           - {name: '3.7', python: '3.7', os: ubuntu-latest, tox: py37}
           - {name: '3.6', python: '3.6', os: ubuntu-latest, tox: py36}
           - {name: 'PyPy', python: 'pypy-3.7', os: ubuntu-latest, tox: pypy37}
+          - {name: 'Pallets Minimum Versions', python: '3.10', os: ubuntu-latest, tox: py-min}
+          - {name: 'Pallets Development Versions', python: '3.7', os: ubuntu-latest, tox: py-dev}
           - {name: Typing, python: '3.10', os: ubuntu-latest, tox: typing}
     steps:
       - uses: actions/checkout@v2

CHANGES.rst

@@ -1,5 +1,16 @@
 .. currentmodule:: flask
 
+Version 2.0.3
+-------------
+
+Unreleased
+
+-   The test client's ``as_tuple`` parameter is deprecated and will be
+    removed in Werkzeug 2.1. It is now also deprecated in Flask, to be
+    removed in Flask 2.1, while remaining compatible with both in
+    2.0.x. Use ``response.request.environ`` instead. :pr:`4341`
+
+
 Version 2.0.2
 -------------
 

requirements/dev.txt

@@ -38,7 +38,7 @@ filelock==3.3.2
     # via
     #   tox
     #   virtualenv
-greenlet==1.1.2
+greenlet==1.1.2 ; python_version < "3.11"
     # via -r requirements/tests.in
 identify==2.3.3
     # via pre-commit

requirements/tests-pallets-dev.in

@@ -0,0 +1,5 @@
+https://github.com/pallets/werkzeug/archive/refs/heads/main.tar.gz
+https://github.com/pallets/jinja/archive/refs/heads/main.tar.gz
+https://github.com/pallets/markupsafe/archive/refs/heads/main.tar.gz
+https://github.com/pallets/itsdangerous/archive/refs/heads/main.tar.gz
+https://github.com/pallets/click/archive/refs/heads/main.tar.gz

requirements/tests-pallets-dev.txt

@@ -0,0 +1,18 @@
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    pip-compile requirements/tests-pallets-dev.in
+#
+click @ https://github.com/pallets/click/archive/refs/heads/main.tar.gz
+    # via -r requirements/tests-pallets-dev.in
+itsdangerous @ https://github.com/pallets/itsdangerous/archive/refs/heads/main.tar.gz
+    # via -r requirements/tests-pallets-dev.in
+jinja2 @ https://github.com/pallets/jinja/archive/refs/heads/main.tar.gz
+    # via -r requirements/tests-pallets-dev.in
+markupsafe @ https://github.com/pallets/markupsafe/archive/refs/heads/main.tar.gz
+    # via
+    #   -r requirements/tests-pallets-dev.in
+    #   jinja2
+werkzeug @ https://github.com/pallets/werkzeug/archive/refs/heads/main.tar.gz
+    # via -r requirements/tests-pallets-dev.in

requirements/tests-pallets-min.in

@@ -0,0 +1,5 @@
+Werkzeug==2.0.0
+Jinja2==3.0.0
+MarkupSafe==2.0.0
+itsdangerous==2.0.0
+click==8.0.0

requirements/tests-pallets-min.txt

@@ -0,0 +1,18 @@
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    pip-compile requirements/tests-pallets-min.in
+#
+click==8.0.0
+    # via -r requirements/tests-pallets-min.in
+itsdangerous==2.0.0
+    # via -r requirements/tests-pallets-min.in
+jinja2==3.0.0
+    # via -r requirements/tests-pallets-min.in
+markupsafe==2.0.0
+    # via
+    #   -r requirements/tests-pallets-min.in
+    #   jinja2
+werkzeug==2.0.0
+    # via -r requirements/tests-pallets-min.in

requirements/tests.in

@@ -1,5 +1,5 @@
 pytest
 asgiref
 blinker
-greenlet
+greenlet ; python_version < "3.11"
 python-dotenv

requirements/tests.txt

@@ -10,7 +10,7 @@ attrs==21.2.0
     # via pytest
 blinker==1.4
     # via -r requirements/tests.in
-greenlet==1.1.2
+greenlet==1.1.2 ; python_version < "3.11"
     # via -r requirements/tests.in
 iniconfig==1.1.1
     # via pytest

src/flask/testing.py

@@ -9,14 +9,15 @@ from werkzeug.test import Client
 from werkzeug.urls import url_parse
 from werkzeug.wrappers import Request as BaseRequest
 
-from . import _request_ctx_stack
 from .cli import ScriptInfo
+from .globals import _request_ctx_stack
 from .json import dumps as json_dumps
 from .sessions import SessionMixin
 
 if t.TYPE_CHECKING:
+    from werkzeug.test import TestResponse
+
     from .app import Flask
-    from .wrappers import Response
 
 
 class EnvironBuilder(werkzeug.test.EnvironBuilder):
@@ -171,14 +172,15 @@ class FlaskClient(Client):
             headers = resp.get_wsgi_headers(c.request.environ)
             self.cookie_jar.extract_wsgi(c.request.environ, headers)
 
-    def open(  # type: ignore
+    def open(
         self,
         *args: t.Any,
-        as_tuple: bool = False,
         buffered: bool = False,
         follow_redirects: bool = False,
         **kwargs: t.Any,
-    ) -> "Response":
+    ) -> "TestResponse":
+        as_tuple = kwargs.pop("as_tuple", None)
+
         # Same logic as super.open, but apply environ_base and preserve_context.
         request = None
 
@@ -213,12 +215,28 @@ class FlaskClient(Client):
             finally:
                 builder.close()
 
-        return super().open(  # type: ignore
-            request,
-            as_tuple=as_tuple,
-            buffered=buffered,
-            follow_redirects=follow_redirects,
-        )
+        if as_tuple is not None:
+            import warnings
+
+            warnings.warn(
+                "'as_tuple' is deprecated and will be removed in"
+                " Werkzeug 2.1 and Flask 2.1. Use"
+                " 'response.request.environ' instead.",
+                DeprecationWarning,
+                stacklevel=3,
+            )
+            return super().open(
+                request,
+                as_tuple=as_tuple,
+                buffered=buffered,
+                follow_redirects=follow_redirects,
+            )
+        else:
+            return super().open(
+                request,
+                buffered=buffered,
+                follow_redirects=follow_redirects,
+            )
 
     def __enter__(self) -> "FlaskClient":
         if self.preserve_context:
@@ -272,7 +290,7 @@ class FlaskCliRunner(CliRunner):
         :return: a :class:`~click.testing.Result` object.
         """
         if cli is None:
-            cli = self.app.cli
+            cli = self.app.cli  # type: ignore
 
         if "obj" not in kwargs:
             kwargs["obj"] = ScriptInfo(create_app=lambda: self.app)

tox.ini

@@ -1,7 +1,9 @@
 [tox]
 envlist =
-    py3{11,10,9,8,7,6},pypy37
+    py3{11,10,9,8,7,6},pypy3{8,7}
     py39-click7
+    py310-min
+    py37-dev
     style
     typing
     docs
@@ -10,6 +12,8 @@ skip_missing_interpreters = true
 [testenv]
 deps =
     -r requirements/tests.txt
+    min: -r requirements/tests-pallets-min.txt
+    dev: -r requirements/tests-pallets-dev.txt
 
     click7: click<8