feat: add .item() method to retrieve the item object (#397)

* feat: add .item() method to retrieve the item object Signed-off-by: Frost Ming <[email protected]> * changelog Signed-off-by: Frost Ming <[email protected]>
python-poetry · Jan 26, 2025 · 94e193a · 94e193a
1 parent 8a3564a
commit 94e193a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+[Unreleased]:
+
+### Added
+
+- Add `.item()` method to array and tables to retrieve an item by key. ([#390](https://github.com/python-poetry/tomlkit/issues/390))
+
 ## [0.13.2] - 2024-08-14
 
 ### Fixed

diff --git a/tests/test_items.py b/tests/test_items.py
@@ -915,6 +915,8 @@ def test_booleans_comparison():
 """
 
     content = parse(s)
+    assert content["foo"]["value"] is False
+    assert isinstance(content["foo"].item("value"), Bool)
 
     assert {"foo": {"value": False}} == content
     assert {"value": False} == content["foo"]

diff --git a/tomlkit/items.py b/tomlkit/items.py
@@ -1313,10 +1313,14 @@ def clear(self) -> None:
     def __len__(self) -> int:
         return list.__len__(self)
 
+    def item(self, index: int) -> Item:
+        rv = list.__getitem__(self, index)
+        return cast(Item, rv)
+
     def __getitem__(self, key: int | slice) -> Any:
-        rv = cast(Item, list.__getitem__(self, key))
-        if rv.is_boolean():
-            return bool(rv)
+        rv = list.__getitem__(self, key)
+        if isinstance(rv, Bool):
+            return rv.value
         return rv
 
     def __setitem__(self, key: int | slice, value: Any) -> Any:
@@ -1479,6 +1483,9 @@ def remove(self: AT, key: Key | str) -> AT:
 
         return self
 
+    def item(self, key: Key | str) -> Item:
+        return self._value.item(key)
+
     def setdefault(self, key: Key | str, default: Any) -> Any:
         super().setdefault(key, default)
         return self[key]