os
index
/usr/lib/python2.2/os.py

OS routines for Mac, DOS, NT, or Posix depending on what system we're on.
 
This exports:
  - all functions from posix, nt, dos, os2, mac, or ce, e.g. unlink, stat, etc.
  - os.path is one of the modules posixpath, ntpath, macpath, or dospath
  - os.name is 'posix', 'nt', 'dos', 'os2', 'mac', 'ce' or 'riscos'
  - os.curdir is a string representing the current directory ('.' or ':')
  - os.pardir is a string representing the parent directory ('..' or '::')
  - os.sep is the (or a most common) pathname separator ('/' or ':' or '\\')
  - os.extsep is the extension separator ('.' or '/')
  - os.altsep is the alternate pathname separator (None or '/')
  - os.pathsep is the component separator used in $PATH etc
  - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n')
  - os.defpath is the default search path for executables
 
Programs that import and use 'os' stand a better chance of being
portable between different platforms.  Of course, they must then
only use functions that are defined by all platforms (e.g., unlink
and opendir), and leave all pathname manipulation to os.path
(e.g., split and join).

 
Modules
            
UserDict
posixpath
sys
 
Classes
            
UserDict.UserDict
_Environ
 
class _Environ(UserDict.UserDict)
      # But we store them as upper case
 
   Methods defined here:
__delitem__(self, key)
__init__(self, environ)
__setitem__(self, key, item)
update(self, dict)

Data and non-method functions defined here:
__doc__ = None
__module__ = 'os'

Methods inherited from UserDict.UserDict:
__cmp__(self, dict)
__contains__(self, key)
__getitem__(self, key)
__len__(self)
__repr__(self)
clear(self)
copy(self)
get(self, key, failobj=None)
has_key(self, key)
items(self)
iteritems(self)
iterkeys(self)
itervalues(self)
keys(self)
popitem(self)
setdefault(self, key, failobj=None)
values(self)
 
Functions
            
WEXITSTATUS(...)
WEXITSTATUS(status) -> integer
Return the process return code from 'status'.
WIFEXITED(...)
WIFEXITED(status) -> Boolean
Return true if the process returning 'status' exited using the exit()
system call.
WIFSIGNALED(...)
WIFSIGNALED(status) -> Boolean
Return true if the process returning 'status' was terminated by a signal.
WIFSTOPPED(...)
WIFSTOPPED(status) -> Boolean
Return true if the process returning 'status' was stopped.
WSTOPSIG(...)
WSTOPSIG(status) -> integer
Return the signal that stopped the process that provided the 'status' value.
WTERMSIG(...)
WTERMSIG(status) -> integer
Return the signal that terminated the process that provided the 'status'
value.
_execvpe(file, args, env=None)
_exists(name)
_exit(...)
_exit(status)
Exit to the system with specified status, without normal exit processing.
_get_exports_list(module)
_spawnvef(mode, file, args, env, func)
abort(...)
abort() -> does not return!
Abort the interpreter immediately.  This 'dumps core' or otherwise fails
in the hardest way possible on the hosting operating system.
access(...)
access(path, mode) -> 1 if granted, 0 otherwise
Test for access to a file.
chdir(...)
chdir(path) -> None
Change the current working directory to the specified path.
chmod(...)
chmod(path, mode) -> None
Change the access permissions of a file.
chown(...)
chown(path, uid, gid) -> None
Change the owner and group id of path to the numeric uid and gid.
chroot(...)
chroot(path) -> None
Change root directory to path.
close(...)
close(fd) -> None
Close a file descriptor (for low level IO).
confstr(...)
confstr(name) -> string
Return a string-valued system configuration variable.
ctermid(...)
ctermid() -> String
Return the name of the controlling terminal for this process.
dup(...)
dup(fd) -> fd2
Return a duplicate of a file descriptor.
dup2(...)
dup2(fd, fd2) -> None
Duplicate file descriptor.
execl(file, *args)
execl(file, *args)
 
Execute the executable file with argument list args, replacing the
current process.
execle(file, *args)
execle(file, *args, env)
 
Execute the executable file with argument list args and
environment env, replacing the current process.
execlp(file, *args)
execlp(file, *args)
 
Execute the executable file (which is searched for along $PATH)
with argument list args, replacing the current process.
execlpe(file, *args)
execlpe(file, *args, env)
 
Execute the executable file (which is searched for along $PATH)
with argument list args and environment env, replacing the current
process.
execv(...)
execv(path, args)
Execute an executable path with arguments, replacing current process.
 
        path: path of executable file
        args: tuple or list of strings
execve(...)
execve(path, args, env)
Execute a path with arguments and environment, replacing current process.
 
        path: path of executable file
        args: tuple or list of arguments
        env: dictionary of strings mapping to strings
execvp(file, args)
execp(file, args)
 
Execute the executable file (which is searched for along $PATH)
with argument list args, replacing the current process.
args may be a list or tuple of strings.
execvpe(file, args, env)
execv(file, args, env)
 
Execute the executable file (which is searched for along $PATH)
with argument list args and environment env , replacing the
current process.
args may be a list or tuple of strings.
fdatasync(...)
fdatasync(fildes) -> None
force write of file with filedescriptor to disk.
 does not force update of metadata.
fdopen(...)
fdopen(fd, [, mode='r' [, bufsize]]) -> file_object
Return an open file object connected to a file descriptor.
fork(...)
fork() -> pid
Fork a child process.
 
Return 0 to child process and PID of child to parent process.
forkpty(...)
forkpty() -> (pid, master_fd)
Fork a new process with a new pseudo-terminal as controlling tty.
 
Like fork(), return 0 as pid to child process, and PID of child to parent.
To both, return fd of newly opened pseudo-terminal.
fpathconf(...)
fpathconf(fd, name) -> integer
Return the configuration limit name for the file descriptor fd.
If there is no limit, return -1.
fstat(...)
fstat(fd) -> (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)
Like stat(), but for an open file descriptor.
fstatvfs(...)
fstatvfs(fd) -> 
 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax)
Perform an fstatvfs system call on the given fd.
fsync(...)
fsync(fildes) -> None
force write of file with filedescriptor to disk.
ftruncate(...)
ftruncate(fd, length) -> None
Truncate a file to a specified length.
getcwd(...)
getcwd() -> path
Return a string representing the current working directory.
getegid(...)
getegid() -> egid
Return the current process's effective group id.
getenv(key, default=None)
Get an environment variable, return None if it doesn't exist.
The optional second argument can specify an alternate default.
geteuid(...)
geteuid() -> euid
Return the current process's effective user id.
getgid(...)
getgid() -> gid
Return the current process's group id.
getgroups(...)
getgroups() -> list of group IDs
Return list of supplemental group IDs for the process.
getlogin(...)
getlogin() -> string
Return the actual login name.
getpgrp(...)
getpgrp() -> pgrp
Return the current process group id.
getpid(...)
getpid() -> pid
Return the current process id
getppid(...)
getppid() -> ppid
Return the parent's process id.
getuid(...)
getuid() -> uid
Return the current process's user id.
isatty(...)
isatty(fd) -> Boolean
Return true if the file descriptor 'fd' is an open file descriptor
connected to the slave end of a terminal.
kill(...)
kill(pid, sig) -> None
Kill a process with a signal.
link(...)
link(src, dst) -> None
Create a hard link to a file.
listdir(...)
listdir(path) -> list_of_strings
Return a list containing the names of the entries in the directory.
 
        path: path of directory to list
 
The list is in arbitrary order.  It does not include the special
entries '.' and '..' even if they are present in the directory.
lseek(...)
lseek(fd, pos, how) -> newpos
Set the current position of a file descriptor.
lstat(...)
lstat(path) -> (mode,ino,dev,nlink,uid,gid,size,atime,mtime,ctime)
Like stat(path), but do not follow symbolic links.
makedirs(name, mode=511)
makedirs(path [, mode=0777]) -> None
 
Super-mkdir; create a leaf directory and all intermediate ones.
Works like mkdir, except that any intermediate path segment (not
just the rightmost) will be created if it does not exist.  This is
recursive.
mkdir(...)
mkdir(path [, mode=0777]) -> None
Create a directory.
mkfifo(...)
mkfifo(file, [, mode=0666]) -> None
Create a FIFO (a POSIX named pipe).
nice(...)
nice(inc) -> new_priority
Decrease the priority of process and return new priority.
open(...)
open(filename, flag [, mode=0777]) -> fd
Open a file (for low level IO).
openpty(...)
openpty() -> (master_fd, slave_fd)
Open a pseudo-terminal, returning open fd's for both master and slave end.
pathconf(...)
pathconf(path, name) -> integer
Return the configuration limit name for the file or directory path.
If there is no limit, return -1.
pipe(...)
pipe() -> (read_end, write_end)
Create a pipe.
popen(...)
popen(command [, mode='r' [, bufsize]]) -> pipe
Open a pipe to/from a command returning a file object.
popen2(cmd, mode='t', bufsize=-1)
popen3(cmd, mode='t', bufsize=-1)
popen4(cmd, mode='t', bufsize=-1)
putenv(...)
putenv(key, value) -> None
Change or add an environment variable.
read(...)
read(fd, buffersize) -> string
Read a file descriptor.
readlink(...)
readlink(path) -> path
Return a string representing the path to which the symbolic link points.
remove(...)
remove(path) -> None
Remove a file (same as unlink(path)).
removedirs(name)
removedirs(path) -> None
 
Super-rmdir; remove a leaf directory and empty all intermediate
ones.  Works like rmdir except that, if the leaf directory is
successfully removed, directories corresponding to rightmost path
segments will be pruned way until either the whole path is
consumed or an error occurs.  Errors during this latter phase are
ignored -- they generally mean that a directory was not empty.
rename(...)
rename(old, new) -> None
Rename a file or directory.
renames(old, new)
renames(old, new) -> None
 
Super-rename; create directories as necessary and delete any left
empty.  Works like rename, except creation of any intermediate
directories needed to make the new pathname good is attempted
first.  After the rename, directories corresponding to rightmost
path segments of the old name will be pruned way until either the
whole path is consumed or a nonempty directory is found.
 
Note: this function can fail with the new directory structure made
if you lack permissions needed to unlink the leaf directory or
file.
rmdir(...)
rmdir(path) -> None
Remove a directory.
setegid(...)
setegid(gid) -> None
Set the current process's effective group id.
seteuid(...)
seteuid(uid) -> None
Set the current process's effective user id.
setgid(...)
setgid(gid) -> None
Set the current process's group id.
setgroups(...)
setgroups(list) -> None
Set the groups of the current process to list.
setpgid(...)
setpgid(pid, pgrp) -> None
Call the system call setpgid().
setpgrp(...)
setpgrp() -> None
Make this process a session leader.
setregid(...)
setegid(rgid, egid) -> None
Set the current process's real and effective group ids.
setreuid(...)
seteuid(ruid, euid) -> None
Set the current process's real and effective user ids.
setsid(...)
setsid() -> None
Call the system call setsid().
setuid(...)
setuid(uid) -> None
Set the current process's user id.
spawnl(mode, file, *args)
spawnl(mode, file, *args) -> integer
 
Execute file with arguments from args in a subprocess.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnle(mode, file, *args)
spawnle(mode, file, *args, env) -> integer
 
Execute file with arguments from args in a subprocess with the
supplied environment.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnlp(mode, file, *args)
spawnlp(mode, file, *args, env) -> integer
 
Execute file (which is looked for along $PATH) with arguments from
args in a subprocess with the supplied environment.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnlpe(mode, file, *args)
spawnlpe(mode, file, *args, env) -> integer
 
Execute file (which is looked for along $PATH) with arguments from
args in a subprocess with the supplied environment.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnv(mode, file, args)
spawnv(mode, file, args) -> integer
 
Execute file with arguments from args in a subprocess.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnve(mode, file, args, env)
spawnve(mode, file, args, env) -> integer
 
Execute file with arguments from args in a subprocess with the
specified environment.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnvp(mode, file, args)
spawnvp(mode, file, args) -> integer
 
Execute file (which is looked for along $PATH) with arguments from
args in a subprocess.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
spawnvpe(mode, file, args, env)
spawnvpe(mode, file, args, env) -> integer
 
Execute file (which is looked for along $PATH) with arguments from
args in a subprocess with the supplied environment.
If mode == P_NOWAIT return the pid of the process.
If mode == P_WAIT return the process's exit code if it exits normally;
otherwise return -SIG, where SIG is the signal that killed it.
stat(...)
stat(path) -> (mode,ino,dev,nlink,uid,gid,size,atime,mtime,ctime)
Perform a stat system call on the given path.
statvfs(...)
statvfs(path) -> 
 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax)
Perform a statvfs system call on the given path.
strerror(...)
strerror(code) -> string
Translate an error code to a message string.
symlink(...)
symlink(src, dst) -> None
Create a symbolic link.
sysconf(...)
sysconf(name) -> integer
Return an integer-valued system configuration variable.
system(...)
system(command) -> exit_status
Execute the command (a string) in a subshell.
tcgetpgrp(...)
tcgetpgrp(fd) -> pgid
Return the process group associated with the terminal given by a fd.
tcsetpgrp(...)
tcsetpgrp(fd, pgid) -> None
Set the process group associated with the terminal given by a fd.
tempnam(...)
tempnam([dir[, prefix]]) -> string
Return a unique name for a temporary file.
The directory and a short may be specified as strings; they may be omitted
or None if not needed.
times(...)
times() -> (utime, stime, cutime, cstime, elapsed_time)
Return a tuple of floating point numbers indicating process times.
tmpfile(...)
tmpfile() -> file object
Create a temporary file with no directory entries.
tmpnam(...)
tmpnam() -> string
Return a unique name for a temporary file.
ttyname(...)
ttyname(fd) -> String
Return the name of the terminal device connected to 'fd'.
umask(...)
umask(new_mask) -> old_mask
Set the current numeric umask and return the previous umask.
uname(...)
uname() -> (sysname, nodename, release, version, machine)
Return a tuple identifying the current operating system.
unlink(...)
unlink(path) -> None
Remove a file (same as remove(path)).
unsetenv(...)
unsetenv(key) -> None
Delete an environment variable.
utime(...)
utime(path, (atime, utime)) -> None
utime(path, None) -> None
Set the access and modified time of the file to the given values.  If the
second form is used, set the access and modified times to the current time.
wait(...)
wait() -> (pid, status)
Wait for completion of a child process.
waitpid(...)
waitpid(pid, options) -> (pid, status)
Wait for completion of a given child process.
write(...)
write(fd, string) -> byteswritten
Write a string to a file descriptor.
 
Data
             F_OK = 0
NGROUPS_MAX = 32
O_APPEND = 1024
O_CREAT = 64
O_DIRECT = 16384
O_DIRECTORY = 65536
O_DSYNC = 4096
O_EXCL = 128
O_LARGEFILE = 32768
O_NDELAY = 2048
O_NOCTTY = 256
O_NOFOLLOW = 131072
O_NONBLOCK = 2048
O_RDONLY = 0
O_RDWR = 2
O_RSYNC = 4096
O_SYNC = 4096
O_TRUNC = 512
O_WRONLY = 1
P_NOWAIT = 1
P_NOWAITO = 1
P_WAIT = 0
R_OK = 4
TMP_MAX = 238328
WNOHANG = 1
W_OK = 2
X_OK = 1
__all__ = ['altsep', 'curdir', 'pardir', 'sep', 'pathsep', 'linesep', 'defpath', 'name', 'F_OK', 'NGROUPS_MAX', 'O_APPEND', 'O_CREAT', 'O_DIRECT', 'O_DIRECTORY', 'O_DSYNC', 'O_EXCL', 'O_LARGEFILE', 'O_NDELAY', 'O_NOCTTY', 'O_NOFOLLOW', ...]
__file__ = '/usr/lib/python2.2/os.pyc'
__name__ = 'os'
_notfound = None
altsep = None
confstr_names = {'CS_LFS64_CFLAGS': 1004, 'CS_LFS64_LDFLAGS': 1005, 'CS_LFS64_LIBS': 1006, 'CS_LFS64_LINTFLAGS': 1007, 'CS_LFS_CFLAGS': 1000, 'CS_LFS_LDFLAGS': 1001, 'CS_LFS_LIBS': 1002, 'CS_LFS_LINTFLAGS': 1003, 'CS_PATH': 0, 'CS_XBS5_ILP32_OFF32_CFLAGS': 1100, ...}
curdir = '.'
defpath = ':/bin:/usr/bin'
environ = {'USERNAME': '', 'PYTHONPATH': '/home/ping/pytho... 'MAIL': '/var/spool/mail/ping', 'LS_COLORS': ''}
extsep = '.'
linesep = '\n'
name = 'posix'
pardir = '..'
pathconf_names = {'PC_ASYNC_IO': 10, 'PC_CHOWN_RESTRICTED': 6, 'PC_FILESIZEBITS': 13, 'PC_LINK_MAX': 0, 'PC_MAX_CANON': 1, 'PC_MAX_INPUT': 2, 'PC_NAME_MAX': 3, 'PC_NO_TRUNC': 7, 'PC_PATH_MAX': 4, 'PC_PIPE_BUF': 5, ...}
pathsep = ':'
sep = '/'
sysconf_names = {'SC_2_CHAR_TERM': 95, 'SC_2_C_BIND': 47, 'SC_2_C_DEV': 48, 'SC_2_C_VERSION': 96, 'SC_2_FORT_DEV': 49, 'SC_2_FORT_RUN': 50, 'SC_2_LOCALEDEF': 52, 'SC_2_SW_DEV': 51, 'SC_2_UPE': 97, 'SC_2_VERSION': 46, ...}