annet 3.16.2__tar.gz → 3.17.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 3.16.2
+Version: 3.17.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -20,8 +20,9 @@ Requires-Dist: valkit>=0.1.4
 Requires-Dist: yarl>=1.8.2
 Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4
+Requires-Dist: ordered-set>=4.1.0
 Provides-Extra: netbox
-Requires-Dist: annetbox[sync]>=0.7.0; extra == "netbox"
+Requires-Dist: annetbox[sync]>=0.8.0; extra == "netbox"
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file

{annet-3.16.2 → annet-3.17.0}/README.md

@@ -53,21 +53,35 @@ selected_context: default
 
 Environment variable `ANN_SELECTED_CONTEXT` can be used to override `selected_context` parameter.
 
-## Building doc
+## Installation
 
-1. Install dependencies:
+Install from PyPI:
+```shell
+pip install annet
+```
 
+Or install from source:
 ```shell
-pip install -r requirements-doc.txt
+git clone https://github.com/annetutil/annet
+cd annet
+pip install -e .
 ```
 
+## Building doc
+1. Install dependencies:
+```shell
+pip install -r requirements-doc.txt
+```
 2. Build
-
 ```shell
 sphinx-build -M html docs docs-build
 ```
-
-3. Open rendered html in browser docs-build/html/index.html
+3. Open rendered html in browser
+```shell
+open docs-build/html/index.html  # macOS
+xdg-open docs-build/html/index.html  # Linux
+start docs-build/html/index.html  # Windows
+```
 
 ## Links
 

{annet-3.16.2 → annet-3.17.0}/annet/adapters/netbox/common/query.py

@@ -5,7 +5,7 @@ from typing import cast, List, Union, Iterable, Optional, TypedDict
 from annet.storage import Query
 
 FIELD_VALUE_SEPARATOR = ":"
-ALLOWED_GLOB_GROUPS = ["site", "tag", "role", "device_type", "status", "tenant"]
+ALLOWED_GLOB_GROUPS = ["site", "tag", "role", "device_type", "status", "tenant", "asset_tag"]
 
 
 class Filter(TypedDict, total=False):
@@ -16,6 +16,7 @@ class Filter(TypedDict, total=False):
     device_type: list[str]
     status: list[str]
     tenant: list[str]
+    asset_tag: list[str]
 
 
 @dataclass

{annet-3.16.2 → annet-3.17.0}/annet/adapters/netbox/provider.py

@@ -22,6 +22,7 @@ def storage_factory(opts: NetboxStorageOpts) -> Storage:
         "4.1": NetboxStorageV41,
         "4.2": NetboxStorageV42,
         "4.3": NetboxStorageV42,
+        "4.4": NetboxStorageV42,
     }
 
     status = None

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

@@ -10,6 +10,7 @@ from typing import Any, Dict, Iterable, List, Optional
 
 import jsonpatch
 import jsonpointer
+from ordered_set import OrderedSet
 
 
 def format_json(data: Any, stable: bool = False) -> str:
@@ -42,8 +43,7 @@ def apply_json_fragment(
 
         for pointer in new_pointers:
             new_value = pointer.get(new_fragment)
-            _ensure_pointer_exists(full_new_config, pointer)
-            pointer.set(full_new_config, new_value)
+            _pointer_set(pointer, full_new_config, new_value)
 
         # delete matched parts in old config whicn are not present in the new
         paths = {p.path for p in new_pointers}
@@ -56,31 +56,37 @@ def apply_json_fragment(
     return full_new_config
 
 
-def _ensure_pointer_exists(doc: Dict[str, Any], pointer: jsonpointer.JsonPointer) -> None:
+def _pointer_set(pointer: jsonpointer.JsonPointer, doc: Any, value: Any) -> None:
     """
-    Ensure that document has all pointer parts (if possible).
+    Resolve `pointer` against the `doc`, creating new elements if neccessary,
+    and set the target's value to `value`, all in place.
 
-    This is workaround for errors of type:
+    If `pointer` in any it's part points to the non-existing key,
+    or if value at this point is `None`, new object will be created.
+    (See https://github.com/stefankoegl/python-json-pointer/issues/41)
 
-    ```
-    jsonpointer.JsonPointerException: member 'MY_PART' not found in {}
-    ```
-
-    See for details: https://github.com/stefankoegl/python-json-pointer/issues/41
+    If `pointer` in any it's part points to the index of next to be appended
+    element of the array, new document / `value` will be appended to that list.
     """
-    parts_except_the_last = pointer.get_parts()[:-1]
-    doc_pointer: Dict[str, Any] = doc
-    for part in parts_except_the_last:
-        if isinstance(doc_pointer, dict):
-            if part not in doc_pointer or doc_pointer[part] is None:
-                # create an empty object by the pointer part
-                doc_pointer[part] = {}
-
-            # follow the pointer to delve deeper
-            doc_pointer = doc_pointer[part]
-        else:
-            # not a dict - cannot delve deeper
-            break
+    if len(pointer.parts) == 0:
+        raise jsonpointer.JsonPointerException("Cannot set root in place")
+    *parts_expect_the_last, last_part = pointer.parts
+
+    for part in parts_expect_the_last:
+        key = pointer.get_part(doc, part)
+        if isinstance(doc, dict):
+            if doc.get(key, None) is None:
+                doc[key] = {}
+        elif isinstance(doc, list):
+            if key == len(doc):
+                doc.append({})
+        doc = doc[key]
+
+    key = pointer.get_part(doc, last_part)
+    if isinstance(doc, list) and key == len(doc):
+        doc.append(value)
+    else:
+        doc[key] = value
 
 
 def make_patch(old: Dict[str, Any], new: Dict[str, Any]) -> List[Dict[str, Any]]:
@@ -175,12 +181,11 @@ def _apply_filters_to_json_pointers(
         pointers: Iterable[jsonpointer.JsonPointer],
         filters: Sequence[str], *,
         content: Any,
-) -> list[jsonpointer.JsonPointer]:
+) -> Sequence[jsonpointer.JsonPointer]:
 
     """
-    Takes a list of pointers, a list of filters and a document
-    and returns a list of pointers that match at least one of the filters
-    (if necessary, pointers may be deeper than from the input).
+    Takes a list of pointers, a list of filters and a document, and returns
+    a list of pointers that match at least one of the filters, preserving order.
 
     For example, given:
     pointers=["/foo", "/lorem/ipsum", "/lorem/dolor"],
@@ -205,7 +210,7 @@ def _apply_filters_to_json_pointers(
     ["/foo/bar/qux", "/lorem/ipsum", "/lorem/dolor"]
     """
 
-    ret: set[jsonpointer.JsonPointer] = set()
+    ret = OrderedSet[jsonpointer.JsonPointer]()
     for filter_item in filters:
         filter_parts = jsonpointer.JsonPointer(filter_item).parts
         for pointer in pointers:
@@ -222,7 +227,4 @@ def _apply_filters_to_json_pointers(
                 ret.update(map(pointer.join, _resolve_json_pointers(deeper_pattern, deeper_doc)))
             else:
                 ret.add(pointer)
-    # sort return value by some stable key, to decrease the chance
-    # that some bug may lead to unstable output being produced
-    # (since `type(ret) is set`)
-    return sorted(ret, key=str)
+    return ret

{annet-3.16.2 → annet-3.17.0}/annet/deploy.py

@@ -193,7 +193,8 @@ def fill_cmd_params(rules: OrderedDict, cmd: Command):
     if rule:
         cmd_params = make_cmd_params(rule)
         cmd.questions = cmd_params.get("questions", None)
-        cmd.timeout = cmd_params["timeout"]
+        if cmd.timeout is None:
+            cmd.timeout = cmd_params["timeout"]
 
 
 def apply_deploy_rulebook(hw: HardwareView, cmd_paths, do_finalize=True, do_commit=True):

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

@@ -489,8 +489,7 @@ def worker(device_id, args: ShowGenOptions, stdin, loader: "Loader", filterer: F
         # Consider result of partial run empty and create an empty dest file
         # only if there are some acl rules that has been matched.
         # Otherwise treat it as if no supported generators have been found.
-        acl_rules = res.get_acl_rules(args.acl_safe)
-        if acl_rules:
+        if args.no_acl or res.get_acl_rules(args.acl_safe):
             orderer = patching.Orderer.from_hw(device.hw)
             yield (output_driver.cfg_file_names(device)[0],
                    format_config_blocks(

{annet-3.16.2 → annet-3.17.0}/annet/vendors/library/h3c.py

@@ -14,7 +14,7 @@ class H3CVendor(AbstractVendor):
 
         before.add_cmd(Command("system-view"))
         if do_finalize:
-            after.add_cmd(Command("save force", timeout=90))
+            after.add_cmd(Command("save force", timeout=90, read_timeout=90))
 
         return before, after
 

{annet-3.16.2 → annet-3.17.0}/annet/vendors/library/juniper.py

@@ -14,7 +14,7 @@ class JuniperVendor(AbstractVendor):
 
         before.add_cmd(Command("configure exclusive"))
         if do_commit:
-            after.add_cmd(Command("commit", timeout=30))
+            after.add_cmd(Command("commit", timeout=30, read_timeout=30))
         after.add_cmd(Command("exit"))
 
         return before, after

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 3.16.2
+Version: 3.17.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -20,8 +20,9 @@ Requires-Dist: valkit>=0.1.4
 Requires-Dist: yarl>=1.8.2
 Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4
+Requires-Dist: ordered-set>=4.1.0
 Provides-Extra: netbox
-Requires-Dist: annetbox[sync]>=0.7.0; extra == "netbox"
+Requires-Dist: annetbox[sync]>=0.8.0; extra == "netbox"
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file

{annet-3.16.2 → annet-3.17.0}/annet.egg-info/requires.txt

@@ -11,6 +11,7 @@ valkit>=0.1.4
 yarl>=1.8.2
 adaptix==3.0.0b7
 dataclass-rest==0.4
+ordered-set>=4.1.0
 
 [netbox]
-annetbox[sync]>=0.7.0
+annetbox[sync]>=0.8.0

{annet-3.16.2 → annet-3.17.0}/requirements.txt

@@ -11,3 +11,4 @@ valkit>=0.1.4
 yarl>=1.8.2
 adaptix==3.0.0b7
 dataclass-rest==0.4
+ordered-set>=4.1.0

{annet-3.16.2 → annet-3.17.0}/setup.py

@@ -44,7 +44,7 @@ if __name__ == "__main__":
           ],
         },
         extras_require={
-            "netbox": ["annetbox[sync]>=0.7.0"],
+            "netbox": ["annetbox[sync]>=0.8.0"],
         },
         python_requires=">=3.10",
         install_requires=requirements(),