dotted-notation 0.44.8__tar.gz → 0.44.10__tar.gz

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/CHANGELOG.md

@@ -3,6 +3,57 @@
 All notable changes to `dotted` are recorded here. Versions prior to
 the ones listed are omitted — browse git history for earlier entries.
 
+## [0.44.10]
+
+### Performance
+- `build()` and `build_multi()` keep the parsed paths they expand
+  instead of assembling each one to a string and parsing it again. A
+  pattern matching more paths than the parse cache holds (300) used to
+  miss on every one; `build` over 1000 matches is about 35x faster.
+
+### Changed
+- Three edge cases of `build()` change with the string round trip gone:
+  with `strict=True`, a trailing `[]` or `[:]` now creates the empty
+  list where it was a no-op, and raises `TypeError` on a list root; a
+  wildcard over keys that cannot be written as a path, such as `None` or
+  `True`, now succeeds where it raised `AttributeError`.
+
+### Added
+- Benchmark suite: `python -m benchmarks` or `make bench`. Times reads
+  and writes at two data sizes, and the copying cases under both
+  `copy.deepcopy` and copium. Results can be saved and compared.
+
+### Fixed
+- `make` targets failed because the install rule depended on
+  `setup.py`, removed in the move to `pyproject.toml`.
+
+### Documentation
+- README caveat for the `copium` extra: copium 0.1.0 gets slower at
+  copying small objects once it has copied a large one in the same
+  process. Reported upstream as
+  [copium#54](https://github.com/percolab/copium/issues/54).
+
+## [0.44.9]
+
+### Performance
+- Optional [copium](https://github.com/Bobronium/copium) support: a C
+  implementation of `copy.deepcopy` with the same semantics. When
+  installed, the copies made by `mutable=False` updates and removes and
+  by `build()` use it (roughly 5-20x faster on plain nested data);
+  otherwise dotted falls back to `copy.deepcopy`. Install with
+  `pip install dotted-notation[copium]` (CPython 3.10+).
+
+### Added
+- `copium` extra, and a `formats` extra bundling YAML and TOML support.
+
+### Deprecated
+- The `all` extra. It is an alias for `formats` and will be removed in
+  a future release.
+
+### Changed
+- When copium is installed the test suite runs every test function
+  under both deepcopy implementations.
+
 ## [0.44.8]
 
 ### Added

{dotted_notation-0.44.8/dotted_notation.egg-info → dotted_notation-0.44.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dotted_notation
-Version: 0.44.8
+Version: 0.44.10
 Summary: Dotted notation for safe nested data traversal with optional chaining, pattern matching, and transforms
 Author-email: Frey Waid <logophage1@gmail.com>
 License: MIT
@@ -27,11 +27,17 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyparsing>=3.0
+Provides-Extra: copium
+Requires-Dist: copium>=0.1.0; (python_version >= "3.10" and platform_python_implementation == "CPython") and extra == "copium"
 Provides-Extra: yaml
 Requires-Dist: PyYAML>=5.0; extra == "yaml"
 Provides-Extra: toml
 Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "toml"
 Requires-Dist: tomli_w>=1.0; extra == "toml"
+Provides-Extra: formats
+Requires-Dist: PyYAML>=5.0; extra == "formats"
+Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "formats"
+Requires-Dist: tomli_w>=1.0; extra == "formats"
 Provides-Extra: all
 Requires-Dist: PyYAML>=5.0; extra == "all"
 Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "all"
@@ -61,12 +67,28 @@ Since this package includes the [**`dq`** command-line tool](#cli-dq), several d
 
 To install optional format support:
 
-    pip install dotted-notation[all]
+    pip install dotted-notation[formats]
 
 Or pick only what you need:
 
     pip install dotted-notation[yaml,toml]
 
+> **Deprecated:** the `all` extra is an alias for `formats` and will be removed
+> in a future release. Use `formats` instead.
+
+For faster `mutable=False` updates and removes, install the
+[copium](https://github.com/Bobronium/copium) extra, a C implementation of
+`copy.deepcopy` (CPython 3.10+). Dotted uses it when present and falls back to
+`copy.deepcopy` otherwise:
+
+    pip install dotted-notation[copium]
+
+> **Caveat (copium 0.1.0):** after copium copies a large object, its copies of
+> small objects in the same process become slower than `copy.deepcopy` and stay
+> that way. Copying whole documents is 3-9x faster, but a long-running process
+> that mixes one large copy with many small ones can come out slower overall.
+> Tracked upstream in [copium#54](https://github.com/percolab/copium/issues/54).
+
 ## Table of Contents
 
 - [Safe Traversal (Optional Chaining)](#safe-traversal-optional-chaining)

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/README.md

@@ -21,12 +21,28 @@ Since this package includes the [**`dq`** command-line tool](#cli-dq), several d
 
 To install optional format support:
 
-    pip install dotted-notation[all]
+    pip install dotted-notation[formats]
 
 Or pick only what you need:
 
     pip install dotted-notation[yaml,toml]
 
+> **Deprecated:** the `all` extra is an alias for `formats` and will be removed
+> in a future release. Use `formats` instead.
+
+For faster `mutable=False` updates and removes, install the
+[copium](https://github.com/Bobronium/copium) extra, a C implementation of
+`copy.deepcopy` (CPython 3.10+). Dotted uses it when present and falls back to
+`copy.deepcopy` otherwise:
+
+    pip install dotted-notation[copium]
+
+> **Caveat (copium 0.1.0):** after copium copies a large object, its copies of
+> small objects in the same process become slower than `copy.deepcopy` and stay
+> that way. Copying whole documents is 3-9x faster, but a long-running process
+> that mixes one large copy with many small ones can come out slower overall.
+> Tracked upstream in [copium#54](https://github.com/percolab/copium/issues/54).
+
 ## Table of Contents
 
 - [Safe Traversal (Optional Chaining)](#safe-traversal-optional-chaining)

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/dotted/api.py

@@ -1,7 +1,6 @@
 """
 Main api
 """
-import copy
 import enum
 import functools
 import itertools
@@ -14,6 +13,7 @@ from . import transforms
 from . import base
 from . import access
 from . import matchers
+from . import utils
 from . import utypes
 
 
@@ -396,6 +396,23 @@ _mutable = mutable
 is_mutable = mutable
 
 
+def _pluck_parsed(obj, ops, strict=False):
+    """
+    Yield deduped (parsed path, value) pairs from obj matching `ops`.
+    Like pluck_multi, but the paths stay parsed so callers that hand them
+    straight back to dotted skip the assemble and re-parse.
+    """
+    seen = set()
+    for path, val in engine.walk(ops, obj, paths=True, strict=strict):
+        if path is utypes.CUT_SENTINEL:
+            break
+        found = results.Dotted({'ops': path, 'transforms': ops.transforms})
+        if found in seen:
+            continue
+        seen.add(found)
+        yield (found, val)
+
+
 def build_multi(obj, paths, strict=False, bindings=None):
     """
     Build a subset/default obj based on concrete path fields
@@ -406,8 +423,9 @@ def build_multi(obj, paths, strict=False, bindings=None):
     if obj is AUTO:
         obj = _auto_root(((p, None) for p in paths))
     for path in paths:
-        built = engine.build(parse(path, bindings=bindings, partial=False), obj, strict=strict)
-        obj = update_multi(obj, pluck_multi(built, (path,), strict=strict), strict=strict)
+        ops = parse(path, bindings=bindings, partial=False)
+        built = engine.build(ops, obj, strict=strict)
+        obj = update_multi(obj, _pluck_parsed(built, ops, strict=strict), strict=strict)
     return obj
 
 
@@ -544,7 +562,7 @@ def update_if(obj, path, val, pred=lambda val: val is not None, mutable=True, ap
     if obj is AUTO:
         obj = _auto_root_from_path(path)
     if not mutable and _is_mutable_container(obj):
-        obj = copy.deepcopy(obj)
+        obj = utils.deepcopy(obj)
         mutable = True
 
     if pred is not None and not pred(val):
@@ -562,7 +580,7 @@ def update_if_multi(obj, items, pred=lambda val: val is not None, mutable=True,
     {'a': 1, 'c': 3}
     """
     if not mutable and _is_mutable_container(obj):
-        obj = copy.deepcopy(obj)
+        obj = utils.deepcopy(obj)
         mutable = True
     for item in items:
         path, val, *rest = item
@@ -646,7 +664,7 @@ def remove_if(obj, path, pred=lambda path: path is not None, val=ANY, mutable=Tr
     if obj is AUTO:
         obj = _auto_root_from_path(path)
     if not mutable and _is_mutable_container(obj):
-        obj = copy.deepcopy(obj)
+        obj = utils.deepcopy(obj)
         mutable = True
 
     if pred is not None and not pred(path):
@@ -663,7 +681,7 @@ def remove_if_multi(obj, items, paths_only=True, pred=lambda path: path is not N
     {}
     """
     if not mutable and _is_mutable_container(obj):
-        obj = copy.deepcopy(obj)
+        obj = utils.deepcopy(obj)
         mutable = True
 
     if paths_only:

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/dotted/engine.py

@@ -3,10 +3,10 @@ Traversal engine for dotted path operations.
 
 Core traversal functions (walk, gets, updates, removes, expands).
 """
-import copy
 
 from . import base
 from . import matchers
+from . import utils
 from . import wrappers
 from .access import Attr, Slot
 from .results import Dotted
@@ -42,7 +42,7 @@ def build(ops, node, deepcopy=True, **kwargs):
     built = node.__class__()
     for k,v in cur.items(node, **kwargs):
         if not ops:
-            built = cur.update(built, k, copy.deepcopy(v) if deepcopy else v)
+            built = cur.update(built, k, utils.deepcopy(v) if deepcopy else v)
         else:
             built = cur.update(built, k, build(ops, v, deepcopy=deepcopy, **kwargs))
     return built or build_default([cur]+ops)

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/dotted/utils.py

@@ -1,6 +1,12 @@
 """
 Shared type-checking helpers (duck-typing).
 """
+try:
+    # C implementation of copy.deepcopy with identical semantics;
+    # installed by the [copium] extra.
+    from copium import deepcopy
+except ImportError:
+    from copy import deepcopy
 
 class lazyprop:
     """

{dotted_notation-0.44.8 → dotted_notation-0.44.10/dotted_notation.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dotted_notation
-Version: 0.44.8
+Version: 0.44.10
 Summary: Dotted notation for safe nested data traversal with optional chaining, pattern matching, and transforms
 Author-email: Frey Waid <logophage1@gmail.com>
 License: MIT
@@ -27,11 +27,17 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyparsing>=3.0
+Provides-Extra: copium
+Requires-Dist: copium>=0.1.0; (python_version >= "3.10" and platform_python_implementation == "CPython") and extra == "copium"
 Provides-Extra: yaml
 Requires-Dist: PyYAML>=5.0; extra == "yaml"
 Provides-Extra: toml
 Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "toml"
 Requires-Dist: tomli_w>=1.0; extra == "toml"
+Provides-Extra: formats
+Requires-Dist: PyYAML>=5.0; extra == "formats"
+Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "formats"
+Requires-Dist: tomli_w>=1.0; extra == "formats"
 Provides-Extra: all
 Requires-Dist: PyYAML>=5.0; extra == "all"
 Requires-Dist: tomli>=1.0; python_version < "3.11" and extra == "all"
@@ -61,12 +67,28 @@ Since this package includes the [**`dq`** command-line tool](#cli-dq), several d
 
 To install optional format support:
 
-    pip install dotted-notation[all]
+    pip install dotted-notation[formats]
 
 Or pick only what you need:
 
     pip install dotted-notation[yaml,toml]
 
+> **Deprecated:** the `all` extra is an alias for `formats` and will be removed
+> in a future release. Use `formats` instead.
+
+For faster `mutable=False` updates and removes, install the
+[copium](https://github.com/Bobronium/copium) extra, a C implementation of
+`copy.deepcopy` (CPython 3.10+). Dotted uses it when present and falls back to
+`copy.deepcopy` otherwise:
+
+    pip install dotted-notation[copium]
+
+> **Caveat (copium 0.1.0):** after copium copies a large object, its copies of
+> small objects in the same process become slower than `copy.deepcopy` and stay
+> that way. Copying whole documents is 3-9x faster, but a long-running process
+> that mixes one large copy with many small ones can come out slower overall.
+> Tracked upstream in [copium#54](https://github.com/percolab/copium/issues/54).
+
 ## Table of Contents
 
 - [Safe Traversal (Optional Chaining)](#safe-traversal-optional-chaining)

dotted_notation-0.44.10/dotted_notation.egg-info/requires.txt

@@ -0,0 +1,29 @@
+pyparsing>=3.0
+
+[all]
+PyYAML>=5.0
+tomli_w>=1.0
+
+[all:python_version < "3.11"]
+tomli>=1.0
+
+[copium]
+
+[copium:python_version >= "3.10" and platform_python_implementation == "CPython"]
+copium>=0.1.0
+
+[formats]
+PyYAML>=5.0
+tomli_w>=1.0
+
+[formats:python_version < "3.11"]
+tomli>=1.0
+
+[toml]
+tomli_w>=1.0
+
+[toml:python_version < "3.11"]
+tomli>=1.0
+
+[yaml]
+PyYAML>=5.0

{dotted_notation-0.44.8 → dotted_notation-0.44.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dotted_notation"
-version = "0.44.8"
+version = "0.44.10"
 description = "Dotted notation for safe nested data traversal with optional chaining, pattern matching, and transforms"
 readme = "README.md"
 requires-python = ">=3.6"
@@ -44,8 +44,15 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+copium = ['copium>=0.1.0;python_version>="3.10" and platform_python_implementation=="CPython"']
 yaml = ["PyYAML>=5.0"]
 toml = ['tomli>=1.0;python_version<"3.11"', "tomli_w>=1.0"]
+formats = [
+    "PyYAML>=5.0",
+    'tomli>=1.0;python_version<"3.11"',
+    "tomli_w>=1.0",
+]
+# DEPRECATED: legacy alias for formats, to be removed in a future release
 all  = [
     "PyYAML>=5.0",
     'tomli>=1.0;python_version<"3.11"',

dotted_notation-0.44.8/dotted_notation.egg-info/requires.txt

@@ -1,17 +0,0 @@
-pyparsing>=3.0
-
-[all]
-PyYAML>=5.0
-tomli_w>=1.0
-
-[all:python_version < "3.11"]
-tomli>=1.0
-
-[toml]
-tomli_w>=1.0
-
-[toml:python_version < "3.11"]
-tomli>=1.0
-
-[yaml]
-PyYAML>=5.0