a-c-m
/
ansible.utils
mirror of https://github.com/ansible-collections/ansible.utils.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Simple doc updates (#8) 

Co-authored-by: cidrblock <brad@thethorntons.net>
pull/11/head
Bradley A. Thornton 2020-10-15 06:58:59 -07:00 committed by GitHub
parent 197b9d93b9
commit 12333c2386
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -21,9 +21,9 @@ PEP440 is the schema used to describe the versions of Ansible.
### Filter plugins
Name | Description
--- | ---
ansible.utils.get_path|Get value using path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)
ansible.utils.index_of|Find items in a list. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.netcommon.index_of_lookup.rst)
ansible.utils.to_paths|Convert objects to paths. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)
ansible.utils.get_path|Retrieve the value in a variable using a path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)
ansible.utils.index_of|Find the indicies of items in a list matching some criteria. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.index_of_lookup.rst)
ansible.utils.to_paths|Flatten a complex object into a dictionary of paths and values. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)
### Lookup plugins
Name | Description

2
plugins/filter/index_of.py
View File

@ -19,7 +19,7 @@ from jinja2.filters import environmentfilter
@environmentfilter
def _index_of(*args, **kwargs):
"""Find items in a list. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.netcommon.index_of_lookup.rst)"""
"""Find the indicies of items in a list matching some criteria. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.index_of_lookup.rst)"""
kwargs["tests"] = args[0].tests
args = args[1:]
return index_of(*args, **kwargs)

4
plugins/filter/paths.py
View File

@ -25,13 +25,13 @@ from jinja2.filters import environmentfilter
def _to_paths(*args, **kwargs):
"""Convert objects to paths. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)"""
"""Flatten a complex object into a dictionary of paths and values. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)"""
return to_paths(*args, **kwargs)
@environmentfilter
def _get_path(*args, **kwargs):
"""Get value using path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)"""
"""Retrieve the value in a variable using a path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)"""
kwargs["environment"] = args[0]
args = args[1:]
return get_path(*args, **kwargs)

4
tests/sanity/ignore-2.10.txt
View File

@ -1,2 +1,4 @@
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url

4
tests/sanity/ignore-2.11.txt
View File

@ -1,2 +1,4 @@
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url

4
tests/sanity/ignore-2.9.txt
View File

@ -1,2 +1,4 @@
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url
plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node
plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url