0.1.4 (2023-10-24)

------------------
* [new] vyml

Author: vladimirs-git

CHANGELOG.rst

@@ -4,6 +4,11 @@
 CHANGELOG
 =========
 
+0.1.4 (2023-10-24)
+------------------
+* [new] vyml
+
+
 0.1.3 (2023-10-24)
 ------------------
 * [new] vhelpers vdict, vlist, vparam, vre

README.rst

@@ -26,7 +26,7 @@ or install the package from github.com release
 
 .. code:: bash
 
-    pip install https://github.com/vladimirs-git/vhelpers/archive/refs/tags/0.1.3.tar.gz
+    pip install https://github.com/vladimirs-git/vhelpers/archive/refs/tags/0.1.4.tar.gz
 
 or install the package from github.com repository
 
@@ -292,4 +292,60 @@ Return
     assert vre.find4(pattern="a(b)(c)(d)(e)", string="abcde") == ("b", "c", "d", "e")
 
 
+vyml
+====
+Helpers for YAML processing.
+
+
+host_cmds(items)
+----------------
+Create commands in YAML format. Where the hostname is the key and the list of commands is the value.
+
+=========== =========================================== ============================================
+Parameter   Type                                        Description
+=========== =========================================== ============================================
+items       *List[Tuple[str, str, Union[str, List[str]* List of tuples that contain: hostname, parent command, children commands.
+=========== =========================================== ============================================
+
+Return
+      *str* YAML formatted commands.
+
+.. code:: python
+
+    from vhelpers import vyml
+
+    # Create commands in YAML format.
+    items = [("router1", "interface Ethernet1/1", ["description text", "shutdown"])]
+    result = """
+    ---
+    router1: |
+     interface Ethernet1/1
+      description text
+      shutdown
+    """.strip()
+    assert vyml.host_cmds(items) == result
+
+
+cmd_cmds(cmd, cmds)
+-------------------
+Join parent command and children commands using indentation.
+
+=========== ====================== =================================================================
+Parameter   Type                   Description
+=========== ====================== =================================================================
+cmd         *str*                  Parent command.
+cmds        *Union[str, List[str]* Children commands.
+=========== ====================== =================================================================
+
+Return
+      *str* YAML formatted commands with indentation.
+
+.. code:: python
+
+    from vhelpers import vyml
+
+    result = """ interface Ethernet1/1\n  description text\n  shutdown"""
+    assert vyml.cmd_cmds(cmd="interface Ethernet1/1", cmds=["description text", "shutdown"]) == result
+
+
 .. _`./examples`: ./examples

examples/vyml_.py

@@ -0,0 +1,18 @@
+"""Examples vdict.py."""
+
+from vhelpers import vyml
+
+# Create commands in YAML format.
+items = [("router1", "interface Ethernet1/1", ["description text", "shutdown"])]
+result = """
+---
+router1: |
+ interface Ethernet1/1
+  description text
+  shutdown
+""".strip()
+assert vyml.host_cmds(items) == result
+
+# Join parent command and children commands using indentation.
+result = """ interface Ethernet1/1\n  description text\n  shutdown"""
+assert vyml.cmd_cmds(cmd="interface Ethernet1/1", cmds=["description text", "shutdown"]) == result

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vhelpers"
-version = "0.1.3"
+version = "0.1.4"
 description = "Often used functions in vladimirs-git projects"
 authors = ["Vladimir Prusakov <[email protected]>"]
 readme = "README.rst"
@@ -9,8 +9,7 @@ homepage = "https://github.com/vladimirs-git/vhelpers"
 repository = "https://github.com/vladimirs-git/vhelpers"
 keywords = []
 classifiers = [
-    "Development Status :: 1 - Planning",
-#    "Development Status :: 5 - Production/Stable",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3.8",
@@ -42,7 +41,7 @@ test = ["pytest"]
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/vladimirs-git/vhelpers/issues"
-"Download URL" = "https://github.com/vladimirs-git/vhelpers/archive/refs/tags/0.1.3.tar.gz"
+"Download URL" = "https://github.com/vladimirs-git/vhelpers/archive/refs/tags/0.1.4.tar.gz"
 
 
 [build-system]

tests/test__package.py

@@ -9,7 +9,7 @@
 PYPROJECT_D = vdict.pyproject_d(ROOT)
 
 
-def test_version__readme():
+def test__version__readme():
     """Version in README, URL."""
     package = PYPROJECT_D["tool"]["poetry"]["name"].replace("_", "-")
     readme_file = PYPROJECT_D["tool"]["poetry"]["readme"]
@@ -33,7 +33,7 @@ def test_version__readme():
         assert is_regex_found is True, f"absent {version_exp} in {source}"
 
 
-def test_version__changelog():
+def test__version__changelog():
     """Version in CHANGELOG."""
     version_toml = PYPROJECT_D["tool"]["poetry"]["version"]
     path = Path.joinpath(ROOT, "CHANGELOG.rst")
@@ -43,7 +43,7 @@ def test_version__changelog():
     assert version_toml == version_log, f"version in {path=}"
 
 
-def test_last_modified_date():
+def test__last_modified_date():
     """Last modified date in CHANGELOG."""
     path = Path.joinpath(ROOT, "CHANGELOG.rst")
     text = path.read_text(encoding="utf-8")

tests/test_vdict.py

@@ -5,27 +5,24 @@
 
 from vhelpers import vdict
 
-POP = [
-    (1, {1: 2}, 2),
-    (2, {1: 2}, None),
-]
-
 ROOT = Path(__file__).parent.parent
-PYPROJECT_D = [
-    (ROOT, "vhelpers"),
-    (str(ROOT), "vhelpers"),
-]
 
 
-@pytest.mark.parametrize("key, data, expected", POP)
-def test_pop(key, data, expected):
+@pytest.mark.parametrize("key, data, expected", [
+    (1, {1: 2}, 2),
+    (2, {1: 2}, None),
+])
+def test__pop(key, data, expected):
     """pop."""
     actual = vdict.pop(key=key, data=data)
     assert actual == expected
 
 
-@pytest.mark.parametrize("root, expected", PYPROJECT_D)
-def test_pyproject_d(root, expected):
+@pytest.mark.parametrize("root, expected", [
+    (ROOT, "vhelpers"),
+    (str(ROOT), "vhelpers"),
+])
+def test__pyproject_d(root, expected):
     """pyproject_d."""
     data = vdict.pyproject_d(root=root)
     actual = data["tool"]["poetry"]["name"]

tests/test_vlist.py

@@ -31,7 +31,7 @@
 
 
 @pytest.mark.parametrize("items, expected", FROM_ANY)
-def test_from_any(items, expected):
+def test__from_any(items, expected):
     """from_any."""
     actual = vlist.from_any(items=items)
     if isinstance(items, set):
@@ -40,7 +40,7 @@ def test_from_any(items, expected):
 
 
 @pytest.mark.parametrize("items, expected", NO_DUPL)
-def test_no_dupl(items, expected):
+def test__no_dupl(items, expected):
     """no_dupl."""
     actual = vlist.no_dupl(items=items)
     assert actual == expected

tests/test_vparam.py

@@ -21,14 +21,14 @@
 
 
 @pytest.mark.parametrize("params_d, expected", FROM_DICT)
-def test_from_dict(params_d, expected):
+def test__from_dict(params_d, expected):
     """from_dict."""
     actual = vparam.from_dict(params_d=params_d)
     assert actual == expected
 
 
 @pytest.mark.parametrize("params_, expected", TO_DICT)
-def test_to_dict(params_, expected):
+def test__to_dict(params_, expected):
     """to_dict."""
     actual = vparam.to_dict(params=params_)
     assert actual == expected

tests/test_vre.py

@@ -51,56 +51,56 @@
 
 
 @pytest.mark.parametrize("pattern, string, flags, expected", FIND1)
-def test_find1(pattern, string, flags, expected):
+def test__find1(pattern, string, flags, expected):
     """find1."""
     actual = vre.find1(pattern=pattern, string=string, flags=flags)
     assert actual == expected
 
 
 @pytest.mark.parametrize("pattern, string, flags, error", ERRORS)
-def test_find1__invalid(pattern, string, flags, error):
+def test__find1__invalid(pattern, string, flags, error):
     """find1."""
     with pytest.raises(error):
         vre.find1(pattern=pattern, string=string, flags=flags)
 
 
 @pytest.mark.parametrize("pattern, string, flags, expected", FIND2)
-def test_find2(pattern, string, flags, expected):
+def test__find2(pattern, string, flags, expected):
     """find2."""
     actual = vre.find2(pattern=pattern, string=string, flags=flags)
     assert actual == expected
 
 
 @pytest.mark.parametrize("pattern, string, flags, error", ERRORS)
-def test_find2__invalid(pattern, string, flags, error):
+def test__find2__invalid(pattern, string, flags, error):
     """find2."""
     with pytest.raises(error):
         vre.find2(pattern=pattern, string=string, flags=flags)
 
 
 @pytest.mark.parametrize("pattern, string, flags, expected", FIND3)
-def test_find3(pattern, string, flags, expected):
+def test__find3(pattern, string, flags, expected):
     """find3."""
     actual = vre.find3(pattern=pattern, string=string, flags=flags)
     assert actual == expected
 
 
 @pytest.mark.parametrize("pattern, string, flags, error", ERRORS)
-def test_find3__invalid(pattern, string, flags, error):
+def test__find3__invalid(pattern, string, flags, error):
     """find3."""
     with pytest.raises(error):
         vre.find3(pattern=pattern, string=string, flags=flags)
 
 
 @pytest.mark.parametrize("pattern, string, flags, expected", FIND4)
-def test_find4(pattern, string, flags, expected):
+def test__find4(pattern, string, flags, expected):
     """find4."""
     actual = vre.find4(pattern=pattern, string=string, flags=flags)
     assert actual == expected
 
 
 @pytest.mark.parametrize("pattern, string, flags, error", ERRORS)
-def test_find4__invalid(pattern, string, flags, error):
+def test__find4__invalid(pattern, string, flags, error):
     """find4."""
     with pytest.raises(error):
         vre.find4(pattern=pattern, string=string, flags=flags)

tests/test_vyml.py

@@ -0,0 +1,35 @@
+"""Unittests vyml.py."""
+
+import pytest
+
+from vhelpers import vyml
+from vhelpers.types_ import UStr, LT3Strs
+
+
+@pytest.mark.parametrize("items, expected", [
+    ([], "---"),
+    ([("host1", "cmdA", "cmd1\ncmd2")],
+     "---\nhost1: |\n cmdA\n  cmd1\n  cmd2"),
+    ([("host1", "cmdA", ["cmd1", "cmd2"])],
+     "---\nhost1: |\n cmdA\n  cmd1\n  cmd2"),
+    ([("host1", "cmdA", ["cmd1"]), ("host1", "cmdA", ["cmd2"])],
+     "---\nhost1: |\n cmdA\n  cmd1\n cmdA\n  cmd2"),
+    ([("host1", "cmdA", ["cmd1", "cmd2"]), ("host2", "cmdB", ["cmd3", "cmd4"])],
+     "---\nhost1: |\n cmdA\n  cmd1\n  cmd2\nhost2: |\n cmdB\n  cmd3\n  cmd4"),
+])
+def test___host_cmds(items: LT3Strs, expected: str):
+    """host_cmds."""
+    actual = vyml.host_cmds(items=items)
+    assert actual == expected
+
+
+@pytest.mark.parametrize("cmd, cmds, expected", [
+    ("", [], ""),
+    ("", ["cmd1"], "  cmd1"),
+    ("cmdA", ["cmd1"], " cmdA\n  cmd1"),
+    ("cmdA", ["cmd1", "cmd2"], " cmdA\n  cmd1\n  cmd2"),
+])
+def test___cmd_cmds(cmd: str, cmds: UStr, expected: str):
+    """cmd_cmds."""
+    actual = vyml.cmd_cmds(cmd=cmd, cmds=cmds)
+    assert actual == expected