FlaskTester 5.1__tar.gz → 6.0__tar.gz

{flasktester-5.1 → flasktester-6.0}/FlaskTester.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FlaskTester
-Version: 5.1
+Version: 6.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License-Expression: CC0-1.0
@@ -25,6 +25,7 @@ Requires-Dist: pyright; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt!=0.9.5; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 Requires-Dist: types-flask; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: FlaskSimpleAuth>=35.0; extra == "dev"

{flasktester-5.1 → flasktester-6.0}/FlaskTester.egg-info/requires.txt

@@ -7,6 +7,7 @@ pyright
 ruff
 coverage
 pymarkdownlnt!=0.9.5
+flake8
 types-flask
 types-requests
 FlaskSimpleAuth>=35.0

{flasktester-5.1 → flasktester-6.0}/FlaskTester.py

@@ -7,7 +7,8 @@ import os
 import io
 import re
 # Python >= 3.11: Self
-from typing import Any, Callable
+from typing import Any
+from collections.abc import Callable
 import importlib
 import logging
 import pytest  # for explicit fail calls, see _pytestFail
@@ -90,23 +91,26 @@ class Authenticator:
     _AUTH_SCHEMES.update(_TOKEN_SCHEMES)
     _AUTH_SCHEMES.update(_PASS_SCHEMES)
 
+    # should not be mutable
+    _AUTH_DEFAULT_SCHEMES = ["bearer", "basic", "param", "none"]
+
     # authenticator login/pass hook
     _AuthHook = Callable[[str, str|None], None]
 
     def __init__(self,
-             allow: list[str] = ["bearer", "basic", "param", "none"],
-             # parameter names for "basic" and "param"
-             user: str = "USER",
-             pwd: str = "PASS",
-             # parameter name for "fake"
-             login: str = "LOGIN",
-             # 4 token options
-             bearer: str = "Bearer",
-             header: str = "Auth",
-             cookie: str = "auth",
-             tparam: str = "AUTH",
-             ptype: str = "data",
-         ):
+            allow: list[str] = _AUTH_DEFAULT_SCHEMES,
+            # parameter names for "basic" and "param"
+            user: str = "USER",
+            pwd: str = "PASS",
+            # parameter name for "fake"
+            login: str = "LOGIN",
+            # 4 token options
+            bearer: str = "Bearer",
+            header: str = "Auth",
+            cookie: str = "auth",
+            tparam: str = "AUTH",
+            ptype: str = "data",
+        ):
 
         self._has_pass, self._has_token = False, False
         for auth in allow:
@@ -139,8 +143,7 @@ class Authenticator:
     def _set(self, key: str, val: str|None, store: dict[str, str]):
         """Set a key/value in a directory, with None for delete."""
         if val is None:
-            if key in store:
-                del store[key]
+            store.pop(key, None)
         else:
             assert isinstance(val, str)
             store[key] = val
@@ -315,6 +318,7 @@ class Client:
     AuthHook = Callable[[Any, str, str|None], None]  # type: ignore
 
     def __init__(self, auth: Authenticator, default_login: str|None = None):
+        self._calls = 0
         self._auth = auth
         self._cookies: dict[str, dict[str, str]] = {}  # login -> name -> value
         self._default_login = default_login
@@ -357,6 +361,8 @@ class Client:
         :param **kwargs: More request parameters (headers, data, json…).
         """
 
+        self._calls += 1
+
         if "login" in kwargs:
             login = kwargs["login"]
             del kwargs["login"]
@@ -387,7 +393,7 @@ class Client:
                 elif "model_dump" in val.__dir__() and callable(val.model_dump):
                     # probably pydantic
                     json_param[name] = val.model_dump()
-                else: # pydantic or standard dataclasses?
+                else:  # pydantic or standard dataclasses?
                     json_param[name] = dataclasses.asdict(val)
 
         # convert data parameters to simple strings
@@ -415,16 +421,14 @@ class Client:
         res = self._request(method, path, cookies, **kwargs)  # type: ignore
 
         # check status
-        if status is not None:
-            if res.status_code != status:  # show error before aborting
-                # FIXME what if the useful part is at the end?
-                _pytestFail(f"bad {status} result: {res.status_code} {res.text[:512]}...")
+        if status is not None and res.status_code != status:  # show error before aborting
+            # FIXME what if the useful part is at the end?
+            _pytestFail(f"bad {status} result: {res.status_code} {res.text[:512]}...")
 
         # check content
-        if content is not None:
-            if not re.search(content, res.text, re.DOTALL):
-                # FIXME what if the useful part is at the end?
-                _pytestFail(f"cannot find {content} in {res.text[:512]}...")
+        if content is not None and not re.search(content, res.text, re.DOTALL):
+            # FIXME what if the useful part is at the end?
+            _pytestFail(f"cannot find {content} in {res.text[:512]}...")
 
         return res
 
@@ -448,6 +452,12 @@ class Client:
         """HTTP DELETE request, see `Client.request`."""
         return self.request("DELETE", path, status=status, content=content, **kwargs)
 
+    def __str__(self):
+        return f"client calls: {self._calls}"
+
+    def __del__(self):
+        log.info(f"ending, {self}")
+
 
 class RequestClient(Client):
     """Request-based test provider.
@@ -526,6 +536,7 @@ class FlaskClient(Client):
 
         return self._client.open(method=method, path=path, **kwargs)
 
+
 def _ft_authenticator():
     """Fixture implementation, separated for testing purposes."""
 
@@ -559,6 +570,7 @@ def _ft_authenticator():
 
     return auth
 
+
 @pytest.fixture
 def ft_authenticator():
     """Pytest Fixture: ft_authenticator.
@@ -593,6 +605,7 @@ def ft_authenticator():
 
     yield _ft_authenticator()
 
+
 def _ft_client(authenticator):
     """Fixture implementation separated for testing."""
 
@@ -601,7 +614,7 @@ def _ft_client(authenticator):
 
     test_app = os.environ.get("FLASK_TESTER_APP", "app")
 
-    if test_app.startswith("http://") or test_app.startswith("https://"):
+    if test_app.startswith(("http://", "https://")):
         client = RequestClient(authenticator, test_app, default_login)
     else:
         # load app package
@@ -627,6 +640,7 @@ def _ft_client(authenticator):
 
     return client
 
+
 @pytest.fixture
 def ft_client(ft_authenticator):
     """Pytest Fixture: ft_client.

{flasktester-5.1 → flasktester-6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FlaskTester
-Version: 5.1
+Version: 6.0
 Summary: Pytest fixtures for Flask internal and external authenticated tests
 Author-email: Fabien Coelho <flask.tester@coelho.net>
 License-Expression: CC0-1.0
@@ -25,6 +25,7 @@ Requires-Dist: pyright; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt!=0.9.5; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 Requires-Dist: types-flask; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: FlaskSimpleAuth>=35.0; extra == "dev"

{flasktester-5.1 → flasktester-6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FlaskTester"
-version = "5.1"
+version = "6.0"
 authors = [ { name = "Fabien Coelho", email = "flask.tester@coelho.net" } ]
 description = "Pytest fixtures for Flask internal and external authenticated tests"
 readme = "README.md"
@@ -33,7 +33,7 @@ package = "https://pypi.org/project/FlaskTester/"
 # various dev tools
 dev = [
   # static checks…
-  "mypy", "pyright", "ruff", "coverage", "pymarkdownlnt!=0.9.5",
+  "mypy", "pyright", "ruff", "coverage", "pymarkdownlnt!=0.9.5", "flake8",
   # tests
   "types-flask", "types-requests", "FlaskSimpleAuth>=35.0", "bcrypt", "pydantic"
 ]
@@ -47,3 +47,7 @@ py-modules = [ "FlaskTester" ]
 [tool.black]
 line-length = 100
 target-version = ["py310"]
+
+[tool.ruff.lint]
+# ruff rules are what they are, but they are not always right
+ignore = ["BLE001", "B006", "I001", "SIM114", "RUF012", "PIE790"]