pyworkflow.utils.which module

Find the full path to commands.

which(command, path=None, verbose=0, exts=None): Return the full path to the first match of the given command on the path.
whichall(command, path=None, verbose=0, exts=None): Return a list of full paths to all matches of the given command on the path.
whichgen(command, path=None, verbose=0, exts=None): Return a generator which will yield full paths to all matches of the given command on the path.

exception pyworkflow.utils.which.WhichError[source]: Bases: Exception

pyworkflow.utils.which.commandExists(command)[source]

pyworkflow.utils.which.which(command, path=None, verbose=0, exts=None)[source]

Return the full path to the first match of the given command on the path.

Parameters

command – is a the name of the executable to search for.
path – is an optional alternate path list to search. The default is to use the PATH environment variable.
verbose – if true, will cause a 2-tuple to be returned. The second element is a textual description of where the match was found.
exts – optionally allows one to specify a list of extensions to use instead of the standard list for this system. This can effectively be used as an optimization to, for example, avoid stat’s of “foo.vbs” when searching for “foo” and you know it is not a VisualBasic script but “.vbs” is on PATHEXT. This option is only supported on Windows.

:return If no match is found for the command, an empty string is returned.

pyworkflow.utils.which.whichall(command, path=None, verbose=0, exts=None)[source]

Return a list of full paths to all matches of the given command on the path.

Parameters

command – is a the name of the executable to search for.
path – is an optional alternate path list to search. The default it to use the PATH environment variable.
verbose – if true, will cause a 2-tuple to be returned for each match. The second element is a textual description of where the match was found.
exts – optionally allows one to specify a list of extensions to use instead of the standard list for this system. This can effectively be used as an optimization to, for example, avoid stat’s of “foo.vbs” when searching for “foo” and you know it is not a VisualBasic script but “.vbs” is on PATHEXT. This option is only supported on Windows.

pyworkflow.utils.which.whichgen(command, path=None, verbose=0, exts=None)[source]

Return a generator of full paths to the given command.

Parameters

command – is a the name of the executable to search for.
path – is an optional alternate path list to search. The default it to use the PATH environment variable.
verbose – if true, will cause a 2-tuple to be returned for each match. The second element is a textual description of where the match was found.
exts – optionally allows one to specify a list of extensions to use instead of the standard list for this system. This can effectively be used as an optimization to, for example, avoid stat’s of “foo.vbs” when searching for “foo” and you know it is not a VisualBasic script but “.vbs” is on PATHEXT. This option is only supported on Windows.

Returns

This method returns a generator which yields either full paths to the given command or, if verbose, tuples of the form (<path to command>, <where path found>).