regex_escape: support POSIX basic regex

[jamescassell]

SUMMARY

regex_escape - added re_type option to enable escaping POSIX BRE chars

This distinction is necessary because escaping non-special chars such as
'(' or '{' turns them into special chars, the opposite of what is intended
by using regex_escape on strings being passed as a Basic Regular
Expression.

ISSUE TYPE

• Docs Pull Request
• Feature Pull Request

COMPONENT NAME

regex_escape

ADDITIONAL INFORMATION

[ansibot]

cc @acozine
click here for bot help

[jamescassell]

Not sure why the test failed:

09:56 TASK [setup_mysql_db : install mysqldb_test rpm dependencies] ******************
10:10 changed: [testhost] => (item=['mariadb-server', 'python3-PyMySQL', 'bzip2']) => {"changed": true, "item": ["mariadb-server", "python3-PyMySQL", "bzip2"], "msg": "", "rc": 0, "results": ["Installed: mariadb-server", "Installed: python3-PyMySQL", "Installed: bzip2"]}

then:

 failure: The PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) module is required.

{
"changed": false,
"msg": "The PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) module is required."
}

Seems unrelated to my changes.

[jamescassell]

Let me know if you'd like me to close / reopen to try to get the test to pass

[jamescassell]

bot_status

[ansibot]

Components

changelogs/fragments/regex-escape-basic.yaml
support: community
maintainers:

docs/docsite/rst/user_guide/playbooks_filters.rst
support: core
maintainers: acozine

lib/ansible/plugins/filter/core.py
support: core
maintainers:

Metadata

waiting_on: ansible
changes_requested_by: null
needs_info: False
needs_revision: False
needs_rebase: False
merge_commits: []
too many files or commits: False
mergeable_state: clean
shippable_status: success
maintainer_shipits (module maintainers): 0
community_shipits (namespace maintainers): 0
ansible_shipits (core team members): 0
shipit_actors (maintainer or core team member): []
shipit_actors_other: []
automerge: automerge shipit test failed

click here for bot help

[acozine]

Can you move the version_added note up above the line that begins: To escape special characters within a POSIX basic regex? The way it is now, when I generate the page, it looks like that's the version_added for the Kubernetes filter.

Otherwise the documentation part of this PR looks good. Thanks @jamescassell.

[jamescassell]

@acozine, I'm happy to make that change, but it seems as if other uses of version_added appear at the end of the section describing the functionality. Likely changes are required throughout the page to make it consistent.