python.envutil Namespace Reference

Functions
def	has_wildcards (filename)
def	find_file_split (filename, dirlist=[os.getcwd()], access=os.R_OK, depth=0)
def	find_file (filename, dirlist=[os.getcwd()], access=os.R_OK, depth=0)
def	find_file_updir (filename, dir=os.getcwd(), access=os.R_OK)
def	find_files_split (filename, dirlist, access, depth)
def	find_files (filename, dirlist, access, depth)
def	find_file_env (filename, env_var_name, access=os.R_OK, sep=defaultPathSeps, depth=0)
def	find_files_env (filename, env_var_name, access=os.R_OK, sep=defaultPathSeps, depth=0)
def	find_libraries (lib)
def	find_python_module_file (modname)
def	find_python_modules (mod)

Variables
	__doc__
	LD_LIBRARY_PATH
	filenameWildCards
	filenameWildCardsCompiled
	defaultPathSeps
	_libraryNameRE
	filelist
	print ("Checking files %s..." % fullfile) More...
	dir
	print ("Trying %s..." % f) More...
	subdirlist
	fulldir
	_pyext

Function Documentation

find_file()

def python.envutil.find_file	(		filename,
			dirlist = [ os.getcwd() ],
			access = os.R_OK,
			depth = 0
	)

Search for file <filename> with access rights <access> (see os.access()) in directory list <dirlist>,
Search into directory tree of each directory up to depth <depth>. The default directory list is
a list containing only the current working directory.
<depth> = 0 : only search in directories given in list.
<depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
<depth> < 0 : ascend upwards into the directory tree up to max -<depth> levels.

Definition at line 85 of file envutil.py.

def find_file( filename,
               dirlist = [ os.getcwd() ],  # noqa: B008 (getcwd always returns the same)
               access = os.R_OK,
               depth = 0 ):
    """Search for file <filename> with access rights <access> (see os.access()) in directory list <dirlist>,
    Search into directory tree of each directory up to depth <depth>. The default directory list is
    a list containing only the current working directory.
    <depth> = 0 : only search in directories given in list.
    <depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
    <depth> < 0 : ascend upwards into the directory tree up to max -<depth> levels."""
    found = find_file_split( filename, dirlist, access, depth )
    return found and os.path.join( found[0], found[1] )
 
 

find_file_env()

def python.envutil.find_file_env	(		filename,
			env_var_name,
			access = os.R_OK,
			sep = defaultPathSeps,
			depth = 0
	)

Search for file <filename> with access rights <access> (see os.access()) in directory list
given as a <sep> separated list of paths in environment variable <env_var_name>.
Search into directory tree of each directory up to depth <depth> (0=don't descend at all).

Definition at line 197 of file envutil.py.

def find_file_env( filename, env_var_name, access = os.R_OK, sep = defaultPathSeps, depth = 0 ):
    """Search for file <filename> with access rights <access> (see os.access()) in directory list
    given as a <sep> separated list of paths in environment variable <env_var_name>.
    Search into directory tree of each directory up to depth <depth> (0=don't descend at all)."""
    env = os.environ.get( env_var_name )
    envList = [ os.getcwd() ]
    if not env:
        return envList
    envList.extend( re.split( sep, env ) )
    return find_file( filename, envList, access, depth )
 
 

find_file_split()

def python.envutil.find_file_split	(		filename,
			dirlist = [ os.getcwd() ],
			access = os.R_OK,
			depth = 0
	)

Search for file <filename> with access rights <access> (see os.access()) in directory list <dirlist>.
Search into directory tree of each directory in <dirlist> up to depth <depth>. The default directory
list is a list containing only the current working directory.
No wildcards are allowed in <filename>.
<depth> = 0 : only search in directories given in list.
<depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
<depth> < 0 : ascend upwards into the directory tree up to max -<depth> levels.
It returns 2-tuple (dir,file) where:
   file=<filename> if no wildcards, or the actual (local) match to <filename> if wildcarded.
   dir=the directory where <file> was found (from <dirlist>, or from a subdir if depth > 0)
If no file is found, it returns None.

Definition at line 30 of file envutil.py.

def find_file_split( filename,
                     dirlist = [ os.getcwd() ],  # noqa: B008 (getcwd always returns the same)
                     access = os.R_OK,
                     depth = 0 ):
    """Search for file <filename> with access rights <access> (see os.access()) in directory list <dirlist>.
    Search into directory tree of each directory in <dirlist> up to depth <depth>. The default directory
    list is a list containing only the current working directory.
    No wildcards are allowed in <filename>.
    <depth> = 0 : only search in directories given in list.
    <depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
    <depth> < 0 : ascend upwards into the directory tree up to max -<depth> levels.
    It returns 2-tuple (dir,file) where:
       file=<filename> if no wildcards, or the actual (local) match to <filename> if wildcarded.
       dir=the directory where <file> was found (from <dirlist>, or from a subdir if depth > 0)
    If no file is found, it returns None."""
    if not dirlist: return None
    for dir in dirlist:
        dir = os.path.abspath( os.path.expandvars( os.path.expanduser(dir) ) )
        if not os.path.isdir(dir): continue
        fullfile = os.path.join( dir, filename )
        #        print ("Checking file %s..." % fullfile)
        if fileutil.access( fullfile, access ):
            return (dir,filename)
 
    if depth == 0:
        # not found at all
        return None
    elif depth > 0:
        # not found at this level. Go one level down in directory structure
        for dir in dirlist:
            dir = os.path.abspath( os.path.expandvars( os.path.expanduser(dir) ) )
            if not os.path.isdir(dir): continue
            subdirlist = []
            for d in fileutil.listdir(dir):
                fulldir = os.path.join(dir,d)
                if os.path.isdir(fulldir):
                    subdirlist.append( fulldir )
            if subdirlist:
                found = find_file_split( filename, subdirlist, access, depth - 1 )
                if found: return found
    elif depth < 0:
        # not found at this level. Go one level up in directory structure
        for dir in dirlist:
            dir = os.path.abspath( os.path.expandvars( os.path.expanduser(dir) ) )
            if not os.path.isdir(dir): continue
            updir = os.path.dirname(dir)
            if updir != dir:
                found = find_file_split( filename, [ updir ], access, depth + 1 )
                if found: return found
                
        
    # not found at all
    return None
 
 

find_file_updir()

def python.envutil.find_file_updir	(		filename,
			dir = os.getcwd(),
			access = os.R_OK
	)

Find a file in directory <dir> or its higher level dirs.

Definition at line 99 of file envutil.py.

def find_file_updir( filename,
                     dir = os.getcwd(),  # noqa: B008 (getcwd always returns the same)
                     access = os.R_OK ):
    """Find a file in directory <dir> or its higher level dirs."""
    curdir = os.path.abspath( dir )
    fullfile = os.path.join( curdir, filename )
    if fileutil.access( fullfile, access ): return fullfile
    #go up in directory tree
    updir = os.path.dirname(curdir)
    while updir != curdir:
        curdir = updir
        fullfile = os.path.join( curdir, filename )
        if fileutil.access( fullfile, access ): return fullfile
        updir = os.path.dirname(curdir)
 
    return None
 
 
 

find_files()

def python.envutil.find_files	(		filename,
			dirlist,
			access,
			depth
	)

Search for all (regular) files that match <filename> with access rights <access> (see os.access()) in directory list <dirlist>.
Search is done into subdirectories each directory up to depth <depth>.
The default value for <dirlist> is the current working directory.
If the same file (without the directory name) is found in more than one places, only the first match is kept.
<filename> : can contain wildcards as used on the unix command line.
<depth> = 0 : only search in directories given in list.
<depth> < 0 : treated as = 0
<depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
It returns a list of filenames with full pathnames. If none is found, an empty list is returned.

Definition at line 184 of file envutil.py.

def find_files( filename, dirlist, access, depth ):
    """Search for all (regular) files that match <filename> with access rights <access> (see os.access()) in directory list <dirlist>.
    Search is done into subdirectories each directory up to depth <depth>.
    The default value for <dirlist> is the current working directory.
    If the same file (without the directory name) is found in more than one places, only the first match is kept.
    <filename> : can contain wildcards as used on the unix command line.
    <depth> = 0 : only search in directories given in list.
    <depth> < 0 : treated as = 0
    <depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
    It returns a list of filenames with full pathnames. If none is found, an empty list is returned."""
    return list (map( lambda arg : os.path.join( arg[0], arg[1] ), find_files_split( filename, dirlist, access, depth ) ))
 
 

find_files_env()

def python.envutil.find_files_env	(		filename,
			env_var_name,
			access = os.R_OK,
			sep = defaultPathSeps,
			depth = 0
	)

Search for all files that match <filename> with access rights <access> (see os.access()) in directory list
given as a <sep> (a regular expression) separated list of paths in environment variable <env_var_name>.
<filename> can contain wildcards as used on the unix command line.
Search into directory tree of each directory up to depth <depth> (0=don't descend at all).

Definition at line 209 of file envutil.py.

def find_files_env( filename, env_var_name, access = os.R_OK, sep = defaultPathSeps, depth = 0 ):
    """Search for all files that match <filename> with access rights <access> (see os.access()) in directory list
    given as a <sep> (a regular expression) separated list of paths in environment variable <env_var_name>.
    <filename> can contain wildcards as used on the unix command line.
    Search into directory tree of each directory up to depth <depth> (0=don't descend at all)."""
    env = os.environ.get( env_var_name )
    envList = [ os.getcwd() ]
    if not env:
        return envList
    envList.extend( re.split( sep, env ) )
    return find_files( filename, envList, access, depth )
 
 

find_files_split()

def python.envutil.find_files_split	(		filename,
			dirlist,
			access,
			depth
	)

Search for all (regular) files that match <filename> with access rights <access> (see os.access())
in directory list <dirlist>.
Search is done into subdirectories each directory up to depth <depth>.
The default value for <dirlist> is the current working directory.
If the same file (without the directory name) is found in more than one places, only the first match is kept.
<filename> : can contain wildcards as used on the unix command line.
<depth> = 0 : only search in directories given in list.
<depth> < 0 : treated as = 0
<depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
It returns a list of 2-tuples (dir,file) where
   file=<filename> if no wildcards, or the actual (local) match to <filename> if wildcarded.
   dir=the directory where <file> was found (from <dirlist>, or from a subdir if depth > 0)
If none is found, an empty list is returned.

Definition at line 118 of file envutil.py.

def find_files_split( filename, dirlist, access, depth ):
    """Search for all (regular) files that match <filename> with access rights <access> (see os.access())
    in directory list <dirlist>.
    Search is done into subdirectories each directory up to depth <depth>.
    The default value for <dirlist> is the current working directory.
    If the same file (without the directory name) is found in more than one places, only the first match is kept.
    <filename> : can contain wildcards as used on the unix command line.
    <depth> = 0 : only search in directories given in list.
    <depth> < 0 : treated as = 0
    <depth> > 0 : descend deeper into the directory tree up to max <depth> levels.
    It returns a list of 2-tuples (dir,file) where
       file=<filename> if no wildcards, or the actual (local) match to <filename> if wildcarded.
       dir=the directory where <file> was found (from <dirlist>, or from a subdir if depth > 0)
    If none is found, an empty list is returned."""
#    if dirlist is None:
#        return []
    if depth < 0: depth = 0
    # to speed up search, do a single file search if the filename does not contain wildcards
    if not has_wildcards(filename):
        singleFile = find_file_split( filename, dirlist, access, depth )
        if singleFile:
            return [ singleFile ]
        else:
            return []
    # filename has wildcards. Find all (first) files that match.
    filenameList = [] # the list of files to return
    dirnameList = [] # keep track of files already found
    for dir in dirlist:
        dir = os.path.abspath( os.path.expandvars( os.path.expanduser(dir) ) )
        # protect against non-existing entries
        if not os.path.isdir(dir): continue
        olddir = os.getcwd()
        os.chdir(dir)

find_libraries()

def python.envutil.find_libraries

(

lib

)

Search for libraries in LD_LIBRARY_PATH. Return list of full paths of libraries if found.
<lib> can contain wildcards, in which case all files matching the wildcard will be returned.
If the same file appears in several paths, the first one found will be taken.

Definition at line 222 of file envutil.py.

def find_libraries( lib ):
    """Search for libraries in LD_LIBRARY_PATH. Return list of full paths of libraries if found.
    <lib> can contain wildcards, in which case all files matching the wildcard will be returned.
    If the same file appears in several paths, the first one found will be taken."""
    # require extension .so (or .so with version numbers)
    global _libraryNameRE
    libsfull = []
    libname = lib
    if _libraryNameRE.search(lib): # fully specified ending
        libsfull = find_files_env( libname, LD_LIBRARY_PATH )
    else:
        libsfull = find_files_env( libname, LD_LIBRARY_PATH )
        # filter results for valid shared library ending (basically to get rid of *.cmtref)
        libsfull = [ l for l in libsfull if _libraryNameRE.search(l) ]
        if not libsfull:
            # add generic ending
            libname = lib + '.so*'
            libsfull = find_files_env( libname, LD_LIBRARY_PATH )
        # filter results for valid shared library ending (basically to get rid of *.cmtref)
        libsfull = [ l for l in libsfull if _libraryNameRE.search(l) ]
        
    # if still not found anything, try with prefix 'lib'
    if not libsfull and not lib.startswith('lib'):
        libsfull = find_libraries( 'lib' + lib )
 
    return libsfull
 
 
# list of possible extensions for python module filenames

find_python_module_file()

def python.envutil.find_python_module_file

(

modname

)

Search for python file (full path) corresponding to python module <mod> in sys.path
(PYTONPATH + some system paths). <mod> should not contain the filename
extension (.py etc), and no wildcards. Returns None is module is not found.

Definition at line 253 of file envutil.py.

def find_python_module_file( modname ):
    """Search for python file (full path) corresponding to python module <mod> in sys.path
    (PYTONPATH + some system paths). <mod> should not contain the filename
    extension (.py etc), and no wildcards. Returns None is module is not found."""
    # add wildcarded extension
    filename = modname.replace('.',os.sep) + '.*'
    # get all python module files
    all = [ f for f in find_files_split( filename, sys.path ) if os.path.splitext(f[1])[1] in _pyext ]
    if not all:
        return None
    else:
        # take the first. When 2 appear in the same directory, choose the one with
        # file extension that appears first in _pyext.
        found = all[0]
        if len(all) > 1:
            foundPrio = _pyext.index( os.path.splitext(found[1])[1] )
            for df in all[1:]:
                d,f = df[0],df[1]
                if d != found[0]: break # done
                prio = _pyext.index( os.path.splitext(f)[1] )
                if prio < foundPrio:
                    found = df
                    foundPrio = prio
        
        return os.path.join(found[0],found[1])
 
 

find_python_modules()

def python.envutil.find_python_modules

(

mod

)

Search for python module(s) in PYTHONPATH + some system paths.
Returns a list of full paths to python module files. If non are found, returns empty list.
<mod> can contain wildcards, in which case all files matching the wildcard will be returned.
If the same file appears in several paths, the first one found will be taken.

Definition at line 280 of file envutil.py.

def find_python_modules( mod ):
    """Search for python module(s) in PYTHONPATH + some system paths.
    Returns a list of full paths to python module files. If non are found, returns empty list.
    <mod> can contain wildcards, in which case all files matching the wildcard will be returned.
    If the same file appears in several paths, the first one found will be taken."""
    b,e = os.path.splitext(mod)
    if e in _pyext: # us filename as-is
        # turn python module syntax into filename syntax
        filename = b.replace('.',os.sep) + e
        return find_files( filename, sys.path )
    elif not has_wildcards( mod ):
        m = find_python_module_file( mod.replace(os.sep, '.') )
        if m:
            return [ m ]
        else:
            return []
    else:
        # first expand the wildcards
        filename = mod.replace('.',os.sep) + '.*'
        modsFound = []
        for df in find_files_split( filename, sys.path ):
            f = df[1]
            b,e = os.path.splitext(f)
            if e not in _pyext: continue
            modname = b.replace(os.sep, '.')
            if modname not in modsFound:
                modsFound.append( modname )
        # now find the files for each module
        found = []
        for m in modsFound:
            f = find_python_module_file( m )
            if f: found.append( f )
        return found

has_wildcards()

def python.envutil.has_wildcards

(

filename

)

Return boolean indicating if the filename contains any unix shell filename wildcards

Definition at line 22 of file envutil.py.

def has_wildcards(filename):
    """Return boolean indicating if the filename contains any unix shell filename wildcards"""
    if filenameWildCardsCompiled.search(filename):
        return True
    else:
        return False
 
 

Variable Documentation

__doc__

python.envutil.__doc__

private

Definition at line 6 of file envutil.py.

_libraryNameRE

python.envutil._libraryNameRE

private

Definition at line 19 of file envutil.py.

_pyext

python.envutil._pyext

private

Definition at line 251 of file envutil.py.

defaultPathSeps

python.envutil.defaultPathSeps

Definition at line 16 of file envutil.py.

dir

python.envutil.dir

print ("Trying %s..." % f)

print ("==> Adding %s to list from %s" % (f,dir)) print ("==> Already have %s in list" % (base))

Definition at line 167 of file envutil.py.

filelist

python.envutil.filelist

print ("Checking files %s..." % fullfile)

Definition at line 152 of file envutil.py.

filenameWildCards

python.envutil.filenameWildCards

Definition at line 12 of file envutil.py.

filenameWildCardsCompiled

python.envutil.filenameWildCardsCompiled

Definition at line 13 of file envutil.py.

fulldir

python.envutil.fulldir

Definition at line 172 of file envutil.py.

LD_LIBRARY_PATH

python.envutil.LD_LIBRARY_PATH

Definition at line 9 of file envutil.py.

subdirlist

python.envutil.subdirlist

Definition at line 170 of file envutil.py.