os
index
/usr/lib/python1.5/os.py
 

# os.py -- either mac, dos or posix depending on what system we're on.

   
Modules
                        
UserDict
posixpath
sys

   
Classes
                        
UserDict.UserDict
_Environ

   
class _Environ(UserDict.UserDict)
              
__init__(self, environ)
__setitem__(self, key, item)

   
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.
_exit(...)
_exit(status)
Exit to the system with specified status, without normal exit processing.
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.
close(...)
close(fd) -> None
Close a file descriptor (for low level IO).
dup(...)
dup(fd) -> fd2
Return a duplicate of a file descriptor.
dup2(...)
dup2(fd, fd2) -> None
Duplicate file descriptor.
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: dictonary of strings mapping to 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.
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.
geteuid(...)
geteuid() -> euid
Return the current process's effective user id.
getgid(...)
getgid() -> gid
Return the current process's group id.
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.
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.
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).
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.
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)).
rename(...)
rename(old, new) -> None
Rename a file or directory.
rmdir(...)
rmdir(path) -> None
Remove a directory.
setgid(...)
setgid(gid) -> None
Set the current process's group id.
setpgid(...)
setpgid(pid, pgrp) -> None
Call the system call setpgid().
setpgrp(...)
setpgrp() -> None
Make this process a session leader.
setsid(...)
setsid() -> None
Call the system call setsid().
setuid(...)
setuid(uid) -> None
Set the current process's user id.
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.
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.
times(...)
times() -> (utime, stime, cutime, cstime, elapsed_time)
Return a tuple of floating point numbers indicating process times.
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)).
utime(...)
utime(path, (atime, utime)) -> None
Set the access and modified time of the file to the given values.
wait(...)
wait() -> (pid, status)
Wait for completion of a child process.
waitpid(...)
waitpid(pid, options) -> (pid, status)
Wait for completion of a give child process.
write(...)
write(fd, string) -> byteswritten
Write a string to a file descriptor.

   
Constants
                        
F_OK = 0
O_APPEND = 1024
O_CREAT = 64
O_DSYNC = 4096
O_EXCL = 128
O_NDELAY = 2048
O_NOCTTY = 256
O_NONBLOCK = 2048
O_RDONLY = 0
O_RDWR = 2
O_RSYNC = 4096
O_SYNC = 4096
O_TRUNC = 512
O_WRONLY = 1
R_OK = 4
WNOHANG = 1
W_OK = 2
X_OK = 1
curdir = '.'
defpath = ':/bin:/usr/bin'
linesep = '\012'
name = 'posix'
pardir = '..'
pathsep = ':'
sep = '/'