Merge pull request #15 from manala/path/path-parse-components

[Path] Add a "parse" filter to get path components

Author: nervo

path/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add a "parse" filter to get path components
+
 ## [2.2.0] - 2026-01-02
 
 ### Added

path/plugins/filter/parse.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from ansible.errors import AnsibleTemplateError
+from pathlib import Path
+
+
+def _parse(path):
+    if not isinstance(path, dict):
+        raise AnsibleTemplateError(f'parse input expects a dict but was given a {type(path).__name__}')
+
+    p = Path(path['path'])
+
+    # Parent
+    parent = str(p.parent)
+    if parent in ['.', '/']:
+        parent = ''
+
+    # Extension
+    extension = p.suffix.lstrip('.')
+
+    return {
+        'parent': parent,
+        'name': p.name,
+        'stem': p.stem,
+        'extension': extension,
+    }
+
+
+class FilterModule(object):
+    """ Manala path parse jinja2 filters """
+
+    def filters(self):
+        return {
+            'parse': _parse,
+        }

path/plugins/filter/parse.yaml

@@ -0,0 +1,26 @@
+---
+
+DOCUMENTATION:
+  name: parse
+  author:
+    - Manala (@manala)
+  short_description: Get the components of a path dict
+  description:
+    - Returns the components of a path dict.
+  positional: _input
+  options:
+    _input:
+      description: A path dict.
+      type: dict
+      required: true
+
+RETURN:
+  _value:
+    description: Components.
+    type: dict
+
+EXAMPLES: |
+  - ansible.builtin.debug:
+      msg:
+        - >
+          {'path': 'foo'} | manala.path.parse

path/tests/unit/plugins/filter/test_parse.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+import unittest
+from plugins.filter.parse import _parse as _filter_parse
+
+from ansible.errors import AnsibleTemplateError
+
+
+class TestParse(unittest.TestCase):
+
+    def test_invalid_inputs(self):
+        path = NotImplemented
+
+        with self.assertRaisesRegex(AnsibleTemplateError, f'parse input expects a dict but was given a {type(path).__name__}'):
+            _filter_parse(path)
+
+    def test(self):
+        self.assertEqual({
+            'parent': '',
+            'name': '',
+            'stem': '',
+            'extension': '',
+        } , _filter_parse(
+            {'path': ''}
+        ))
+
+        self.assertEqual({
+            'parent': '',
+            'name': 'foo',
+            'stem': 'foo',
+            'extension': '',
+        } , _filter_parse(
+            {'path': 'foo'}
+        ))
+
+        self.assertEqual({
+            'parent': '',
+            'name': 'foo.bar',
+            'stem': 'foo',
+            'extension': 'bar',
+        } , _filter_parse(
+            {'path': 'foo.bar'}
+        ))
+
+        self.assertEqual({
+            'parent': '',
+            'name': 'foo',
+            'stem': 'foo',
+            'extension': '',
+        } , _filter_parse(
+            {'path': '/foo'}
+        ))
+
+        self.assertEqual({
+            'parent': '',
+            'name': 'foo.bar',
+            'stem': 'foo',
+            'extension': 'bar',
+        } , _filter_parse(
+            {'path': '/foo.bar'}
+        ))
+
+        self.assertEqual({
+            'parent': '/foo/bar',
+            'name': 'baz',
+            'stem': 'baz',
+            'extension': '',
+        } , _filter_parse(
+            {'path': '/foo/bar/baz'}
+        ))
+
+        self.assertEqual({
+            'parent': '/foo/bar',
+            'name': 'baz.qux',
+            'stem': 'baz',
+            'extension': 'qux',
+        } , _filter_parse(
+            {'path': '/foo/bar/baz.qux'}
+        ))