More clear documentation of max_redirects

src/gufo/http/async_client.py

@@ -41,8 +41,14 @@ class HttpClient(object):
         user_agent: Default user agent.
 
     Args:
-        max_redirects: Maximal amount of redirects. Use `None`
-            to disable redirect processing.
+        max_redirects: Set up redirects policy:
+
+            * **None**: Disable automatic redirect processing.
+            * **0**: Deny redirects. Will raise `RedirectError`
+                on 3xx response.
+            * **>0**: Follow redirects automatically. Will raise
+                `RedirectError` when redirects limit exceeded.
+
         compression: Acceptable compression methods,
             must be a combination of `DEFLATE`, `GZIP`, `BROTLI`.
             Set to `None` to disable compression support.

src/gufo/http/sync_client.py

@@ -41,8 +41,14 @@ class HttpClient(object):
         user_agent: Default user agent.
 
     Args:
-        max_redirects: Maximal amount of redirects. Use `None`
-            to disable redirect processing.
+        max_redirects: Set up redirects policy:
+
+            * **None**: Disable automatic redirect processing.
+            * **0**: Deny redirects. Will raise `RedirectError`
+                on 3xx response.
+            * **>0**: Follow redirects automatically. Will raise
+                `RedirectError` when redirects limit exceeded.
+
         compression: Acceptable compression methods,
             must be a combination of `DEFLATE`, `GZIP`, `BROTLI`.
             Set to `None` to disable compression support.

tests/test_async_client.py

@@ -348,6 +348,15 @@ async def inner() -> None:
     asyncio.run(inner())
 
 
+def test_no_redirect_forbidden(httpd: Httpd) -> None:
+    async def inner() -> None:
+        async with HttpClient(max_redirects=0) as client:
+            with pytest.raises(RedirectError):
+                await client.get(f"{httpd.prefix}/redirect/root")
+
+    asyncio.run(inner())
+
+
 @pytest.mark.parametrize("x", [HttpError, RedirectError])
 def test_redirect_to_loop(httpd: Httpd, x: Type[BaseException]) -> None:
     async def inner() -> None:

tests/test_sync_client.py

@@ -277,6 +277,11 @@ def test_no_redirect_to_root(httpd: Httpd) -> None:
         assert resp.status == 302
 
 
+def test_redirects_forbidden(httpd: Httpd) -> None:
+    with HttpClient(max_redirects=0) as client, pytest.raises(RedirectError):
+        client.get(f"{httpd.prefix}/redirect/root")
+
+
 @pytest.mark.parametrize("x", [HttpError, RedirectError])
 def test_redirect_to_loop(httpd: Httpd, x: Type[BaseException]) -> None:
     with HttpClient() as client, pytest.raises(x):