basis.which Namespace Reference

Classes
class	WhichError

Functions
def	main (argv)
def	which (command, path=None, verbose=0, exts=None)
def	whichall (command, path=None, verbose=0, exts=None)
def	whichgen (command, path=None, verbose=0, exts=None)

Function Documentation

main()

def basis.which.main

(

argv

)

Definition at line 305 of file which.py.

which()

def basis.which.which	(		command,
			path = None,
			verbose = 0,
			exts = None
	)

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

"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. 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.

If no match is found for the command, a WhichError is raised.

Definition at line 257 of file which.py.

whichall()

def basis.which.whichall	(		command,
			path = None,
			verbose = 0,
			exts = None
	)

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

"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.

Definition at line 282 of file which.py.

whichgen()

def basis.which.whichgen	(		command,
			path = None,
			verbose = 0,
			exts = None
	)

Return a generator of full paths to the given command.

"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.

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>).

Definition at line 164 of file which.py.