annet 0.8__py3-none-any.whl → 0.10__py3-none-any.whl

annet/annlib/jsontools.py

@@ -106,7 +106,7 @@ def apply_acl_filters(content: Dict[str, Any], filters: List[str]) -> Dict[str,
             patch = jsonpatch.JsonPatch([{"op": "add", "path": f, "value": part}])
             result = patch.apply(result)
         except jsonpointer.JsonPointerException:
-            # no value found in new_fragment by the pointer, skip the ACL item
+            # no value found in content by the pointer, skip the ACL item
             continue
 
     return result

annet/gen.py

@@ -216,6 +216,7 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
 
     new_files = {}
     safe_new_files = {}
+    safe_new_json_fragment_files = {}
     if not ctx.no_new:
         if device in ctx.fetched_packages:
             if ctx.args.required_packages_check:
@@ -238,23 +239,34 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
         new_files = res.new_files()
         new_json_fragment_files = res.new_json_fragment_files(old_json_fragment_files)
 
-        if ctx.args.acl_safe:
-            safe_new_files = res.new_files(safe=True)
+        filters: List[str] = []
+        filters_text = build_filter_text(filterer, device, ctx.stdin, ctx.args, ctx.config)
+        if filters_text:
+            filters = filters_text.split("\n")
 
-        filters = build_filter_text(filterer, device, ctx.stdin, ctx.args, ctx.config).split("\n")
+            for file_name in new_json_fragment_files:
+                new_json_fragment_files = _update_json_config(
+                    new_json_fragment_files,
+                    file_name,
+                    jsontools.apply_acl_filters(new_json_fragment_files[file_name][0], filters)
+                )
+            for file_name in old_json_fragment_files:
+                old_json_fragment_files = _update_json_config(
+                    old_json_fragment_files,
+                    file_name,
+                    jsontools.apply_acl_filters(old_json_fragment_files[file_name][0], filters)
+                )
 
-        for file_name in new_json_fragment_files:
-            new_json_fragment_files = _update_json_config(
-                new_json_fragment_files,
-                file_name,
-                jsontools.apply_acl_filters(new_json_fragment_files[file_name][0], filters)
-            )
-        for file_name in old_json_fragment_files:
-            old_json_fragment_files = _update_json_config(
-                old_json_fragment_files,
-                file_name,
-                jsontools.apply_acl_filters(old_json_fragment_files[file_name][0], 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)
+            if filters:
+                for file_name in safe_new_json_fragment_files:
+                    safe_new_json_fragment_files = _update_json_config(
+                        safe_new_json_fragment_files,
+                        file_name,
+                        jsontools.apply_acl_filters(safe_new_json_fragment_files[file_name][0], filters)
+                    )
 
     if ctx.args.profile:
         perf = res.perf_mesures()
@@ -281,6 +293,7 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
         safe_old=safe_old,
         safe_new=safe_new,
         safe_new_files=safe_new_files,
+        safe_new_json_fragment_files=safe_new_json_fragment_files,
         filter_acl_rules=filter_acl_rules,
     )
 

annet/generators/__init__.py

@@ -180,9 +180,8 @@ class RunGeneratorResult:
     def new_json_fragment_files(
             self,
             old_files: Dict[str, Optional[str]],
-            safe: bool = False,  # pylint: disable=unused-argument
+            safe: bool = False,
     ) -> Dict[str, Tuple[Any, Optional[str]]]:
-        # TODO: safe
         files: Dict[str, Tuple[Any, Optional[str]]] = {}
         reload_prios: Dict[str, int] = {}
         for generator_result in self.json_fragment_results.values():
@@ -194,7 +193,12 @@ class RunGeneratorResult:
                     files[filepath] = ({}, None)
             previous_config: Dict[str, Any] = files[filepath][0]
             new_fragment = generator_result.config
-            new_config = jsontools.apply_json_fragment(previous_config, new_fragment, generator_result.acl)
+
+            if safe:
+                new_config = jsontools.apply_json_fragment(previous_config, new_fragment, generator_result.acl_safe)
+            else:
+                new_config = jsontools.apply_json_fragment(previous_config, new_fragment, generator_result.acl)
+
             if filepath in reload_prios and reload_prios[filepath] > generator_result.reload_prio:
                 _, reload_cmd = files[filepath]
             else:
@@ -496,18 +500,24 @@ def _run_json_fragment_generator(
     logger = get_logger(generator=_make_generator_ctx(gen))
     if not gen.supports_device(device):
         logger.info("generator %s is not supported for device %s", gen, device.hostname)
+        return
 
     path = gen.path(device)
     if not path:
         raise RuntimeError("json fragment generator should return non-empty path")
 
     acl_item_or_list_of_items = gen.acl(device)
+    safe_acl_item_or_list_of_items = gen.acl_safe(device)
     if not acl_item_or_list_of_items:
         raise RuntimeError("json fragment generator should return non-empty acl")
     if isinstance(acl_item_or_list_of_items, list):
         acl = acl_item_or_list_of_items
     else:
         acl = [acl_item_or_list_of_items]
+    if isinstance(safe_acl_item_or_list_of_items, list):
+        acl_safe = safe_acl_item_or_list_of_items
+    else:
+        acl_safe = [safe_acl_item_or_list_of_items]
 
     logger.info("Generating JSON_FRAGMENT ...")
     with GeneratorPerfMesurer(gen, storage) as pm:
@@ -518,10 +528,10 @@ def _run_json_fragment_generator(
         tags=gen.TAGS,
         path=path,
         acl=acl,
+        acl_safe=acl_safe,
         config=config,
         reload=reload_cmds,
         perf=pm.last_result,
-        is_safe=gen.is_safe(device),
         reload_prio=gen.reload_prio,
     )
 
@@ -935,14 +945,17 @@ class JSONFragment(TreeGenerator):
         """
         raise NotImplementedError("Required ACL for JSON_FRAGMENT generator")
 
+    def acl_safe(self, device: Device) -> Union[str, List[str]]:
+        """
+        Restrict the generator to a specified safe ACL using JSON Pointer syntax.
+
+        Expected ACL to be a list of strings, but a single string is also allowed.
+        """
+        raise NotImplementedError("Required ACL for JSON_FRAGMENT generator")
+
     def run(self, device: Device):
         raise NotImplementedError
 
-    # pylint: disable=unused-argument
-    def is_safe(self, device: Device) -> bool:
-        """Output gen results when --acl-safe flag is used"""
-        return False
-
     def get_reload_cmds(self, device: Device) -> str:
         ret = self.reload(device) or ""
         return ret

annet/types.py

@@ -126,20 +126,20 @@ class GeneratorJSONFragmentResult:
         tags: List[str],
         path: str,
         acl: List[str],
+        acl_safe: List[str],
         config: Dict[str, Any],
         reload: str,
         perf: GeneratorPerf,
-        is_safe: bool,
         reload_prio: int,
     ):
         self.name = name
         self.tags = tags
         self.path = path
         self.acl = acl
+        self.acl_safe = acl_safe
         self.config = config
         self.reload = reload
         self.perf = perf
-        self.is_safe = is_safe
         self.reload_prio = reload_prio
 
 
@@ -171,6 +171,7 @@ class OldNewResult:
         safe_old=None,
         safe_new=None,
         safe_new_files=None,
+        safe_new_json_fragment_files=None,
         filter_acl_rules=None
     ):
         self.device: Device = device
@@ -193,6 +194,7 @@ class OldNewResult:
         self.safe_old: MutableMapping = safe_old if safe_old else OrderedDict()
         self.safe_new: MutableMapping = safe_new if safe_new else OrderedDict()
         self.safe_new_files: MutableMapping = safe_new_files if safe_new_files else {}
+        self.safe_new_json_fragment_files: MutableMapping = safe_new_json_fragment_files or {}
 
         self.filter_acl_rules: Optional[MutableMapping] = filter_acl_rules
 
@@ -221,5 +223,7 @@ class OldNewResult:
         return self.new_files
 
     def get_new_file_fragments(self, safe: bool = False) -> Dict[str, Tuple[Any, Optional[str]]]:  # pylint: disable=unused-argument
-        # TODO: safe
+        if safe:
+            return self.safe_new_json_fragment_files
+
         return self.new_json_fragment_files

{annet-0.8.dist-info → annet-0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annet
-Version: 0.8
+Version: 0.10
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT

{annet-0.8.dist-info → annet-0.10.dist-info}/RECORD

@@ -8,7 +8,7 @@ annet/deploy.py,sha256=B8E0P_VvCrS2URjFvgmUiIkHp95g7pAWfmT34igaDeo,18893
 annet/diff.py,sha256=zLcaCnb4lZRUb7frpH1CstQ3kacRcCblZs1uLG8J5lk,3391
 annet/executor.py,sha256=bw7COJNtssuxIqbQehlHYJnkdUeYvvL8WO5B-c67XE0,19040
 annet/filtering.py,sha256=F4ZKUCU3Yb1RlL2zKdyHtVUaWPzjWF4vWyMcdygKNYk,852
-annet/gen.py,sha256=MI82tdc-r3leiyp4Oa35PBsrfj0jNKdbASRnQ8Rk39g,32336
+annet/gen.py,sha256=FFIzfDudMihS824wmTPMuFTOWRwn0EZac-VxITrlyTw,33068
 annet/hardware.py,sha256=HYPDfji_GdRn5S0_0fl4rvM7byOY9aHxG6VMAtsLaxE,1090
 annet/implicit.py,sha256=QigK4uoxvrFho2h9yFjOq1d9rLsC5xFlAU4bKkCuMWk,5139
 annet/lib.py,sha256=zQIfNBg7fAAk2BHbHAqy_McAiXhz0RqpBAcfdU-6pAA,3742
@@ -20,7 +20,7 @@ annet/storage.py,sha256=V1AQDGxaAEKC5EXOcPy2DqglR_sUdp3l_AS_2c1CFfA,2299
 annet/tabparser.py,sha256=ZjiI43ZVbrpMVR8qNbTbNh_U3oZ26VDc_2Y9wkkDkYA,874
 annet/text_term_format.py,sha256=CHb6viv45vmYl-SK1A1vyPHGhaEni6jVybBusaQnct8,2813
 annet/tracing.py,sha256=ndpM-au1c88uBBpOuH_z52qWZL773edYozNyys_wA68,4044
-annet/types.py,sha256=f0iwSJGSQ7GvWeXgXqBCoxzYNezMa4YASQEHJzWUrWU,6962
+annet/types.py,sha256=wT1z1DM-hcjfHizmLxAe9aUi4uhuQ13POiV_MTygUJM,7158
 annet/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/adapters/netbox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/adapters/netbox/provider.py,sha256=OM7Hq2vnMHNVBfubJvx2qJlMYm3VvKhomdLMNO8YnLQ,1024
@@ -44,7 +44,7 @@ annet/annlib/command.py,sha256=uuBddMQphtn8P5MO5kzIa8_QrtMns-k05VeKv1bcAuA,1043
 annet/annlib/diff.py,sha256=UPt3kYFQdQdVVy3ePYzNHPAxMVmHxCrCnZnMCV6ou2Q,4587
 annet/annlib/errors.py,sha256=jBcSFzY6Vj-FxR__vqjFm-87AwYQ0xHuAopTirii5AU,287
 annet/annlib/filter_acl.py,sha256=0w1VF6WcONiTYTQh0yWi6_j9rCTc_kMLAUMr0hbdkNU,7203
-annet/annlib/jsontools.py,sha256=TJazOP-1njwbGN7iIz8oGYgWPdry4XfKLjpzNYxdvjg,3364
+annet/annlib/jsontools.py,sha256=_astuRFlt4KlDrneAbuL-HWt1ceu0pWp13skGoV0k-c,3359
 annet/annlib/lib.py,sha256=eJ4hcVuQ6pdYBzLs4YKCHFtq45idOfZCYp92XfF7_QI,15317
 annet/annlib/output.py,sha256=_SjJ6G6bejvnTKqNHw6xeio0FT9oO3OIkLaOC3cEga4,7569
 annet/annlib/patching.py,sha256=Gh8uUjFyYND9TJBBQH-DH6-AwFiiR-dXVXOisMS7elg,19784
@@ -68,7 +68,7 @@ annet/annlib/rulebook/common.py,sha256=9kCZwZpsH5UliF2OzaN9nLs2eLlz_d__4L7_oZ3Sr
 annet/api/__init__.py,sha256=VooP9u9f6e8vF7FPUE-r0JAGqCjck9-2b0dVNWAtoLM,33752
 annet/configs/context.yml,sha256=nt4QnzYzrG2hqmaWOUsab2wgFl-CXmFSzbto6rqqFt4,291
 annet/configs/logging.yaml,sha256=Hu42lRK248dssp9TgkbHCaZNl0E6f4IChGb0XaQnTVo,970
-annet/generators/__init__.py,sha256=iOTaIfTQfGoExmSAzqt1RSWP7V1O_pEkuqvjnsEjBkQ,34476
+annet/generators/__init__.py,sha256=0aswTm4MD_DWas0iwQQI8DaGX1iRQYHXHg6sl8549CI,34979
 annet/generators/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/generators/common/initial.py,sha256=XI7uWLMuLrHC-uXm38oRbM1YVuELAvMHLZFHM9x5IF8,1229
 annet/rulebook/__init__.py,sha256=14IpOfTbeJtre7JKrfXVYiH0qAXsUSOL7AatUFmSQs0,3847
@@ -120,10 +120,10 @@ annet/rulebook/texts/routeros.rul,sha256=ipfxjj0mjFef6IsUlupqx4BY_Je_OUb8u_U1019
 annet_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet_generators/example/__init__.py,sha256=zVd8_DrXuOASrNzg2Ab94rPyvJff83L-_HppDFxnUjM,228
 annet_generators/example/lldp.py,sha256=68CLrK7vxTQQy9XIBxtywuEdBNlIlfXGYj8_wYWs5UI,1146
-annet-0.8.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
-annet-0.8.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
-annet-0.8.dist-info/METADATA,sha256=biTv9OtMLS-HnbvanEbTm3B-tYG9SGFV-TSQCtem7cE,691
-annet-0.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-annet-0.8.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
-annet-0.8.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
-annet-0.8.dist-info/RECORD,,
+annet-0.10.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
+annet-0.10.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
+annet-0.10.dist-info/METADATA,sha256=wUvxu4XGIQ0tSRIwoetdSNG45tkxpO70zPAngL0NN5Y,692
+annet-0.10.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+annet-0.10.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
+annet-0.10.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
+annet-0.10.dist-info/RECORD,,