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

{python-benedict-0.33.1/python_benedict.egg-info → python_benedict-0.34.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-benedict
-Version: 0.33.1
+Version: 0.34.1
 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>
@@ -47,11 +47,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 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: Topic :: Education :: Testing
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: System :: Filesystems
@@ -89,7 +88,7 @@ Requires-Dist: pyyaml<7.0,>=6.0; extra == "yaml"
 [![](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)](https://github.com/fabiocaccamo/python-benedict/stargazers)
+[![](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://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
@@ -121,7 +120,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
 -   [Usage](#usage)
     -   [Basics](#basics)
     -   [Keyattr](#keyattr) `my_dict.x.y.z`
-    -   [Keylist](#keylist) `my_dict["x", "y", "z"]`
+    -   [Keylist](#keylist) `my_dict[["x", "y", "z"]]`
     -   [Keypath](#keypath) `my_dict["x.y.z"]`
         -   [Custom keypath separator](#custom-keypath-separator)
         -   [Change keypath separator](#change-keypath-separator)
@@ -218,22 +217,22 @@ 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.
 
 ### Keylist
-Wherever a **key** is used, it is possible to use also a **list (or a tuple) of keys**.
+Wherever a **key** is used, it is possible to use also a **list of keys**.
 
 ```python
 d = benedict()
 
 # set values by keys list
-d["profile", "firstname"] = "Fabio"
-d["profile", "lastname"] = "Caccamo"
+d[["profile", "firstname"]] = "Fabio"
+d[["profile", "lastname"]] = "Caccamo"
 print(d) # -> { "profile":{ "firstname":"Fabio", "lastname":"Caccamo" } }
 print(d["profile"]) # -> { "firstname":"Fabio", "lastname":"Caccamo" }
 
 # check if keypath exists in dict
-print(["profile", "lastname"] in d) # -> True
+print([["profile", "lastname"]] in d) # -> True
 
 # delete value by keys list
-del d["profile", "lastname"]
+del d[["profile", "lastname"]]
 print(d["profile"]) # -> { "firstname":"Fabio" }
 ```
 
@@ -546,7 +545,8 @@ items = d.items_sorted_by_values(reverse=False)
 ```python
 # Return a list of all keypaths in the dict.
 # If indexes is True, the output will include list values indexes.
-k = d.keypaths(indexes=False)
+# If sort is True, the resulting list will be sorted
+k = d.keypaths(indexes=False, sort=True)
 ```
 
 #### `match`

{python-benedict-0.33.1 → python_benedict-0.34.1}/README.md

@@ -1,7 +1,7 @@
 [![](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)](https://github.com/fabiocaccamo/python-benedict/stargazers)
+[![](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://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
@@ -33,7 +33,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
 -   [Usage](#usage)
     -   [Basics](#basics)
     -   [Keyattr](#keyattr) `my_dict.x.y.z`
-    -   [Keylist](#keylist) `my_dict["x", "y", "z"]`
+    -   [Keylist](#keylist) `my_dict[["x", "y", "z"]]`
     -   [Keypath](#keypath) `my_dict["x.y.z"]`
         -   [Custom keypath separator](#custom-keypath-separator)
         -   [Change keypath separator](#change-keypath-separator)
@@ -130,22 +130,22 @@ 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.
 
 ### Keylist
-Wherever a **key** is used, it is possible to use also a **list (or a tuple) of keys**.
+Wherever a **key** is used, it is possible to use also a **list of keys**.
 
 ```python
 d = benedict()
 
 # set values by keys list
-d["profile", "firstname"] = "Fabio"
-d["profile", "lastname"] = "Caccamo"
+d[["profile", "firstname"]] = "Fabio"
+d[["profile", "lastname"]] = "Caccamo"
 print(d) # -> { "profile":{ "firstname":"Fabio", "lastname":"Caccamo" } }
 print(d["profile"]) # -> { "firstname":"Fabio", "lastname":"Caccamo" }
 
 # check if keypath exists in dict
-print(["profile", "lastname"] in d) # -> True
+print([["profile", "lastname"]] in d) # -> True
 
 # delete value by keys list
-del d["profile", "lastname"]
+del d[["profile", "lastname"]]
 print(d["profile"]) # -> { "firstname":"Fabio" }
 ```
 
@@ -458,7 +458,8 @@ items = d.items_sorted_by_values(reverse=False)
 ```python
 # Return a list of all keypaths in the dict.
 # If indexes is True, the output will include list values indexes.
-k = d.keypaths(indexes=False)
+# If sort is True, the resulting list will be sorted
+k = d.keypaths(indexes=False, sort=True)
 ```
 
 #### `match`

python_benedict-0.34.1/benedict/core/clean.py

@@ -0,0 +1,55 @@
+def _clean_dict(d, strings, collections):
+    keys = list(d.keys())
+    for key in keys:
+        d[key] = _clean_value(d[key], strings=strings, collections=collections)
+        if d[key] is None:
+            del d[key]
+    return d
+
+
+def _clean_list(ls, strings, collections):
+    for i in range(len(ls) - 1, -1, -1):
+        ls[i] = _clean_value(ls[i], strings=strings, collections=collections)
+        if ls[i] is None:
+            ls.pop(i)
+    return ls
+
+
+def _clean_set(values, strings, collections):
+    return {
+        value
+        for value in values
+        if _clean_value(value, strings=strings, collections=collections) is not None
+    }
+
+
+def _clean_str(s, strings, collections):
+    return s if s and s.strip() else None
+
+
+def _clean_tuple(values, strings, collections):
+    return tuple(
+        value
+        for value in values
+        if _clean_value(value, strings=strings, collections=collections) is not None
+    )
+
+
+def _clean_value(value, strings, collections):
+    if value is None:
+        return value
+    elif isinstance(value, list) 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, set) and collections:
+        value = _clean_set(value, strings=strings, collections=collections) or None
+    elif isinstance(value, str) and strings:
+        value = _clean_str(value, strings=strings, collections=collections) or None
+    elif isinstance(value, tuple) and collections:
+        value = _clean_tuple(value, strings=strings, collections=collections) or None
+    return value
+
+
+def clean(d, strings=True, collections=True):
+    return _clean_dict(d, strings=strings, collections=collections)

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

@@ -2,11 +2,12 @@ from benedict.core.keylists import keylists
 from benedict.utils import type_util
 
 
-def keypaths(d, separator=".", indexes=False):
+def keypaths(d, separator=".", indexes=False, sort=True):
     separator = separator or "."
     if not type_util.is_string(separator):
         raise ValueError("separator argument must be a (non-empty) string.")
     kls = keylists(d, indexes=indexes)
     kps = [separator.join([f"{key}" for key in kl]) for kl in kls]
-    kps.sort()
+    if sort:
+        kps.sort()
     return kps

{python-benedict-0.33.1 → python_benedict-0.34.1}/benedict/dicts/__init__.py

@@ -26,6 +26,7 @@ from benedict.dicts.io import IODict
 from benedict.dicts.keyattr import KeyattrDict
 from benedict.dicts.keylist import KeylistDict
 from benedict.dicts.keypath import KeypathDict
+from benedict.dicts.keypath import keypath_util
 from benedict.dicts.parse import ParseDict
 from benedict.serializers import JSONSerializer, YAMLSerializer
 
@@ -195,12 +196,14 @@ class benedict(KeyattrDict, KeypathDict, IODict, ParseDict):
         """
         return _items_sorted_by_values(self, reverse=reverse)
 
-    def keypaths(self, indexes=False):
+    def keypaths(self, indexes=False, sort=True):
         """
         Return a list of all keypaths in the dict.
         If indexes is True, the output will include list values indexes.
         """
-        return _keypaths(self, separator=self._keypath_separator, indexes=indexes)
+        return _keypaths(
+            self, separator=self._keypath_separator, indexes=indexes, sort=sort
+        )
 
     def match(self, pattern, indexes=True):
         """
@@ -219,7 +222,10 @@ class benedict(KeyattrDict, KeypathDict, IODict, ParseDict):
         If overwrite is False, existing values will not be overwritten.
         If concat is True, list values will be concatenated together.
         """
-        _merge(self, other, *args, **kwargs)
+        others = [other] + list(args)
+        for other in others:
+            keypath_util.check_keys(other, self._keypath_separator)
+        _merge(self, *others, **kwargs)
 
     def move(self, key_src, key_dest):
         """

{python-benedict-0.33.1 → python_benedict-0.34.1}/benedict/dicts/keylist/keylist_dict.py

@@ -8,7 +8,7 @@ class KeylistDict(BaseDict):
         super().__init__(*args, **kwargs)
 
     def __contains__(self, key):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             return self._contains_by_keys(key)
         return super().__contains__(key)
 
@@ -19,7 +19,7 @@ class KeylistDict(BaseDict):
         return False
 
     def __delitem__(self, key):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             self._delitem_by_keys(key)
             return
         super().__delitem__(key)
@@ -35,7 +35,7 @@ class KeylistDict(BaseDict):
         raise KeyError(f"Invalid keys: {keys!r}")
 
     def __getitem__(self, key):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             return self._getitem_by_keys(key)
         return super().__getitem__(key)
 
@@ -46,7 +46,7 @@ class KeylistDict(BaseDict):
         raise KeyError(f"Invalid keys: {keys!r}")
 
     def __setitem__(self, key, value):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             self._setitem_by_keys(key, value)
             return
         super().__setitem__(key, value)
@@ -55,7 +55,7 @@ class KeylistDict(BaseDict):
         keylist_util.set_item(self, keys, value)
 
     def get(self, key, default=None):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             return self._get_by_keys(key, default)
         return super().get(key, default)
 
@@ -68,7 +68,7 @@ class KeylistDict(BaseDict):
         return default
 
     def pop(self, key, *args):
-        if type_util.is_list_or_tuple(key):
+        if type_util.is_list(key):
             return self._pop_by_keys(key, *args)
         return super().pop(key, *args)
 

{python-benedict-0.33.1 → python_benedict-0.34.1}/benedict/dicts/keypath/keypath_util.py

@@ -26,7 +26,7 @@ def parse_keys(keypath, separator):
     """
     Parse keys from keylist or keypath using the given separator.
     """
-    if type_util.is_list_or_tuple(keypath):
+    if type_util.is_list(keypath):
         keys = []
         for key in keypath:
             keys += parse_keys(key, separator)

{python-benedict-0.33.1 → python_benedict-0.34.1}/benedict/metadata.py

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

{python-benedict-0.33.1 → python_benedict-0.34.1}/pyproject.toml

@@ -77,11 +77,10 @@ classifiers = [
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Education :: Testing",
     "Topic :: Software Development :: Build Tools",
     "Topic :: System :: Filesystems",
@@ -167,11 +166,13 @@ exclude = '''
 '''
 
 [tool.ruff]
-ignore = ["B905", "E501"]
 line-length = 88
+
+[tool.ruff.lint]
+ignore = ["B905", "E501"]
 select = ["B", "B9", "C", "E", "F", "W"]
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 10
 
 [tool.setuptools.packages.find]

{python-benedict-0.33.1 → python_benedict-0.34.1/python_benedict.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-benedict
-Version: 0.33.1
+Version: 0.34.1
 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>
@@ -47,11 +47,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 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: Topic :: Education :: Testing
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: System :: Filesystems
@@ -89,7 +88,7 @@ Requires-Dist: pyyaml<7.0,>=6.0; extra == "yaml"
 [![](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)](https://github.com/fabiocaccamo/python-benedict/stargazers)
+[![](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://results.pre-commit.ci/badge/github/fabiocaccamo/python-benedict/main.svg)](https://results.pre-commit.ci/latest/github/fabiocaccamo/python-benedict/main)
@@ -121,7 +120,7 @@ python-benedict is a dict subclass with **keylist/keypath/keyattr** support, **I
 -   [Usage](#usage)
     -   [Basics](#basics)
     -   [Keyattr](#keyattr) `my_dict.x.y.z`
-    -   [Keylist](#keylist) `my_dict["x", "y", "z"]`
+    -   [Keylist](#keylist) `my_dict[["x", "y", "z"]]`
     -   [Keypath](#keypath) `my_dict["x.y.z"]`
         -   [Custom keypath separator](#custom-keypath-separator)
         -   [Change keypath separator](#change-keypath-separator)
@@ -218,22 +217,22 @@ 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.
 
 ### Keylist
-Wherever a **key** is used, it is possible to use also a **list (or a tuple) of keys**.
+Wherever a **key** is used, it is possible to use also a **list of keys**.
 
 ```python
 d = benedict()
 
 # set values by keys list
-d["profile", "firstname"] = "Fabio"
-d["profile", "lastname"] = "Caccamo"
+d[["profile", "firstname"]] = "Fabio"
+d[["profile", "lastname"]] = "Caccamo"
 print(d) # -> { "profile":{ "firstname":"Fabio", "lastname":"Caccamo" } }
 print(d["profile"]) # -> { "firstname":"Fabio", "lastname":"Caccamo" }
 
 # check if keypath exists in dict
-print(["profile", "lastname"] in d) # -> True
+print([["profile", "lastname"]] in d) # -> True
 
 # delete value by keys list
-del d["profile", "lastname"]
+del d[["profile", "lastname"]]
 print(d["profile"]) # -> { "firstname":"Fabio" }
 ```
 
@@ -546,7 +545,8 @@ items = d.items_sorted_by_values(reverse=False)
 ```python
 # Return a list of all keypaths in the dict.
 # If indexes is True, the output will include list values indexes.
-k = d.keypaths(indexes=False)
+# If sort is True, the resulting list will be sorted
+k = d.keypaths(indexes=False, sort=True)
 ```
 
 #### `match`

python-benedict-0.33.1/benedict/core/clean.py

@@ -1,19 +0,0 @@
-from benedict.utils import type_util
-
-
-def _clean_item(d, key, strings, collections):
-    value = d.get(key, None)
-    if not value:
-        del_none = value is None
-        del_string = strings and type_util.is_string(value)
-        del_collection = collections and type_util.is_collection(value)
-        return any([del_none, del_string, del_collection])
-
-    return False
-
-
-def clean(d, strings=True, collections=True):
-    keys = list(d.keys())
-    for key in keys:
-        if _clean_item(d, key, strings, collections):
-            del d[key]