Failed to delete an item of OutOfOrderTableProxy #383

Activity

1. qris commented on Jan 31, 2025

   

   qris

   on Jan 31, 2025

   More actions

   I think this may be the same bug:

   import tomlkit
   del tomlkit.loads("[tool.pdm.scripts]\n[tool.pdm]\n[dependency-groups]\n[tool.ruff]\n")["tool"]["pdm"]'

   Outputs:

   tomlkit.exceptions.NonExistentKey: 'Key "pdm" does not exist.'
   

   Deleting other keys works fine.

   I traced the problem to here, in OutOfOrderTableProxy.__init__:

       def __init__(self, container: Container, indices: tuple[int, ...]) -> None:
           self._container = container
           self._internal_container = Container(True)
           self._tables = []
           self._tables_map = {}
   
           for i in indices:
               _, item = self._container._body[i]
   
               if isinstance(item, Table):
                   self._tables.append(item)
                   table_idx = len(self._tables) - 1
                   for k, v in item.value.body:
                       self._internal_container._raw_append(k, v)
                       self._tables_map.setdefault(k, []).append(table_idx)
                       if k is not None:
                           dict.__setitem__(self, k.key, v)

   In this case, item.value.body contains two keys called pdm (I think maybe there should only be one?)

   [(<Key pdm>, {'scripts': {}}), (<Key pdm>, {})]
   

   So we go around the for k, v in item.value.body: loop twice, adding the same table_idx (zero) twice to self._tables_map[k].- Then in __del__ we try to delete the same key twice, but it fails the second time because it's already been deleted.

   I made a small change to __init__ to avoid adding the same key twice:

                       key_to_index = self._tables_map.setdefault(k, [])
                       if table_idx not in key_to_index:
                           key_to_index.append(table_idx)
                       if k is not None:
                           dict.__setitem__(self, k.key, v)
   

   And it appears to work, for this case and a few other simple sanity checks:

   python3.12 -c 'import tomlkit
   with open("pyproject.toml", "rb") as f: k=tomlkit.load(f); del k["tool"]["pdm"]; print(tomlkit.dumps(k))'
   [dependency-groups]
   [tool.ruff]
   
2. frostming

   self-assigned this

   on Jun 5, 2025
3. frostming

   added a commit that references this issue on Jun 5, 2025

   fix: ensure unique table indices when adding items to out-of-order ta…

   ...

   This issue will close once commit 8e48b99 is merged into the 'master' branch.

   8e48b99
4. frostming

   closed this as completedin #420on Jun 5, 2025
5. frostming

   added a commit that references this issue on Jun 5, 2025

   fix: ensure unique table indices when adding items to out-of-order ta…

   ...

   This issue will close once commit e3b7332 is merged into the 'master' branch.

   e3b7332
6. frostming

   marked Incorrect table entry removal #410 as a duplicate of this issue on Jun 5, 2025
7. luketainton

   added a commit that references this issue on Jan 5, 2026

   fix(deps): update dependency tomlkit to v0.13.3 (#343)

   ...

   95ad195