python.Utils.unixtools Namespace Reference

Functions
	FindFile (filename, pathlist, access)
	helper -------------------------------------------------------------------—
	which (filename, env=os.environ)
	UNIX-style which ---------------------------------------------------------—.
	where (filename, prepath=[])
	"which" for python files -------------------------------------------------—
	find_datafile (fname, pathlist=None, access=os.R_OK)
	pathresolver-like helper function --------------------------------------—
	find_calibfile (fname, pathlist=None, access=os.R_OK)
	pathresolver-like helper function --------------------------------------—

Variables
str	__version__ = '1.0.0'
	data ________________________________________________________________________
str	__author__ = 'Wim Lavrijsen (WLavrijsen@lbl.gov)'
list	__all__

Detailed Description

Unix-like tools and helpers.

Function Documentation

find_calibfile()

python.Utils.unixtools.find_calibfile	(		fname,
			pathlist = None,
			access = os.R_OK )

pathresolver-like helper function --------------------------------------—

the python equivalent to the C++ PathResolver for calibfiles.

Definition at line 80 of file unixtools.py.

def find_calibfile(fname, pathlist=None, access=os.R_OK):
   """the python equivalent to the C++ PathResolver for calibfiles.
   """
   if pathlist is None:
      pathlist = os.getenv('CALIBPATH').split(os.pathsep)
   
   return find_datafile(fname, pathlist, access)

find_datafile()

python.Utils.unixtools.find_datafile	(		fname,
			pathlist = None,
			access = os.R_OK )

pathresolver-like helper function --------------------------------------—

the python equivalent to the C++ PathResolver for datafiles.

Definition at line 67 of file unixtools.py.

def find_datafile(fname, pathlist=None, access=os.R_OK):
   """the python equivalent to the C++ PathResolver for datafiles.
   """
   if pathlist is None:
      pathlist = os.getenv('DATAPATH').split(os.pathsep)
 
   if not isinstance(pathlist, list):
      raise TypeError("pathlist must be a list or an iterable (got %s)" %
                      type(pathlist))
 
   return FindFile(fname, pathlist, access)
 

FindFile()

python.Utils.unixtools.FindFile	(		filename,
			pathlist,
			access )

helper -------------------------------------------------------------------—

Find <filename> with rights <access> through <pathlist>.

Definition at line 20 of file unixtools.py.

def FindFile( filename, pathlist, access ):
   """Find <filename> with rights <access> through <pathlist>."""
 
 # special case for those filenames that already contain a path
   if os.path.dirname( filename ):
      if os.access( filename, access ):
         return filename
 
 # test the file name in all possible paths until first found
   for path in pathlist:
      f = os.path.join( path, filename )
      if os.access( f, access ):
         return f
 
 # no such accessible file avalailable
   return None
 
 

where()

python.Utils.unixtools.where	(		filename,
			prepath = [] )

"which" for python files -------------------------------------------------—

Search for <filename> in the python path and the given <prepath>.

Definition at line 53 of file unixtools.py.

def where( filename, prepath = [] ):
   """Search for <filename> in the python path and the given <prepath>."""
 
 # look in the given path and in the python path
   pathlist = prepath + sys.path
 
   for ext in [ '', '.py', '.pyc', '.so' ]:
      result = FindFile( filename + ext, pathlist, os.R_OK )
      if result:
         break
 
   return result
 

which()

python.Utils.unixtools.which	(		filename,
			env = os.environ )

UNIX-style which ---------------------------------------------------------—.

Search for <filename> through the PATH in environment <env>. Only executable
files will be returned.

Definition at line 39 of file unixtools.py.

def which( filename, env = os.environ ):
   """Search for <filename> through the PATH in environment <env>. Only executable
files will be returned."""
 
 # retrieve the value of the PATH environment variable
   try:
      p = env[ 'PATH' ]
   except KeyError:
      p = os.defpath
 
   return FindFile( filename, p.split( os.pathsep ), os.X_OK )
 
 

Variable Documentation

__all__

list python.Utils.unixtools.__all__

private

Initial value:

=  [ 'FindFile', 'which', 'where',
            'find_datafile',]

Definition at line 15 of file unixtools.py.

__author__

str python.Utils.unixtools.__author__ = 'Wim Lavrijsen (WLavrijsen@lbl.gov)'

private

Definition at line 13 of file unixtools.py.

__version__

str python.Utils.unixtools.__version__ = '1.0.0'

private

data ________________________________________________________________________

Definition at line 12 of file unixtools.py.