Fix insertion of None value in MultiIndex (#59069)

* Fix insertion of None value in MultiIndex

* add whatnew entry

* check for NA values using missing::isna

* adding test insertion of np.nan

* update whatsnew entry

* test case revision

---------

Co-authored-by: Matthew Roeschke <[email protected]>

Author: chaoyihu

doc/source/whatsnew/v3.0.0.rst

@@ -545,6 +545,7 @@ MultiIndex
 ^^^^^^^^^^
 - :func:`DataFrame.loc` with ``axis=0``  and :class:`MultiIndex` when setting a value adds extra columns (:issue:`58116`)
 - :meth:`DataFrame.melt` would not accept multiple names in ``var_name`` when the columns were a :class:`MultiIndex` (:issue:`58033`)
+- :meth:`MultiIndex.insert` would not insert NA value correctly at unified location of index -1 (:issue:`59003`)
 -
 
 I/O

pandas/core/indexes/multi.py

@@ -3906,8 +3906,11 @@ def insert(self, loc: int, item) -> MultiIndex:
                 # have to insert into level
                 # must insert at end otherwise you have to recompute all the
                 # other codes
-                lev_loc = len(level)
-                level = level.insert(lev_loc, k)
+                if isna(k):  # GH 59003
+                    lev_loc = -1
+                else:
+                    lev_loc = len(level)
+                    level = level.insert(lev_loc, k)
             else:
                 lev_loc = level.get_loc(k)
 

pandas/tests/test_multilevel.py

@@ -288,6 +288,13 @@ def test_multiindex_with_na(self):
 
         tm.assert_frame_equal(df, expected)
 
+    @pytest.mark.parametrize("na", [None, np.nan])
+    def test_multiindex_insert_level_with_na(self, na):
+        # GH 59003
+        df = DataFrame([0], columns=[["A"], ["B"]])
+        df[na, "B"] = 1
+        tm.assert_frame_equal(df[na], DataFrame([1], columns=["B"]))
+
 
 class TestSorted:
     """everything you wanted to test about sorting"""