annet 3.17.0__tar.gz → 3.18.0__tar.gz

{annet-3.17.0/annet.egg-info → annet-3.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 3.17.0
+Version: 3.18.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT

{annet-3.17.0 → annet-3.18.0}/annet/annlib/jsontools.py

@@ -6,13 +6,16 @@ import json
 from collections.abc import Mapping, Sequence
 from itertools import starmap
 from operator import itemgetter
-from typing import Any, Dict, Iterable, List, Optional
+from typing import Any, Dict, Final, Iterable, List, Optional
 
 import jsonpatch
 import jsonpointer
 from ordered_set import OrderedSet
 
 
+EVERYTHING_ACL: Final = "/*"
+
+
 def format_json(data: Any, stable: bool = False) -> str:
     """Serialize to json."""
     return json.dumps(data, indent=4, ensure_ascii=False, sort_keys=not stable) + "\n"
@@ -21,14 +24,17 @@ def format_json(data: Any, stable: bool = False) -> str:
 def apply_json_fragment(
         old: Dict[str, Any],
         new_fragment: Dict[str, Any], *,
-        acl: Sequence[str],
+        acl: Sequence[str] | None = None,
         filters: Sequence[str] | None = None,
 ) -> Dict[str, Any]:
     """
-    Replace parts of the old document with 'new_fragment' using ACL restrictions.
+    Replace parts of the old document with 'new_fragment'.
+    If `acl` is not `None`, replacement will only be made within specified keys.
     If `filter` is not `None`, only those parts which also matches at least one filter
     from the list will be modified (updated or deleted).
     """
+    if acl is None:
+        acl = [EVERYTHING_ACL]
     full_new_config = copy.deepcopy(old)
     for acl_item in acl:
         new_pointers = _resolve_json_pointers(acl_item, new_fragment)
@@ -91,7 +97,23 @@ def _pointer_set(pointer: jsonpointer.JsonPointer, doc: Any, value: Any) -> None
 
 def make_patch(old: Dict[str, Any], new: Dict[str, Any]) -> List[Dict[str, Any]]:
     """Generate a JSON patch by comparing the old document with the new one."""
-    return sorted(jsonpatch.make_patch(old, new).patch, key=itemgetter("path"))
+    # NOTE: changing order of the patch operations (e.g. sorting)
+    #  may interfere with the `move` logic.
+    #  E.g.:
+    #  ```python
+    #  old = [["a", "b"], ["c", "d"]]
+    #  new = [["d", "c"], ["b", "a"]]
+    #  ```
+    #  produces the following patch:
+    #  ```json
+    #  [{"op": "move", "path": "/0/0", "from": "/1/0"},
+    #   {"op": "move", "path": "/1/0", "from": "/0/2"},
+    #   {"op": "move", "path": "/0/0", "from": "/1/1"},
+    #   {"op": "move", "path": "/1/1", "from": "/0/2"}]
+    #  ```
+    #  which relies on proper ordering to be correctly applied.
+    #  See https://github.com/annetutil/annet/pull/452 for details.
+    return jsonpatch.make_patch(old, new).patch
 
 
 def apply_patch(content: Optional[bytes], patch_bytes: bytes) -> bytes:

{annet-3.17.0 → annet-3.18.0}/annet/gen.py

@@ -267,11 +267,20 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
             filters = filters_text.removesuffix("\n").split("\n")
 
         old_json_fragment_files = old_files.json_fragment_files.copy()
-        new_json_fragment_files = res.new_json_fragment_files(old_json_fragment_files, filters=filters)
+        new_json_fragment_files = res.new_json_fragment_files(
+            old_json_fragment_files,
+            use_acl=not ctx.args.no_acl,
+            filters=filters,
+        )
 
         if ctx.args.acl_safe:
             safe_new_files = res.new_files(safe=True)
-            safe_new_json_fragment_files = res.new_json_fragment_files(old_json_fragment_files, safe=True, filters=filters)
+            safe_new_json_fragment_files = res.new_json_fragment_files(
+                old_json_fragment_files,
+                use_acl=not ctx.args.no_acl,
+                safe=True,
+                filters=filters,
+            )
 
     if ctx.args.profile:
         perf = res.perf_mesures()

{annet-3.17.0 → annet-3.18.0}/annet/generators/result.py

@@ -85,6 +85,7 @@ class RunGeneratorResult:
     def new_json_fragment_files(
             self,
             old_files: Dict[str, Optional[str]],
+            use_acl: bool = True,
             safe: bool = False,
             filters: Sequence[str] | None = None,
     ) -> Dict[str, Tuple[Any, Optional[str]]]:
@@ -98,9 +99,12 @@ class RunGeneratorResult:
                     files[filepath] = (old_files[filepath], None)
                 else:
                     files[filepath] = ({}, None)
-            result_acl = generator_result.acl
-            if safe:
-                result_acl = generator_result.acl_safe
+            if use_acl:
+                result_acl = generator_result.acl
+                if safe:
+                    result_acl = generator_result.acl_safe
+            else:
+                result_acl = None
             previous_config: Dict[str, Any] = files[filepath][0]
             new_fragment = generator_result.config
             new_config = jsontools.apply_json_fragment(

{annet-3.17.0 → annet-3.18.0/annet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 3.17.0
+Version: 3.18.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT