python.rfio Namespace Reference

Classes
class	RFIOError
class	StatResult

Functions
	_remove_prefix (filename, prefix)
	rfstat (filename)
	rfdir (dirname)
	rfstat_dict (filename)
	rfstat_item (filename, item)
	listdir (dirname)
	exists (filename)
	getsize (filename)
	getmtime (filename)
	_stat_time (time_string)
	lstat (filename)
	access (filename, mode)

Variables
str	__doc__ = """Module with utilities for rfio files"""
	stat = lstat

Function Documentation

_remove_prefix()

python.rfio._remove_prefix ( filename, prefix )

protected

Definition at line 14 of file rfio.py.

def _remove_prefix(filename,prefix):
    if filename.startswith(prefix): filename = filename[len(prefix):]
    return filename
 
 

_stat_time()

python.rfio._stat_time ( time_string )

protected

Definition at line 141 of file rfio.py.

def _stat_time(time_string):
    t = time.mktime(time.strptime(time_string))
    if os.stat_float_times():
        return float(t)
    else:
        return int(t)
    
 
 

access()

python.rfio.access	(		filename,
			mode )

Definition at line 186 of file rfio.py.

def access(filename,mode):
    if mode == os.F_OK: return exists(filename)
 
    st = stat(filename)
    filemode = st.st_mode
    uid = st.st_uid
    gid = st.st_gid
    if mode & os.R_OK:
        rOK = ( filemode & statconsts.S_IROTH ) or \
              ( filemode & statconsts.S_IRGRP and os.getgid()  == gid ) or \
              ( filemode & statconsts.S_IRUSR and os.getuid()  == uid ) or \
              ( filemode & statconsts.S_ISGID and os.getegid() == gid ) or \
              ( filemode & statconsts.S_ISUID and os.geteuid() == uid )
    else:
        rOK = True
 
    if mode & os.W_OK:
        wOK = ( filemode & statconsts.S_IWOTH ) or \
              ( filemode & statconsts.S_IWGRP and os.getgid()  == gid ) or \
              ( filemode & statconsts.S_IWUSR and os.getuid()  == uid ) or \
              ( filemode & statconsts.S_ISGID and os.getegid() == gid ) or \
              ( filemode & statconsts.S_ISUID and os.geteuid() == uid )
    else:
        wOK = True
 
    if mode & os.X_OK:
        xOK = ( filemode & statconsts.S_IXOTH ) or \
              ( filemode & statconsts.S_IXGRP and os.getgid()  == gid ) or \
              ( filemode & statconsts.S_IXUSR and os.getuid()  == uid ) or \
              ( filemode & statconsts.S_ISGID and os.getegid() == gid ) or \
              ( filemode & statconsts.S_ISUID and os.geteuid() == uid )
    else:
        xOK = True
 
    return rOK and wOK and xOK
 
    

exists()

python.rfio.exists

(

filename

)

Definition at line 90 of file rfio.py.

def exists(filename):
    status,output = rfstat(filename)
    return status == 0
 
 

getmtime()

python.rfio.getmtime

(

filename

)

Definition at line 100 of file rfio.py.

def getmtime(filename):
    return lstat(filename).st_mtime
 
 

getsize()

python.rfio.getsize

(

filename

)

Return size of file <filename> in bytes

Definition at line 95 of file rfio.py.

def getsize(filename):
    """Return size of file <filename> in bytes"""
    return int(rfstat_item(filename,'Size'))
 
 

listdir()

python.rfio.listdir

(

dirname

)

Return the contents of directory <dirname> in a python list a-la os.listdir(),
i.e. only the filenames, and not including the current dir (.) and parent dir (..)

Definition at line 76 of file rfio.py.

def listdir(dirname):
    """Return the contents of directory <dirname> in a python list a-la os.listdir(),
    i.e. only the filenames, and not including the current dir (.) and parent dir (..)""" 
    status,ls_la = rfdir(dirname)
    if status: raise RFIOError('Directory %s not found' % dirname)
    dir = [ ]
    for d in ls_la:
        dd = d.split()[-1]
        if dd != os.curdir and dd != os.pardir:
            dir.append( dd )
 
    return dir
  
 

lstat()

python.rfio.lstat

(

filename

)

Definition at line 150 of file rfio.py.

def lstat(filename):
    st = StatResult()
    output = rfstat_dict(filename)
    if output is None: raise RFIOError('file %s not found' % filename)
    for name in output:
        value = output[name]
        if name == 'Device':
            st.st_dev = eval('0x' + value)
        elif name.startswith('Inode'):
            st.st_ino = int(value)
        elif name.find('blocks') != -1:
            st.st_blocks = int(value)
        elif name == 'Protection':
            octal = value.split()[-1][1:-1]
            st.st_mode = eval('0' + octal)
        elif name == 'Hard Links':
            st.st_nlink = int(value)
        elif name == 'Uid':
            st.st_uid = int(value.split()[0])
        elif name == 'Gid':
            st.st_gid = int(value.split()[0])
        elif name.startswith('Size'):
            st.st_size = int(value)
        elif name == 'Last access':
            st.st_atime = _stat_time(value)
        elif name == 'Last modify':
            st.st_mtime = _stat_time(value)
        elif name == 'Last stat. mod.':
            st.st_ctime = _stat_time(value)
 
    return st
 
# never follow symbolic links, so stat == lstat

rfdir()

python.rfio.rfdir

(

dirname

)

Return tuple (status,output) of rfdir shell command. Output in a list of strings (one entry per line).
The format is the same as the unix shell command \'ls -la\'
Raises RFIOError if rfdir command is not found

Definition at line 33 of file rfio.py.

def rfdir(dirname):
    """Return tuple (status,output) of rfdir shell command. Output in a list of strings (one entry per line).
    The format is the same as the unix shell command \'ls -la\'
    Raises RFIOError if rfdir command is not found"""
    dircmd = 'rfdir'
    from PyJobTransformsCore import envutil
    if not envutil.find_executable(dircmd):
        raise RFIOError( '%s not found in PATH' % dircmd )
    cmd = '%s %s' % (dircmd,_remove_prefix(dirname,'rfio:'))
    status,ls_la = subprocess.getstatusoutput( cmd )
    status >>= 8
    
    return (status, ls_la.split(os.linesep))
 
 

rfstat()

python.rfio.rfstat

(

filename

)

Return tuple (status,output) of rfstat shell command. Output is a list of strings
(one entry per line). Raises RFIOError if rfstat command is not found.

Definition at line 19 of file rfio.py.

def rfstat(filename):
    """Return tuple (status,output) of rfstat shell command. Output is a list of strings
    (one entry per line). Raises RFIOError if rfstat command is not found."""
    statcmd = 'rfstat'
    from PyJobTransformsCore import envutil
    if not envutil.find_executable(statcmd):
        raise RFIOError( '%s not found in PATH' % statcmd )
    cmd = '%s %s' % (statcmd,_remove_prefix(filename,'rfio:'))
    status,output = subprocess.getstatusoutput( cmd )
    status >>= 8
 
    return (status, output.split(os.linesep))
 
 

rfstat_dict()

python.rfio.rfstat_dict

(

filename

)

Return dictionary with name:value pairs of the rfstat output. Returns None
if rfstat returns an error code (i.e. file does not exist).

Definition at line 48 of file rfio.py.

def rfstat_dict(filename):
    """Return dictionary with name:value pairs of the rfstat output. Returns None
    if rfstat returns an error code (i.e. file does not exist)."""
    status,output = rfstat(filename)
    if status: return None
    rfdict = { }
    for line in output:
        colon = line.index(':')
        name = line[:colon].strip()
        value = line[colon+1:].strip()
        rfdict[name] = value
 
    return rfdict
    
    

rfstat_item()

python.rfio.rfstat_item	(		filename,
			item )

Return the contents of <item> in the rfstat output

Definition at line 63 of file rfio.py.

def rfstat_item(filename,item):
    """Return the contents of <item> in the rfstat output"""
    status,output = rfstat(filename)
    if status: return None
    for line in output:
        if line.startswith( item ):
            colon = line.index(':')
            return line[colon+1:].strip()
 
    # nothing found
    return None
 
 

Variable Documentation

__doc__

str python.rfio.__doc__ = """Module with utilities for rfio files"""

private

Definition at line 8 of file rfio.py.

stat

python.rfio.stat = lstat

Definition at line 183 of file rfio.py.