@ -6,19 +6,27 @@ from __future__ import annotations
import os
import os
from ansible . module_utils . common . file import is_executable
from ansible . module_utils . common . file import is_executable
from ansible . module_utils . common . warnings import deprecate
def get_bin_path ( arg , opt_dirs = None , required = None ) :
def get_bin_path ( arg , opt_dirs = None , required = None ) :
'''
'''
Find system executable in PATH . Raises ValueError if executable is not found .
Find system executable in PATH . Raises ValueError if the executable is not found .
Optional arguments :
Optional arguments :
- required : [ Deprecated ] Prior to 2.10 , if executable is not found and required is true it raises an Exception .
- required : [ Deprecated ] Before 2.10 , if executable is not found and required is true it raises an Exception .
In 2.10 and later , an Exception is always raised . This parameter will be removed in 2. 14 .
In 2.10 and later , an Exception is always raised . This parameter will be removed in 2. 2 1.
- opt_dirs : optional list of directories to search in addition to PATH
- opt_dirs : optional list of directories to search in addition to PATH
In addition to PATH and opt_dirs , this function also looks through / sbin , / usr / sbin and / usr / local / sbin . A lot of
In addition to PATH and opt_dirs , this function also looks through / sbin , / usr / sbin and / usr / local / sbin . A lot of
modules , especially for gathering facts , depend on this behaviour .
modules , especially for gathering facts , depend on this behaviour .
If found return full path , otherwise raise ValueError .
If found return full path , otherwise raise ValueError .
'''
'''
if required is not None :
deprecate (
msg = " The `required` parameter in `get_bin_path` API is deprecated. " ,
version = " 2.21 " ,
collection_name = " ansible.builtin " ,
)
opt_dirs = [ ] if opt_dirs is None else opt_dirs
opt_dirs = [ ] if opt_dirs is None else opt_dirs
sbin_paths = [ ' /sbin ' , ' /usr/sbin ' , ' /usr/local/sbin ' ]
sbin_paths = [ ' /sbin ' , ' /usr/sbin ' , ' /usr/local/sbin ' ]