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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: python-benedict
-Version: 0.34.1
+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,16 +51,20 @@ 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
 Classifier: Topic :: Text Processing :: Markup :: XML
 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
+Requires-Dist: useful-types<0.3.0,>=0.2.1
 Provides-Extra: all
 Requires-Dist: python-benedict[io,parse,s3]; extra == "all"
 Provides-Extra: html
@@ -71,7 +75,7 @@ Requires-Dist: python-benedict[html,toml,xls,xml,yaml]; extra == "io"
 Provides-Extra: parse
 Requires-Dist: ftfy<7.0.0,>=6.0.0; extra == "parse"
 Requires-Dist: mailchecker<7.0.0,>=4.1.0; extra == "parse"
-Requires-Dist: phonenumbers<9.0.0,>=8.12.0; extra == "parse"
+Requires-Dist: phonenumbers<10.0.0,>=8.12.0; extra == "parse"
 Requires-Dist: python-dateutil<3.0.0,>=2.8.0; extra == "parse"
 Provides-Extra: s3
 Requires-Dist: boto3<2.0.0,>=1.24.89; extra == "s3"
@@ -81,24 +85,26 @@ Provides-Extra: xls
 Requires-Dist: openpyxl<4.0.0,>=3.0.0; extra == "xls"
 Requires-Dist: xlrd<3.0.0,>=2.0.0; extra == "xls"
 Provides-Extra: xml
-Requires-Dist: xmltodict<1.0.0,>=0.12.0; extra == "xml"
+Requires-Dist: xmltodict<2.0.0,>=0.12.0; extra == "xml"
 Provides-Extra: yaml
 Requires-Dist: pyyaml<7.0,>=6.0; extra == "yaml"
+Dynamic: license-file
 
 [![](https://img.shields.io/pypi/pyversions/python-benedict.svg?color=blue&logo=python&logoColor=white)](https://www.python.org/)
 [![](https://img.shields.io/pypi/v/python-benedict.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/python-benedict/)
 [![](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)
 [![](https://img.shields.io/codecov/c/gh/fabiocaccamo/python-benedict?logo=codecov)](https://codecov.io/gh/fabiocaccamo/python-benedict)
-[![](https://img.shields.io/codeclimate/maintainability/fabiocaccamo/python-benedict?logo=code-climate)](https://codeclimate.com/github/fabiocaccamo/python-benedict/)
 [![](https://img.shields.io/codacy/grade/0dbd5cc2089f4dce80a0e49e6822be3c?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/python-benedict)
 [![](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.
@@ -132,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
@@ -216,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**.
 
@@ -376,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)
@@ -393,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**
@@ -508,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
@@ -646,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
@@ -1118,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).
 
@@ -1127,7 +1170,7 @@ Released under [MIT License](LICENSE.txt).
 
 - :star: Star this project on [GitHub](https://github.com/fabiocaccamo/python-benedict)
 - :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)
-- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)
+- :blue_heart: Follow me on [Bluesky](https://bsky.app/profile/fabiocaccamo.bsky.social)
 - :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)
 
 ## See also

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

@@ -3,15 +3,16 @@
 [![](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)
 [![](https://img.shields.io/codecov/c/gh/fabiocaccamo/python-benedict?logo=codecov)](https://codecov.io/gh/fabiocaccamo/python-benedict)
-[![](https://img.shields.io/codeclimate/maintainability/fabiocaccamo/python-benedict?logo=code-climate)](https://codeclimate.com/github/fabiocaccamo/python-benedict/)
 [![](https://img.shields.io/codacy/grade/0dbd5cc2089f4dce80a0e49e6822be3c?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/python-benedict)
 [![](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.
@@ -45,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
@@ -129,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**.
 
@@ -289,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)
@@ -306,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**
@@ -421,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
@@ -559,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
@@ -1031,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).
 
@@ -1040,7 +1078,7 @@ Released under [MIT License](LICENSE.txt).
 
 - :star: Star this project on [GitHub](https://github.com/fabiocaccamo/python-benedict)
 - :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)
-- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)
+- :blue_heart: Follow me on [Bluesky](https://bsky.app/profile/fabiocaccamo.bsky.social)
 - :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)
 
 ## See also

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/clean.py

@@ -1,4 +1,16 @@
-def _clean_dict(d, strings, collections):
+from __future__ import annotations
+
+from collections.abc import MutableMapping, MutableSequence
+from typing import Any, TypeVar
+
+_K = TypeVar("_K")
+_V = TypeVar("_V")
+_T = TypeVar("_T")
+
+
+def _clean_dict(
+    d: MutableMapping[_K, _V], strings: bool, collections: bool
+) -> MutableMapping[_K, _V]:
     keys = list(d.keys())
     for key in keys:
         d[key] = _clean_value(d[key], strings=strings, collections=collections)
@@ -7,7 +19,9 @@ def _clean_dict(d, strings, collections):
     return d
 
 
-def _clean_list(ls, strings, collections):
+def _clean_list(
+    ls: MutableSequence[_T], strings: bool, collections: bool
+) -> MutableSequence[_T]:
     for i in range(len(ls) - 1, -1, -1):
         ls[i] = _clean_value(ls[i], strings=strings, collections=collections)
         if ls[i] is None:
@@ -15,7 +29,7 @@ def _clean_list(ls, strings, collections):
     return ls
 
 
-def _clean_set(values, strings, collections):
+def _clean_set(values: set[_T], strings: bool, collections: bool) -> set[_T]:
     return {
         value
         for value in values
@@ -23,11 +37,13 @@ def _clean_set(values, strings, collections):
     }
 
 
-def _clean_str(s, strings, collections):
+def _clean_str(s: str, strings: bool, collections: bool) -> str | None:
     return s if s and s.strip() else None
 
 
-def _clean_tuple(values, strings, collections):
+def _clean_tuple(
+    values: tuple[_T, ...], strings: bool, collections: bool
+) -> tuple[_T, ...]:
     return tuple(
         value
         for value in values
@@ -35,13 +51,15 @@ def _clean_tuple(values, strings, collections):
     )
 
 
-def _clean_value(value, strings, collections):
+def _clean_value(value: Any, strings: bool, collections: bool) -> Any:
     if value is None:
         return value
-    elif isinstance(value, list) and collections:
+    elif isinstance(value, MutableSequence) and collections:
         value = _clean_list(value, strings=strings, collections=collections) or None
-    elif isinstance(value, dict) and collections:
-        value = _clean_dict(value, strings=strings, collections=collections) or None
+    elif isinstance(value, MutableMapping) and collections:
+        value = (
+            _clean_dict(dict(value), strings=strings, collections=collections) or None
+        )
     elif isinstance(value, set) and collections:
         value = _clean_set(value, strings=strings, collections=collections) or None
     elif isinstance(value, str) and strings:
@@ -51,5 +69,5 @@ def _clean_value(value, strings, collections):
     return value
 
 
-def clean(d, strings=True, collections=True):
+def clean(d: Any, strings: bool = True, collections: bool = True) -> Any:
     return _clean_dict(d, strings=strings, collections=collections)

python_benedict-0.36.0/benedict/core/clone.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+import copy
+from collections.abc import MutableMapping
+from typing import Any, TypeVar
+
+_T = TypeVar("_T")
+
+
+def clone(
+    obj: _T,
+    empty: bool = False,
+    memo: dict[int, Any] | None = None,
+) -> _T:
+    d = copy.deepcopy(obj, memo)
+    if empty and isinstance(d, MutableMapping):
+        d.clear()
+    return d

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/dump.py

@@ -1,7 +1,9 @@
+from typing import Any
+
 from benedict.serializers import JSONSerializer
 
 
-def dump(obj, **kwargs):
+def dump(obj: Any, **kwargs: Any) -> str:
     serializer = JSONSerializer()
     options = {"indent": 4, "sort_keys": True}
     options.update(**kwargs)

python_benedict-0.36.0/benedict/core/filter.py

@@ -0,0 +1,21 @@
+from collections.abc import Callable, MutableMapping
+from typing import TypeVar
+
+from benedict.core.clone import clone
+
+_K = TypeVar("_K")
+_V = TypeVar("_V")
+
+
+def filter(
+    d: MutableMapping[_K, _V], predicate: Callable[[_K, _V], bool]
+) -> MutableMapping[_K, _V]:
+    if not callable(predicate):
+        raise ValueError("predicate argument must be a callable.")
+    new_dict = clone(d, empty=True)
+    keys = list(d.keys())
+    for key in keys:
+        value = d[key]
+        if predicate(key, value):
+            new_dict[key] = value
+    return new_dict

python_benedict-0.36.0/benedict/core/find.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping
+from typing import TypeVar
+
+_K = TypeVar("_K")
+_V = TypeVar("_V")
+
+
+def find(
+    d: Mapping[_K, _V], keys: Iterable[_K], default: _V | None = None
+) -> _V | None:
+    for key in keys:
+        if key in d:
+            return d[key]
+    return default

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/flatten.py

@@ -1,20 +1,27 @@
-from benedict.core import clone
-from benedict.utils import type_util
+from collections.abc import Mapping
+from typing import Any
 
+from benedict.core.clone import clone
 
-def _flatten_key(base_key, key, separator):
+
+def _flatten_key(base_key: str, key: str, separator: str) -> str:
     if base_key and separator:
         return f"{base_key}{separator}{key}"
     return key
 
 
-def _flatten_item(d, base_dict, base_key, separator):
+def _flatten_item(
+    d: Any,
+    base_dict: Any,
+    base_key: str,
+    separator: str,
+) -> Any:
     new_dict = base_dict
     keys = list(d.keys())
     for key in keys:
         new_key = _flatten_key(base_key, key, separator)
         value = d.get(key, None)
-        if type_util.is_dict(value):
+        if isinstance(value, Mapping):
             new_value = _flatten_item(
                 value, base_dict=new_dict, base_key=new_key, separator=separator
             )
@@ -26,6 +33,6 @@ def _flatten_item(d, base_dict, base_key, separator):
     return new_dict
 
 
-def flatten(d, separator="_"):
+def flatten(d: Any, separator: str = "_") -> Any:
     new_dict = clone(d, empty=True)
     return _flatten_item(d, base_dict=new_dict, base_key="", separator=separator)

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/groupby.py

@@ -1,10 +1,18 @@
+from __future__ import annotations
+
+from collections.abc import Mapping, MutableSequence, Sequence
+from typing import Any, TypeVar
+
 from benedict.utils import type_util
 
+_K = TypeVar("_K")
+_V = TypeVar("_V", bound=MutableSequence[Any])
+
 
-def groupby(items, key):
+def groupby(items: Sequence[Mapping[_K, Any]], key: _K) -> dict[Any, Any]:
     if not type_util.is_list(items):
         raise ValueError("items should be a list of dicts.")
-    items_grouped = {}
+    items_grouped: dict[Any, Any] = {}
     for item in items:
         if not type_util.is_dict(item):
             raise ValueError("item should be a dict.")

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/invert.py

@@ -1,20 +1,28 @@
-from benedict.core import clone
+from collections.abc import MutableMapping, Sequence
+from typing import Any, TypeVar
+
+from benedict.core.clone import clone
 from benedict.utils import type_util
 
+_K = TypeVar("_K")
+_V = TypeVar("_V")
+
 
-def _invert_item(d, key, value, flat):
+def _invert_item(d: MutableMapping[Any, Any], key: _K, value: _V, flat: bool) -> None:
     if flat:
         d.setdefault(value, key)
     else:
         d.setdefault(value, []).append(key)
 
 
-def _invert_list(d, key, value, flat):
+def _invert_list(
+    d: MutableMapping[Any, Any], key: _K, value: Sequence[Any], flat: bool
+) -> None:
     for value_item in value:
         _invert_item(d, key, value_item, flat)
 
 
-def invert(d, flat=False):
+def invert(d: MutableMapping[_K, _V], flat: bool = False) -> MutableMapping[Any, Any]:
     new_dict = clone(d, empty=True)
     for key, value in d.items():
         if type_util.is_list_or_tuple(value):

python_benedict-0.36.0/benedict/core/items_sorted.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+
+from useful_types import SupportsRichComparisonT
+
+
+def _items_sorted_by_item_at_index(
+    d: Mapping[SupportsRichComparisonT, SupportsRichComparisonT],
+    index: int,
+    reverse: bool,
+) -> list[tuple[SupportsRichComparisonT, SupportsRichComparisonT]]:
+    return sorted(d.items(), key=lambda item: item[index], reverse=reverse)
+
+
+def items_sorted_by_keys(
+    d: Mapping[SupportsRichComparisonT, SupportsRichComparisonT], reverse: bool = False
+) -> list[tuple[SupportsRichComparisonT, SupportsRichComparisonT]]:
+    return _items_sorted_by_item_at_index(d, 0, reverse)
+
+
+def items_sorted_by_values(
+    d: Mapping[SupportsRichComparisonT, SupportsRichComparisonT], reverse: bool = False
+) -> list[tuple[SupportsRichComparisonT, SupportsRichComparisonT]]:
+    return _items_sorted_by_item_at_index(d, 1, reverse)

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/keylists.py

@@ -1,7 +1,14 @@
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+from typing import Any
+
 from benedict.utils import type_util
 
 
-def _get_keylist_for_dict(d, parent_keys, indexes):
+def _get_keylist_for_dict(
+    d: Mapping[Any, Any], parent_keys: list[Any], indexes: bool
+) -> list[list[Any]]:
     keylist = []
     for key, value in d.items():
         keys = parent_keys + [key]
@@ -10,7 +17,9 @@ def _get_keylist_for_dict(d, parent_keys, indexes):
     return keylist
 
 
-def _get_keylist_for_list(ls, parent_keys, indexes):
+def _get_keylist_for_list(
+    ls: Sequence[Any], parent_keys: list[Any], indexes: bool
+) -> list[list[Any]]:
     keylist = []
     for key, value in enumerate(ls):
         keys = list(parent_keys)
@@ -20,7 +29,9 @@ def _get_keylist_for_list(ls, parent_keys, indexes):
     return keylist
 
 
-def _get_keylist_for_value(value, parent_keys, indexes):
+def _get_keylist_for_value(
+    value: Mapping[Any, Any] | Sequence[Any], parent_keys: list[Any], indexes: bool
+) -> list[list[Any]]:
     if type_util.is_dict(value):
         return _get_keylist_for_dict(value, parent_keys, indexes)
     elif type_util.is_list(value) and indexes:
@@ -28,5 +39,7 @@ def _get_keylist_for_value(value, parent_keys, indexes):
     return []
 
 
-def keylists(d, indexes=False):
+def keylists(
+    d: Mapping[Any, Any] | Sequence[Any], indexes: bool = False
+) -> list[list[Any]]:
     return _get_keylist_for_value(d, [], indexes)

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/keypaths.py

@@ -1,8 +1,18 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any
+
 from benedict.core.keylists import keylists
 from benedict.utils import type_util
 
 
-def keypaths(d, separator=".", indexes=False, sort=True):
+def keypaths(
+    d: Mapping[Any, Any],
+    separator: str | None = ".",
+    indexes: bool = False,
+    sort: bool = True,
+) -> list[str]:
     separator = separator or "."
     if not type_util.is_string(separator):
         raise ValueError("separator argument must be a (non-empty) string.")

{python_benedict-0.34.1 → python_benedict-0.36.0}/benedict/core/match.py

@@ -1,10 +1,19 @@
+from __future__ import annotations
+
 import re
+from collections.abc import Mapping
+from typing import Any
 
 from benedict.core.keypaths import keypaths
 from benedict.utils import type_util
 
 
-def match(d, pattern, separator=".", indexes=True):
+def match(
+    d: Mapping[Any, Any],
+    pattern: str | re.Pattern[str],
+    separator: str | None = ".",
+    indexes: bool = True,
+) -> list[Any]:
     if type_util.is_regex(pattern):
         regex = pattern
     elif type_util.is_string(pattern):