ansible-vars 1.0.16__tar.gz → 1.0.18__tar.gz

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansible-vars
-Version: 1.0.16
+Version: 1.0.18
 Summary: Manage vaults and variable files for Ansible
 Project-URL: Homepage, https://github.com/xorwow/ansible-vars
 Project-URL: Issues, https://github.com/xorwow/ansible-vars/issues

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ansible-vars"
-version = "1.0.16"
+version = "1.0.18"
 authors = [
   { name="xorwow", email="pip@xorwow.de" },
 ]

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/src/ansible_vars/cli.py

@@ -33,7 +33,7 @@ from pygments.formatters import TerminalFormatter, Terminal256Formatter, Termina
 from .vault import VaultFile, EncryptedVar, ProtoEncryptedVar
 from .vault_crypt import VaultKey, VaultKeyring
 from .util import DiffFileLogger, VaultDaemon
-from .constants import Unset, MatchLocation, SENTINEL_KEY
+from .constants import Unset, MatchLocation, SENTINEL_KEY, APPEND_SENTINEL
 from .errors import YAMLFormatError, UnsupportedGenericFileOperation
 
 ## CLI argument parsing
@@ -183,13 +183,13 @@ The value will be shown in (recursively) decrypted form.
 JSON mode formatting:
 - [ ... ] or { ... } for lists/dictionaries, "<value>" for strings, <value> for numbers
 ''',
-    'cmd_set': '''
+    'cmd_set': f"""
 Creates or updates a node in a vault with a YAML value, optionally encrypting the value('s string leaves) first using the configured encryption key.
-For creating a new list entry, the last specified key segment has to equal the largest index of the list plus one (e.g. `[5]` for a list of length 5).
+Any unknown keys along the given path will be created as dictionaries. You can append an element to a list by using the special key '{ APPEND_SENTINEL }'.
 The value is interpreted as YAML code.
 
 [!] Creating new nodes or changing non-leaf nodes may break/remove trailing comments and Jinja2 blocks.
-''',
+""",
     'cmd_del': '''
 Deletes a node from a vault if it exists.
 

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/src/ansible_vars/constants.py

@@ -45,6 +45,11 @@ EDIT_MODE_HEADER: str = f"""
 
 """.lstrip('\n')
 
+# Special codes
+
+# Marks that a new element should be appended to a list in a `Vault.set` call
+APPEND_SENTINEL: str = '+'
+
 # Diff log filenames
 
 # Default filename for a plaintext vault log

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/src/ansible_vars/util.py

@@ -3,7 +3,6 @@
 # Standard library imports
 import os, atexit
 from glob import glob
-from pathlib import Path
 from functools import wraps
 from datetime import datetime
 from typing import Callable
@@ -38,7 +37,7 @@ class DiffLogger():
         You can specify an optional comment string which will be included.
         '''
         # Check if any changes happened
-        diff: list[str] = curr_vault.diff(prev_vault, context_lines=0, show_filenames=True).split('\n')
+        diff: str | None = curr_vault.diff(prev_vault, context_lines=0, show_filenames=True)
         if not force and not diff:
             return None
         # Build entry
@@ -55,7 +54,7 @@ class DiffLogger():
         # Diff
         lines.append('DIFF')
         if diff:
-            lines += diff
+            lines += diff.split('\n')
         else:
             lines.append('No changes.')
         #lines.append(OUTER_SEP)

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/src/ansible_vars/vault.py

@@ -15,7 +15,8 @@ from ruamel.yaml.constructor import Constructor
 from ruamel.yaml.comments import CommentedMap
 
 # Internal module imports
-from .constants import ThrowError, octal, Indexable, ChangeList, MatchLocation, SENTINEL_KEY, EDIT_MODE_HEADER, ENCRYPTED_VAR_TAG
+from .constants import ThrowError, octal, Indexable, ChangeList, MatchLocation, \
+                       SENTINEL_KEY, EDIT_MODE_HEADER, ENCRYPTED_VAR_TAG, APPEND_SENTINEL
 from .vault_crypt import VaultKey, VaultKeyring
 from .errors import KeyExistsError, NoVaultKeysError, YAMLFormatError
 
@@ -242,11 +243,12 @@ class Vault():
             self, path: DictPath, value: Any, overwrite: bool | Type[ThrowError] = True, # type: ignore
             create_parents: bool | Type[ThrowError] = True, encrypt: bool = False
         ) -> bool:
-        '''
+        f"""
         Creates or updates a value in the vault's variables. The value has to be serializable into YAML.
         If the last/only key of the key path does not exist yet, it will be created.
         If the variable is set successfully, `True` is returned. If any of the below checks fail, `False` is returned.
-        Be aware that appending a new entry to a list requires the key to be equal to the length of the list (i.e. largest index + 1).
+        Be aware that appending a new entry to a list requires the key to be equal to the length of the list (i.e. largest index + 1),
+        or to be the special symbol '{ APPEND_SENTINEL }'.
         On updated leaf values, comment and Jinja2 metadata is preserved.
         When appending a new value or editing an indexable item, metadata may get messed up.
 
@@ -262,7 +264,7 @@ class Vault():
         - `encrypt`: Controls if the value should be recursively encrypted before storing it (only plain `str`s get encrypted)
           - `True`: Attempt to copy and convert the value('s leaf values) into an `EncryptedVar` before storing it
           - `False`: Store the value as-is
-        '''
+        """
         path: tuple[Hashable, ...] = Vault._to_path(path) # XXX typer complains if not explicitly re-typed
         # Encrypt value if necessary
         if encrypt:
@@ -288,10 +290,13 @@ class Vault():
             if not isinstance(parent, dict | list):
                 raise TypeError(f"Indexing into a { type(parent) } is not supported ({ par_path })")
             # Check if index is of correct type
-            if isinstance(parent, list) and type(segment) is not int:
-                raise TypeError(f"Type of list index has to be int, got { type(segment) } ({ par_path }[{ segment }])")
+            if isinstance(parent, list) and segment != APPEND_SENTINEL and type(segment) is not int:
+                raise TypeError(f"Type of list index has to be int (or str as '{ APPEND_SENTINEL }'), got { type(segment) } ({ par_path }[{ segment }])")
             # Check if the current segment has to be created in the parent
-            if (isinstance(parent, dict) and segment not in parent) or (isinstance(parent, list) and cast(int, segment) >= len(parent)):
+            if (
+                (isinstance(parent, dict) and segment not in parent) or \
+                (isinstance(parent, list) and (segment == APPEND_SENTINEL or cast(int, segment) >= len(parent)))
+            ):
                 if not is_last:
                     if create_parents is ThrowError:
                         raise KeyError(f"Parents of { '.'.join(map(str, path)) } could not be resolved ({ segment } not in { par_path })")
@@ -299,9 +304,9 @@ class Vault():
                         return False
                 # Create nested dictionary as next parent or set value of leaf, depending on index
                 segment_value: Any = value if is_last else CommentedMap()
-                # Check that a new list item has a specified index of (largest list index + 1)
+                # Check that a new list item has a specified index of (largest list index + 1) or is the special append sentinel
                 # This is done because the method of creating an index of e.g. 7 in a list of length 3 is ambiguous
-                if isinstance(parent, list) and segment != len(parent):
+                if isinstance(parent, list) and segment != len(parent) and segment != APPEND_SENTINEL:
                     raise IndexError(f"Creating new list item, but index { segment } exceeds appendment index { len(parent) } ({ par_path })")
                 # Set value
                 if isinstance(parent, dict):
@@ -316,6 +321,8 @@ class Vault():
                     return False
                 parent[segment] = value # type: ignore
             # Advance parent
+            if isinstance(parent, list) and segment == APPEND_SENTINEL:
+                segment = len(parent) - 1 # element has already been appended
             parent = parent[segment] # type: ignore
             par_path = f"{ par_path }.{ segment }"
         return True

{ansible_vars-1.0.16 → ansible_vars-1.0.18}/test/test_lib.py

@@ -10,6 +10,7 @@ from ruamel.yaml import YAML
 
 from ansible_vars.vault import VaultFile, Vault, EncryptedVar
 from ansible_vars.vault_crypt import VaultKeyring, VaultKey
+from ansible_vars.constants import APPEND_SENTINEL
 
 JSONObject: TypeAlias = Any
 
@@ -218,7 +219,7 @@ class TestVault:
         got: Any = vault.get('a')
         assert isinstance(got, list) and len(got) == 1, 'expected vault data to contain list'
         # Add item to list
-        vault.set(( 'a', 1 ), 2)
+        vault.set(( 'a', APPEND_SENTINEL ), 2)
         got = vault.get('a')
         assert len(got) == 2 and got[1] == 2, 'expected new value in list'