fix(metadata): treat escape_catalog_name=None as the default

An explicit None (e.g. from a wrapper forwarding unset options) used to
match the old False default; keep it meaning "not set" now that the
default is True. Also assert that escaped spark_catalog resolves.

Signed-off-by: Vu Anh Phung <vu.phung@databricks.com>
Co-authored-by: Isaac <no-reply@databricks.com>

Author: vuanhphung

src/databricks/sql/backend/kernel/client.py

@@ -322,7 +322,11 @@ def __init__(
         )
         self._catalog = catalog
         self._schema = schema
-        self._escape_catalog_name = kwargs.get("escape_catalog_name", True)
+        # None means "not set" and keeps the default rather than disabling escaping.
+        escape_catalog_name = kwargs.get("escape_catalog_name")
+        self._escape_catalog_name = (
+            True if escape_catalog_name is None else escape_catalog_name
+        )
         # ``_use_arrow_native_complex_types`` is the connector-side
         # toggle for whether complex columns (ARRAY / MAP / STRUCT)
         # are surfaced as native Arrow shapes or as compact JSON

src/databricks/sql/backend/thrift_backend.py

@@ -179,7 +179,11 @@ def __init__(
             raise ValueError("No valid connection settings.")
 
         self._host = server_hostname
-        self._escape_catalog_name = kwargs.get("escape_catalog_name", True)
+        # None means "not set" and keeps the default rather than disabling escaping.
+        escape_catalog_name = kwargs.get("escape_catalog_name")
+        self._escape_catalog_name = (
+            True if escape_catalog_name is None else escape_catalog_name
+        )
         self._initialize_retry_args(kwargs)
         self._use_arrow_native_complex_types = kwargs.get(
             "_use_arrow_native_complex_types", True

src/databricks/sql/session.py

@@ -341,7 +341,7 @@ def _create_backend(
                     "enable_geospatial_support", False
                 ),
                 telemetry_options=kernel_telemetry_options,
-                escape_catalog_name=kwargs.get("escape_catalog_name", True),
+                escape_catalog_name=kwargs.get("escape_catalog_name"),
             )
 
         # These reference the lazily-resolved module attributes defined via

tests/e2e/test_driver.py

@@ -721,6 +721,8 @@ def test_escaped_catalog_name_matches_exact_catalog(self):
         with self.cursor({}) as cursor:
             cursor.catalogs()
             names = [row[0] for row in cursor.fetchall()]
+        # hive_metastore is covered separately below (legacy catalog with no
+        # information_schema); it is not excluded because escaping breaks it.
         candidates = [
             n
             for n in names
@@ -764,7 +766,9 @@ def rows(conn, call, **filters):
                 assert rows(escaped, "tables", **one) == rows(raw, "tables", **one)
 
             spark = {"catalog_name": "spark_catalog", "schema_name": "default"}
-            assert rows(raw, "schemas", **spark) <= rows(escaped, "schemas", **spark)
+            spark_rows = rows(escaped, "schemas", **spark)
+            assert spark_rows, "escaped spark_catalog should resolve to hive_metastore"
+            assert rows(raw, "schemas", **spark) <= spark_rows
 
     @skipUnless(pysql_supports_arrow(), "arrow test need arrow support")
     @pytest.mark.parametrize(

tests/unit/test_kernel_client.py

@@ -1951,10 +1951,11 @@ def test_sync_execute_leaves_rowcount_default_when_num_modified_rows_none():
         # Escaping is on by default; it only changes tables(), because kernel
         # schemas()/columns() already take an exact catalog identifier.
         ({}, True),
+        ({"escape_catalog_name": None}, True),
         ({"escape_catalog_name": False}, False),
         ({"escape_catalog_name": True}, True),
     ],
-    ids=["default", "disabled", "enabled"],
+    ids=["default", "none-uses-default", "disabled", "enabled"],
 )
 @pytest.mark.parametrize(
     "method, filters, kernel_filters",

tests/unit/test_thrift_backend.py

@@ -46,10 +46,11 @@ def retry_policy_factory():
     [
         # Escaping is on by default: `_` in a catalog name matches only itself.
         ({}, True),
+        ({"escape_catalog_name": None}, True),
         ({"escape_catalog_name": False}, False),
         ({"escape_catalog_name": True}, True),
     ],
-    ids=["default", "disabled", "enabled"],
+    ids=["default", "none-uses-default", "disabled", "enabled"],
 )
 @pytest.mark.parametrize(
     "method, rpc_name, filters",