You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst

11 lines
513 B
ReStructuredText

use-argspec-type-path
=====================
The AnsibleModule argument_spec knows of several types beyond the standard python types. One of
these is ``path``. When used, type ``path`` ensures that an argument is a string and expands any
shell variables and tilde characters.
This test looks for use of :func:`os.path.expanduser <python:os.path.expanduser>` in modules. When found, it tells the user to
replace it with ``type='path'`` in the module's argument_spec or list it as a false positive in the
test.