python-benedict 0.35.0__tar.gz → 0.36.0__tar.gz

{python_benedict-0.35.0/python_benedict.egg-info → python_benedict-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-benedict
-Version: 0.35.0
+Version: 0.36.0
 Summary: python-benedict is a dict subclass with keylist/keypath/keyattr support, normalized I/O operations (base64, csv, ini, json, pickle, plist, query-string, toml, xls, xml, yaml) and many utilities... for humans, obviously.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
@@ -51,6 +51,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Education :: Testing
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: System :: Filesystems
@@ -59,7 +60,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: python-fsutil<1.0.0,>=0.9.3
+Requires-Dist: python-fsutil<1.0.0,>=0.16.0
 Requires-Dist: python-slugify<9.0.0,>=7.0.0
 Requires-Dist: requests<3.0.0,>=2.26.0
 Requires-Dist: typing_extensions<4.16.0,>=4.13.2
@@ -94,6 +95,7 @@ Dynamic: license-file
 [![](https://static.pepy.tech/badge/python-benedict/month)](https://pepy.tech/project/python-benedict)
 [![](https://img.shields.io/github/stars/fabiocaccamo/python-benedict?logo=github&style=flat)](https://github.com/fabiocaccamo/python-benedict/stargazers)
 [![](https://img.shields.io/pypi/l/python-benedict.svg?color=blue)](https://github.com/fabiocaccamo/python-benedict/blob/main/LICENSE.txt)
+[![](https://img.shields.io/badge/SBOM-CycloneDX-blue?logo=dependabot)](https://github.com/fabiocaccamo/python-benedict/releases/latest)
 
 [![](https://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
 [![](https://img.shields.io/github/actions/workflow/status/fabiocaccamo/python-benedict/test-package.yml?branch=main&label=build&logo=github)](https://github.com/fabiocaccamo/python-benedict)
@@ -102,6 +104,7 @@ Dynamic: license-file
 [![](https://img.shields.io/scrutinizer/quality/g/fabiocaccamo/python-benedict?logo=scrutinizer)](https://scrutinizer-ci.com/g/fabiocaccamo/python-benedict/?branch=main)
 [![](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=black)](https://github.com/psf/black)
 [![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![](https://api.securityscorecards.dev/projects/github.com/fabiocaccamo/python-benedict/badge)](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict)
 
 # python-benedict
 python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I/O** shortcuts (`base64`, `cli`, `csv`, `html`, `ini`, `json`, `pickle`, `plist`, `query-string`, `toml`, `xls`, `xml`, `yaml`) and many **utilities**... for humans, obviously.
@@ -135,6 +138,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
         -   [I/O methods](#io-methods)
         -   [Parse methods](#parse-methods)
 -   [Testing](#testing)
+-   [Security](#security)
 -   [License](#license)
 
 ## Installation
@@ -219,6 +223,9 @@ d.keyattr_dynamic = True
 
 > **Warning** - even if this feature is very useful, it has some obvious limitations: it works only for string keys that are *unprotected* (not starting with an `_`) and that don't clash with the currently supported methods names.
 
+#### Tab-completion support
+`benedict` supports tab-completion in **VSCode**, **IPython**, and **Jupyter** for both attribute-style access (`d.<TAB>`) and subscript-style access (`d["<TAB>"]`).
+
 ### Keylist
 Wherever a **key** is used, it is possible to use also a **list of keys**.
 
@@ -379,6 +386,8 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`filter`](#filter)
     -   [`find`](#find)
     -   [`flatten`](#flatten)
+    -   [`freeze`](#freeze)
+    -   [`frozen`](#frozen)
     -   [`groupby`](#groupby)
     -   [`invert`](#invert)
     -   [`items_sorted_by_keys`](#items_sorted_by_keys)
@@ -396,6 +405,7 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`swap`](#swap)
     -   [`traverse`](#traverse)
     -   [`unflatten`](#unflatten)
+    -   [`unfreeze`](#unfreeze)
     -   [`unique`](#unique)
 
 -   **I/O methods**
@@ -511,6 +521,22 @@ f = d.find(keys, default=0)
 f = d.flatten(separator="_")
 ```
 
+#### `freeze`
+
+```python
+# Make the dict immutable: any attempt to modify it will raise a TypeError.
+# Only top-level keys are frozen; nested dicts are not affected.
+d.freeze()
+```
+
+#### `frozen`
+
+```python
+# Return True if the dict is frozen (immutable), False otherwise.
+if d.frozen:
+    ...
+```
+
 #### `groupby`
 
 ```python
@@ -649,6 +675,13 @@ d.traverse(f)
 u = d.unflatten(separator="_")
 ```
 
+#### `unfreeze`
+
+```python
+# Make the dict mutable again after a freeze() call.
+d.unfreeze()
+```
+
 #### `unique`
 
 ```python
@@ -1121,6 +1154,13 @@ tox
 python -m unittest
 ```
 
+## Security
+
+- **SBOM** — a Software Bill of Materials in [CycloneDX](https://cyclonedx.org/) format (JSON and XML) is generated and published as a release asset on every release. You can download it from the [Releases](https://github.com/fabiocaccamo/python-benedict/releases/latest) page.
+- **Trusted Publishing** — packages are published to PyPI via [OIDC Trusted Publishing](https://docs.pypi.org/trusted-publishers/), without long-lived secrets.
+- **OpenSSF Scorecard** — the repository is evaluated weekly against the [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict) checks; results are visible in the GitHub Security tab.
+- **Reporting** — to report a vulnerability, please follow the [Security Policy](SECURITY.md).
+
 ## License
 Released under [MIT License](LICENSE.txt).
 

{python_benedict-0.35.0 → python_benedict-0.36.0}/README.md

@@ -3,6 +3,7 @@
 [![](https://static.pepy.tech/badge/python-benedict/month)](https://pepy.tech/project/python-benedict)
 [![](https://img.shields.io/github/stars/fabiocaccamo/python-benedict?logo=github&style=flat)](https://github.com/fabiocaccamo/python-benedict/stargazers)
 [![](https://img.shields.io/pypi/l/python-benedict.svg?color=blue)](https://github.com/fabiocaccamo/python-benedict/blob/main/LICENSE.txt)
+[![](https://img.shields.io/badge/SBOM-CycloneDX-blue?logo=dependabot)](https://github.com/fabiocaccamo/python-benedict/releases/latest)
 
 [![](https://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
 [![](https://img.shields.io/github/actions/workflow/status/fabiocaccamo/python-benedict/test-package.yml?branch=main&label=build&logo=github)](https://github.com/fabiocaccamo/python-benedict)
@@ -11,6 +12,7 @@
 [![](https://img.shields.io/scrutinizer/quality/g/fabiocaccamo/python-benedict?logo=scrutinizer)](https://scrutinizer-ci.com/g/fabiocaccamo/python-benedict/?branch=main)
 [![](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=black)](https://github.com/psf/black)
 [![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![](https://api.securityscorecards.dev/projects/github.com/fabiocaccamo/python-benedict/badge)](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict)
 
 # python-benedict
 python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I/O** shortcuts (`base64`, `cli`, `csv`, `html`, `ini`, `json`, `pickle`, `plist`, `query-string`, `toml`, `xls`, `xml`, `yaml`) and many **utilities**... for humans, obviously.
@@ -44,6 +46,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
         -   [I/O methods](#io-methods)
         -   [Parse methods](#parse-methods)
 -   [Testing](#testing)
+-   [Security](#security)
 -   [License](#license)
 
 ## Installation
@@ -128,6 +131,9 @@ d.keyattr_dynamic = True
 
 > **Warning** - even if this feature is very useful, it has some obvious limitations: it works only for string keys that are *unprotected* (not starting with an `_`) and that don't clash with the currently supported methods names.
 
+#### Tab-completion support
+`benedict` supports tab-completion in **VSCode**, **IPython**, and **Jupyter** for both attribute-style access (`d.<TAB>`) and subscript-style access (`d["<TAB>"]`).
+
 ### Keylist
 Wherever a **key** is used, it is possible to use also a **list of keys**.
 
@@ -288,6 +294,8 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`filter`](#filter)
     -   [`find`](#find)
     -   [`flatten`](#flatten)
+    -   [`freeze`](#freeze)
+    -   [`frozen`](#frozen)
     -   [`groupby`](#groupby)
     -   [`invert`](#invert)
     -   [`items_sorted_by_keys`](#items_sorted_by_keys)
@@ -305,6 +313,7 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`swap`](#swap)
     -   [`traverse`](#traverse)
     -   [`unflatten`](#unflatten)
+    -   [`unfreeze`](#unfreeze)
     -   [`unique`](#unique)
 
 -   **I/O methods**
@@ -420,6 +429,22 @@ f = d.find(keys, default=0)
 f = d.flatten(separator="_")
 ```
 
+#### `freeze`
+
+```python
+# Make the dict immutable: any attempt to modify it will raise a TypeError.
+# Only top-level keys are frozen; nested dicts are not affected.
+d.freeze()
+```
+
+#### `frozen`
+
+```python
+# Return True if the dict is frozen (immutable), False otherwise.
+if d.frozen:
+    ...
+```
+
 #### `groupby`
 
 ```python
@@ -558,6 +583,13 @@ d.traverse(f)
 u = d.unflatten(separator="_")
 ```
 
+#### `unfreeze`
+
+```python
+# Make the dict mutable again after a freeze() call.
+d.unfreeze()
+```
+
 #### `unique`
 
 ```python
@@ -1030,6 +1062,13 @@ tox
 python -m unittest
 ```
 
+## Security
+
+- **SBOM** — a Software Bill of Materials in [CycloneDX](https://cyclonedx.org/) format (JSON and XML) is generated and published as a release asset on every release. You can download it from the [Releases](https://github.com/fabiocaccamo/python-benedict/releases/latest) page.
+- **Trusted Publishing** — packages are published to PyPI via [OIDC Trusted Publishing](https://docs.pypi.org/trusted-publishers/), without long-lived secrets.
+- **OpenSSF Scorecard** — the repository is evaluated weekly against the [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict) checks; results are visible in the GitHub Security tab.
+- **Reporting** — to report a vulnerability, please follow the [Security Policy](SECURITY.md).
+
 ## License
 Released under [MIT License](LICENSE.txt).
 

{python_benedict-0.35.0 → python_benedict-0.36.0}/benedict/dicts/__init__.py

@@ -88,12 +88,15 @@ class benedict(KeyattrDict[_K, _V], KeypathDict[_V], IODict[_K, _V], ParseDict[_
         )
         for key, value in self.items():
             obj[key] = _clone(value, memo=memo)
+        if self._frozen:
+            obj.freeze()
         return obj
 
     def __getitem__(self, key: _KPT) -> Any:  # type: ignore[override]
         return self._cast(super().__getitem__(key))
 
     def __setitem__(self, key: _KPT, value: _V) -> None:  # type: ignore[override]
+        self._check_frozen()
         super().__setitem__(key, self._cast(value))
 
     def _cast(self, value: Any) -> Any:
@@ -133,7 +136,17 @@ class benedict(KeyattrDict[_K, _V], KeypathDict[_V], IODict[_K, _V], ParseDict[_
         """
         Creates and return a copy of the current instance (shallow copy).
         """
-        return cast("Self", self._cast(super().copy()))
+        obj_type = type(self)
+        obj = obj_type(
+            keyattr_enabled=self._keyattr_enabled,
+            keyattr_dynamic=self._keyattr_dynamic,
+            keypath_separator=self._keypath_separator,
+        )
+        for key, value in self.items():
+            obj[key] = value
+        if self._frozen:
+            obj.freeze()
+        return obj
 
     def deepcopy(self) -> Self:
         """
@@ -195,7 +208,9 @@ class benedict(KeyattrDict[_K, _V], KeypathDict[_V], IODict[_K, _V], ParseDict[_
         """
         Group a list of dicts at key by the value of the given by_key and return a new dict.
         """
-        return cast("Self", self._cast(_groupby(self[key], by_key)))
+        result = _groupby(self[key], by_key)
+        keypath_util.check_keys(result, self._keypath_separator)
+        return cast("Self", self._cast(result))
 
     def invert(self, flat: bool = False) -> Self:
         """

{python_benedict-0.35.0 → python_benedict-0.36.0}/benedict/dicts/base/base_dict.py

@@ -19,7 +19,8 @@ _V = TypeVar("_V", default=Any)
 
 
 class BaseDict(dict[_K, _V]):
-    _dict: dict[_K, _V] | None = None
+    _dict: dict[_K, _V] | None
+    _frozen: bool
 
     @classmethod
     def _get_dict_or_value(cls, value: Any) -> Any:
@@ -32,11 +33,19 @@ class BaseDict(dict[_K, _V]):
                     value[key] = key_val
         return value
 
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self:
+        obj = super().__new__(cls)
+        # bypass subclass __setattr__ (e.g. KeyattrDict) which may access _dict before it exists
+        object.__setattr__(obj, "_dict", None)
+        object.__setattr__(obj, "_frozen", False)
+        return obj
+
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        self._dict = None
         if len(args) == 1 and isinstance(args[0], Mapping):
-            self._dict = self._get_dict_or_value(args[0])
-            super().__init__(self._dict)
+            # bypass subclass __setattr__ (e.g. KeyattrDict) which may treat _dict as a key
+            d = self._get_dict_or_value(args[0])
+            object.__setattr__(self, "_dict", d)
+            super().__init__(d)
             return
         super().__init__(*args, **kwargs)
 
@@ -54,9 +63,12 @@ class BaseDict(dict[_K, _V]):
         obj = self.__class__()
         for key, value in self.items():
             obj[key] = _clone(value, memo=memo)
+        if self._frozen:
+            obj.freeze()
         return obj
 
     def __delitem__(self, key: _K) -> None:
+        self._check_frozen()
         if self._dict is not None:
             del self._dict[key]
             return
@@ -73,6 +85,7 @@ class BaseDict(dict[_K, _V]):
         return super().__getitem__(key)
 
     def __ior__(self, other: Any) -> Self:  # type: ignore[misc,override]
+        self._check_frozen()
         if self._dict is not None:
             return cast("Self", self._dict.__ior__(other))
         return super().__ior__(other)
@@ -98,6 +111,7 @@ class BaseDict(dict[_K, _V]):
         return super().__repr__()
 
     def __setitem__(self, key: _K, value: _V) -> None:
+        self._check_frozen()
         value = self._get_dict_or_value(value)
         if self._dict is not None:
             is_dict_item = key in self._dict and isinstance(self._dict[key], dict)
@@ -114,24 +128,46 @@ class BaseDict(dict[_K, _V]):
         super().__setitem__(key, value)
 
     def __setstate__(self, state: Mapping[str, Any]) -> None:
-        self._dict = state["_dict"]
-        self._dict = state["_dict"]
+        object.__setattr__(self, "_dict", state.get("_dict", None))
+        object.__setattr__(self, "_frozen", state.get("_frozen", False))
 
     def __str__(self) -> str:
         if self._dict is not None:
             return str(self._dict)
         return super().__str__()
 
+    def _check_frozen(self) -> None:
+        if self._frozen:
+            raise TypeError(
+                f"{self.__class__.__name__!r} object is frozen and cannot be modified."
+            )
+
+    @property
+    def frozen(self) -> bool:
+        return self._frozen
+
+    def freeze(self) -> Self:
+        object.__setattr__(self, "_frozen", True)
+        return self
+
+    def unfreeze(self) -> Self:
+        object.__setattr__(self, "_frozen", False)
+        return self
+
     def clear(self) -> None:
+        self._check_frozen()
         if self._dict is not None:
             self._dict.clear()
             return
         super().clear()
 
     def copy(self) -> Self:
-        if self._dict is not None:
-            return cast("Self", self._dict.copy())
-        return cast("Self", super().copy())
+        obj = self.__class__()
+        for key, value in self.items():
+            obj[key] = value
+        if self._frozen:
+            obj.freeze()
+        return obj
 
     def dict(self) -> Self:
         if self._dict is not None:
@@ -154,11 +190,13 @@ class BaseDict(dict[_K, _V]):
         return super().keys()
 
     def pop(self, key: _K, *args: Any) -> _V:
+        self._check_frozen()
         if self._dict is not None:
             return self._dict.pop(key, *args)  # type: ignore[no-any-return]
         return super().pop(key, *args)  # type: ignore[no-any-return]
 
     def setdefault(self, key: _K, default: _V | None = None) -> _V:
+        self._check_frozen()
         default = self._get_dict_or_value(default)
         assert default is not None
         if self._dict is not None:
@@ -166,6 +204,7 @@ class BaseDict(dict[_K, _V]):
         return super().setdefault(key, default)
 
     def update(self, other: Any) -> None:
+        self._check_frozen()
         other = self._get_dict_or_value(other)
         if self._dict is not None:
             self._dict.update(other)

{python_benedict-0.35.0 → python_benedict-0.36.0}/benedict/dicts/keyattr/keyattr_dict.py

@@ -68,6 +68,22 @@ class KeyattrDict(BaseDict[_K, _V]):
                 raise AttributeError(attr_message)
             self.__setitem__(attr_k, value)
 
+    def __dir__(self) -> list[str]:
+        # Extend tab-completion (VSCode, IPython, etc.) with the dict keys when
+        # keyattr is enabled, since keys are accessible as attributes via __getattr__.
+        # Non-string keys are excluded: __dir__ must return strings (Python protocol)
+        # and non-string keys can never be valid attribute names anyway.
+        keys: list[str] = (
+            [key for key in self.keys() if isinstance(key, str)]
+            if self._keyattr_enabled
+            else []
+        )
+        return sorted(set(list(super().__dir__()) + keys))
+
+    def _ipython_key_completions_(self) -> list[Any]:
+        # Used by IPython/Jupyter for subscript tab-completion: obj["<TAB>"]
+        return list(self.keys())
+
     def __setstate__(self, state: Mapping[str, Any]) -> None:
         super().__setstate__(state)
         self._keyattr_enabled = state["_keyattr_enabled"]

{python_benedict-0.35.0 → python_benedict-0.36.0}/benedict/metadata.py

@@ -8,4 +8,4 @@ __description__ = (
 __email__ = "fabio.caccamo@gmail.com"
 __license__ = "MIT"
 __title__ = "benedict"
-__version__ = "0.35.0"
+__version__ = "0.36.0"

{python_benedict-0.35.0 → python_benedict-0.36.0}/benedict/serializers/xls.py

@@ -156,6 +156,17 @@ class XLSSerializer(AbstractSerializer[str, list[dict[str, Any]]]):
             values = [cell.value for cell in row]
             items.append(dict(zip(columns, values)))
 
+        try:
+            # explicitly close vba_archive if present: Workbook.close() never
+            # closes it, so relying on GC (__del__ -> close()) is unsafe because
+            # the underlying BytesIO may already be finalized first, causing a
+            # ValueError when ZipFile tries to flush the end-of-central-directory
+            vba_archive = getattr(workbook, "vba_archive", None)
+            if vba_archive is not None:
+                vba_archive.close()
+        except Exception:
+            pass
+
         # close the worksheet
         workbook.close()
 

{python_benedict-0.35.0 → python_benedict-0.36.0}/pyproject.toml

@@ -81,6 +81,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Education :: Testing",
     "Topic :: Software Development :: Build Tools",
     "Topic :: System :: Filesystems",
@@ -89,7 +90,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "python-fsutil >= 0.9.3, < 1.0.0",
+    "python-fsutil >= 0.16.0, < 1.0.0",
     "python-slugify >= 7.0.0, < 9.0.0",
     "requests >= 2.26.0, < 3.0.0",
     "typing_extensions >= 4.13.2, < 4.16.0",

{python_benedict-0.35.0 → python_benedict-0.36.0/python_benedict.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-benedict
-Version: 0.35.0
+Version: 0.36.0
 Summary: python-benedict is a dict subclass with keylist/keypath/keyattr support, normalized I/O operations (base64, csv, ini, json, pickle, plist, query-string, toml, xls, xml, yaml) and many utilities... for humans, obviously.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>
@@ -51,6 +51,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Education :: Testing
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: System :: Filesystems
@@ -59,7 +60,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: python-fsutil<1.0.0,>=0.9.3
+Requires-Dist: python-fsutil<1.0.0,>=0.16.0
 Requires-Dist: python-slugify<9.0.0,>=7.0.0
 Requires-Dist: requests<3.0.0,>=2.26.0
 Requires-Dist: typing_extensions<4.16.0,>=4.13.2
@@ -94,6 +95,7 @@ Dynamic: license-file
 [![](https://static.pepy.tech/badge/python-benedict/month)](https://pepy.tech/project/python-benedict)
 [![](https://img.shields.io/github/stars/fabiocaccamo/python-benedict?logo=github&style=flat)](https://github.com/fabiocaccamo/python-benedict/stargazers)
 [![](https://img.shields.io/pypi/l/python-benedict.svg?color=blue)](https://github.com/fabiocaccamo/python-benedict/blob/main/LICENSE.txt)
+[![](https://img.shields.io/badge/SBOM-CycloneDX-blue?logo=dependabot)](https://github.com/fabiocaccamo/python-benedict/releases/latest)
 
 [![](https://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
 [![](https://img.shields.io/github/actions/workflow/status/fabiocaccamo/python-benedict/test-package.yml?branch=main&label=build&logo=github)](https://github.com/fabiocaccamo/python-benedict)
@@ -102,6 +104,7 @@ Dynamic: license-file
 [![](https://img.shields.io/scrutinizer/quality/g/fabiocaccamo/python-benedict?logo=scrutinizer)](https://scrutinizer-ci.com/g/fabiocaccamo/python-benedict/?branch=main)
 [![](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=black)](https://github.com/psf/black)
 [![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![](https://api.securityscorecards.dev/projects/github.com/fabiocaccamo/python-benedict/badge)](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict)
 
 # python-benedict
 python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I/O** shortcuts (`base64`, `cli`, `csv`, `html`, `ini`, `json`, `pickle`, `plist`, `query-string`, `toml`, `xls`, `xml`, `yaml`) and many **utilities**... for humans, obviously.
@@ -135,6 +138,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
         -   [I/O methods](#io-methods)
         -   [Parse methods](#parse-methods)
 -   [Testing](#testing)
+-   [Security](#security)
 -   [License](#license)
 
 ## Installation
@@ -219,6 +223,9 @@ d.keyattr_dynamic = True
 
 > **Warning** - even if this feature is very useful, it has some obvious limitations: it works only for string keys that are *unprotected* (not starting with an `_`) and that don't clash with the currently supported methods names.
 
+#### Tab-completion support
+`benedict` supports tab-completion in **VSCode**, **IPython**, and **Jupyter** for both attribute-style access (`d.<TAB>`) and subscript-style access (`d["<TAB>"]`).
+
 ### Keylist
 Wherever a **key** is used, it is possible to use also a **list of keys**.
 
@@ -379,6 +386,8 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`filter`](#filter)
     -   [`find`](#find)
     -   [`flatten`](#flatten)
+    -   [`freeze`](#freeze)
+    -   [`frozen`](#frozen)
     -   [`groupby`](#groupby)
     -   [`invert`](#invert)
     -   [`items_sorted_by_keys`](#items_sorted_by_keys)
@@ -396,6 +405,7 @@ Here are the details of the supported formats, operations and extra options docs
     -   [`swap`](#swap)
     -   [`traverse`](#traverse)
     -   [`unflatten`](#unflatten)
+    -   [`unfreeze`](#unfreeze)
     -   [`unique`](#unique)
 
 -   **I/O methods**
@@ -511,6 +521,22 @@ f = d.find(keys, default=0)
 f = d.flatten(separator="_")
 ```
 
+#### `freeze`
+
+```python
+# Make the dict immutable: any attempt to modify it will raise a TypeError.
+# Only top-level keys are frozen; nested dicts are not affected.
+d.freeze()
+```
+
+#### `frozen`
+
+```python
+# Return True if the dict is frozen (immutable), False otherwise.
+if d.frozen:
+    ...
+```
+
 #### `groupby`
 
 ```python
@@ -649,6 +675,13 @@ d.traverse(f)
 u = d.unflatten(separator="_")
 ```
 
+#### `unfreeze`
+
+```python
+# Make the dict mutable again after a freeze() call.
+d.unfreeze()
+```
+
 #### `unique`
 
 ```python
@@ -1121,6 +1154,13 @@ tox
 python -m unittest
 ```
 
+## Security
+
+- **SBOM** — a Software Bill of Materials in [CycloneDX](https://cyclonedx.org/) format (JSON and XML) is generated and published as a release asset on every release. You can download it from the [Releases](https://github.com/fabiocaccamo/python-benedict/releases/latest) page.
+- **Trusted Publishing** — packages are published to PyPI via [OIDC Trusted Publishing](https://docs.pypi.org/trusted-publishers/), without long-lived secrets.
+- **OpenSSF Scorecard** — the repository is evaluated weekly against the [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/fabiocaccamo/python-benedict) checks; results are visible in the GitHub Security tab.
+- **Reporting** — to report a vulnerability, please follow the [Security Policy](SECURITY.md).
+
 ## License
 Released under [MIT License](LICENSE.txt).
 

{python_benedict-0.35.0 → python_benedict-0.36.0}/python_benedict.egg-info/requires.txt

@@ -1,4 +1,4 @@
-python-fsutil<1.0.0,>=0.9.3
+python-fsutil<1.0.0,>=0.16.0
 python-slugify<9.0.0,>=7.0.0
 requests<3.0.0,>=2.26.0
 typing_extensions<4.16.0,>=4.13.2