Fix creating CIMultiDict from MultiDict not making keys case-insentive (#1112)

When `MultiDict` was passed to `CIMultiDict` the keys need to be
converted
fixes #1111

side note `_multidict_extend` doesn't appear to use `name`

---------

Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <webknjaz@redhat.com>

Author: 3 people

CHANGES/1112.bugfix.rst

@@ -0,0 +1 @@
+Fixed keys not becoming case-insensitive when :class:`multidict.CIMultiDict` is created by passing in a :class:`multidict.MultiDict` -- by :user:`bdraco`. 

multidict/_multidict_py.py

@@ -456,6 +456,8 @@ def _title(self, key: str) -> str:
 
 
 class _CIMixin:
+    _ci: bool = True
+
     def _key(self, key: str) -> str:
         if type(key) is istr:
             return key
@@ -477,6 +479,7 @@ def _title(self, key: str) -> str:
 
 class _Base(MultiMapping[_V]):
     _impl: _Impl[_V]
+    _ci: bool = False
 
     @abstractmethod
     def _key(self, key: str) -> str: ...
@@ -632,9 +635,13 @@ def _extend(
     ) -> None:
         if arg:
             if isinstance(arg, (MultiDict, MultiDictProxy)):
-                items = arg._impl._items
+                if self._ci is not arg._ci:
+                    items = [(self._title(k), k, v) for _, k, v in arg._impl._items]
+                else:
+                    items = arg._impl._items
+                    if kwargs:
+                        items = items.copy()
                 if kwargs:
-                    items = items.copy()
                     for key, value in kwargs.items():
                         items.append((self._title(key), key, value))
             else:

multidict/_multilib/pair_list.h

@@ -1132,23 +1132,54 @@ static inline int
 pair_list_update_from_pair_list(pair_list_t *list, PyObject* used, pair_list_t *other)
 {
     Py_ssize_t pos;
+    Py_hash_t hash;
+    PyObject *identity = NULL;
+    PyObject *key = NULL;
+    bool recalc_identity = list->calc_ci_indentity != other->calc_ci_indentity;
 
     for (pos = 0; pos < other->size; pos++) {
         pair_t *pair = other->pairs + pos;
+        if (recalc_identity) {
+            identity = pair_list_calc_identity(list, pair->key);
+            if (identity == NULL) {
+                goto fail;
+            }
+            hash = PyObject_Hash(identity);
+            if (hash == -1) {
+                goto fail;
+            }
+            /* materialize key */
+            key = pair_list_calc_key(other, pair->key, identity);
+            if (key == NULL) {
+                goto fail;
+            }
+        } else {
+            identity = pair->identity;
+            hash = pair->hash;
+            key = pair->key;
+        }
         if (used != NULL) {
-            if (_pair_list_update(list, pair->key, pair->value, used,
-                                  pair->identity, pair->hash) < 0) {
+            if (_pair_list_update(list, key, pair->value, used,
+                                  identity, hash) < 0) {
                 goto fail;
             }
         } else {
-            if (_pair_list_add_with_hash(list, pair->identity, pair->key,
-                                         pair->value, pair->hash) < 0) {
+            if (_pair_list_add_with_hash(list, identity, key,
+                                         pair->value, hash) < 0) {
                 goto fail;
             }
         }
+        if (recalc_identity) {
+            Py_CLEAR(identity);
+            Py_CLEAR(key);
+        }
     }
     return 0;
 fail:
+    if (recalc_identity) {
+        Py_CLEAR(identity);
+        Py_CLEAR(key);
+    }
     return -1;
 }
 

tests/test_multidict.py

@@ -18,6 +18,7 @@
     MultiDictProxy,
     MultiMapping,
     MutableMultiMapping,
+    istr,
 )
 
 _T = TypeVar("_T")
@@ -1223,3 +1224,51 @@ def test_create_multidict_from_existing_multidict_new_pairs() -> None:
     new = MultiDict(original, h4="header4")
     assert "h4" in new
     assert "h4" not in original
+
+
+def test_convert_multidict_to_cimultidict_and_back(
+    case_sensitive_multidict_class: type[MultiDict[str]],
+    case_insensitive_multidict_class: type[CIMultiDict[str]],
+    case_insensitive_str_class: type[istr],
+) -> None:
+    """Test conversion from MultiDict to CIMultiDict."""
+    start_as_md = case_sensitive_multidict_class(
+        [("KEY", "value1"), ("key2", "value2")]
+    )
+    assert start_as_md.get("KEY") == "value1"
+    assert start_as_md["KEY"] == "value1"
+    assert start_as_md.get("key2") == "value2"
+    assert start_as_md["key2"] == "value2"
+    start_as_cimd = case_insensitive_multidict_class(
+        [("KEY", "value1"), ("key2", "value2")]
+    )
+    assert start_as_cimd.get("key") == "value1"
+    assert start_as_cimd["key"] == "value1"
+    assert start_as_cimd.get("key2") == "value2"
+    assert start_as_cimd["key2"] == "value2"
+    converted_to_ci = case_insensitive_multidict_class(start_as_md)
+    assert converted_to_ci.get("key") == "value1"
+    assert converted_to_ci["key"] == "value1"
+    assert converted_to_ci.get("key2") == "value2"
+    assert converted_to_ci["key2"] == "value2"
+    converted_to_md = case_sensitive_multidict_class(converted_to_ci)
+    assert all(type(k) is case_insensitive_str_class for k in converted_to_ci.keys())
+    assert converted_to_md.get("KEY") == "value1"
+    assert converted_to_md["KEY"] == "value1"
+    assert converted_to_md.get("key2") == "value2"
+    assert converted_to_md["key2"] == "value2"
+
+
+def test_convert_multidict_to_cimultidict_eq(
+    case_sensitive_multidict_class: type[MultiDict[str]],
+    case_insensitive_multidict_class: type[CIMultiDict[str]],
+) -> None:
+    """Test compare after conversion from MultiDict to CIMultiDict."""
+    original = case_sensitive_multidict_class(
+        [("h1", "header1"), ("h2", "header2"), ("h3", "header3")]
+    )
+    assert case_insensitive_multidict_class(
+        original
+    ) == case_insensitive_multidict_class(
+        [("H1", "header1"), ("H2", "header2"), ("H3", "header3")]
+    )