Add deprecation warning for ROLE{} pattern

Author: mdesmet

tests/unit/test_client.py

@@ -94,30 +94,31 @@ def test_request_headers(mock_get_and_post):
     client_info_header = constants.HEADER_CLIENT_INFO
     client_info_value = "some_client_info"
 
-    req = TrinoRequest(
-        host="coordinator",
-        port=8080,
-        client_session=ClientSession(
-            user=user,
-            source=source,
-            catalog=catalog,
-            schema=schema,
-            timezone=timezone,
-            headers={
-                accept_encoding_header: accept_encoding_value,
-                client_info_header: client_info_value,
-            },
-            roles={
-                "hive": "ALL",
-                "system": "analyst",
-                "catalog1": "NONE",
-                # ensure backwards compatibility
-                "catalog2": "ROLE{catalog2_role}",
-            }
-        ),
-        http_scheme="http",
-        redirect_handler=None,
-    )
+    with pytest.deprecated_call():
+        req = TrinoRequest(
+            host="coordinator",
+            port=8080,
+            client_session=ClientSession(
+                user=user,
+                source=source,
+                catalog=catalog,
+                schema=schema,
+                timezone=timezone,
+                headers={
+                    accept_encoding_header: accept_encoding_value,
+                    client_info_header: client_info_value,
+                },
+                roles={
+                    "hive": "ALL",
+                    "system": "analyst",
+                    "catalog1": "NONE",
+                    # ensure backwards compatibility
+                    "catalog2": "ROLE{catalog2_role}",
+                }
+            ),
+            http_scheme="http",
+            redirect_handler=None,
+        )
 
     def assert_headers(headers):
         assert headers[constants.HEADER_CATALOG] == catalog

trino/client.py

@@ -43,6 +43,7 @@
 import re
 import threading
 import urllib.parse
+import warnings
 from datetime import date, datetime, time, timedelta, timezone, tzinfo
 from decimal import Decimal
 from time import sleep
@@ -239,7 +240,13 @@ def timezone(self):
     def _format_roles(self, roles):
         formatted_roles = {}
         for catalog, role in roles.items():
-            if role in ("NONE", "ALL") or ROLE_PATTERN.match(role) is not None:
+            is_legacy_role_pattern = ROLE_PATTERN.match(role) is not None
+            if role in ("NONE", "ALL") or is_legacy_role_pattern:
+                if is_legacy_role_pattern:
+                    warnings.warn(f"A role '{role}' is provided using a legacy format. "
+                                  "Please remove the ROLE{} wrapping. Support for the legacy format might be "
+                                  "removed in a future release.",
+                                  DeprecationWarning)
                 formatted_roles[catalog] = role
             else:
                 formatted_roles[catalog] = f"ROLE{{{role}}}"