Home       Trees       Indices       Help   
SCons
Module os
[hide private]
[frames] | no frames]

Module os

source code

OS routines for Mac, NT, or Posix depending on what system we're on.

This exports:
  - all functions from posix, nt, os2, mac, or ce, e.g. unlink, stat, etc.
  - os.path is one of the modules posixpath, ntpath, or macpath
  - os.name is 'posix', 'nt', '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
  - os.devnull is the file path of the null device ('/dev/null', etc.)

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).


Classes [hide private]
  _Environ
  error
OS system call failed.
  stat_result
stat_result: Result from stat or lstat.
  statvfs_result
statvfs_result: Result from statvfs or fstatvfs.
Functions [hide private]
 
WCOREDUMP(status)
Return True if the process returning 'status' was dumped to a core file.
 
WEXITSTATUS(status)
Return the process return code from 'status'.
 
WIFCONTINUED(status)
Return True if the process returning 'status' was continued from a job control stop.
 
WIFEXITED(status)
Return true if the process returning 'status' exited using the exit() system call.
 
WIFSIGNALED(status)
Return True if the process returning 'status' was terminated by a signal.
 
WIFSTOPPED(status)
Return True if the process returning 'status' was stopped.
 
WSTOPSIG(status)
Return the signal that stopped the process that provided the 'status' value.
 
WTERMSIG(status)
Return the signal that terminated the process that provided the 'status' value.
 
_execvpe(file, args, env=False) source code
 
_exists(name) source code
 
_get_exports_list(module) source code
 
_make_stat_result(tup, dict) source code
 
_make_statvfs_result(tup, dict) source code
 
_pickle_stat_result(sr) source code
 
_pickle_statvfs_result(sr) source code
 
_spawnvef(mode, file, args, env, func) source code
 
abort()
Abort the interpreter immediately.
 
access(path, mode)
Use the real uid/gid to test for access to a path.
 
chdir(path)
Change the current working directory to the specified path.
 
chmod(path, mode)
Change the access permissions of a file.
 
chown(path, uid, gid)
Change the owner and group id of path to the numeric uid and gid.
 
chroot(path)
Change root directory to path.
 
close(fd)
Close a file descriptor (for low level IO).
 
confstr(name)
Return a string-valued system configuration variable.
 
ctermid()
Return the name of the controlling terminal for this process.
 
dup(fd)
Return a duplicate of a file descriptor.
 
dup2(old_fd, new_fd)
Duplicate file descriptor.
 
execl(file, *args)
Execute the executable file with argument list args, replacing the current process.		 source code
 
execle(file, env, *args)
Execute the executable file with argument list args and environment env, replacing the current process.		 source code
 
execlp(file, *args)
Execute the executable file (which is searched for along $PATH) with argument list args, replacing the current process.		 source code
 
execlpe(file, env, *args)
Execute the executable file (which is searched for along $PATH) with argument list args and environment env, replacing the current process.		 source code
 
execv(path, args)
Execute an executable path with arguments, replacing current process.
 
execve(path, args, env)
Execute a path with arguments and environment, replacing current process.
 
execvp(file, args)
Execute the executable file (which is searched for along $PATH) with argument list args, replacing the current process.		 source code
 
execvpe(file, args, env)
Execute the executable file (which is searched for along $PATH) with argument list args and environment env , replacing the current process.		 source code
 
fchdir(fildes)
Change to the directory of the given file descriptor.
 
fdatasync(fildes)
force write of file with filedescriptor to disk.
 
fdopen(fd, mode='r' , bufsize=...)
Return an open file object connected to a file descriptor.
 
fork()
Fork a child process.
 
forkpty()
Fork a new process with a new pseudo-terminal as controlling tty.
 
fpathconf(fd, name)
Return the configuration limit name for the file descriptor fd.
 
fstat(fd)
Like stat(), but for an open file descriptor.
 
fstatvfs(fd)
Perform an fstatvfs system call on the given fd.
 
fsync(fildes)
force write of file with filedescriptor to disk.
 
ftruncate(fd, length)
Truncate a file to a specified length.
 
getcwd()
Return a string representing the current working directory.
 
getcwdu()
Return a unicode string representing the current working directory.
 
getegid()
Return the current process's effective group id.
 
getenv(key, default=False)
Get an environment variable, return None if it doesn't exist.		 source code
 
geteuid()
Return the current process's effective user id.
 
getgid()
Return the current process's group id.
 
getgroups()
Return list of supplemental group IDs for the process.
 
getloadavg()
Return the number of processes in the system run queue averaged over...
 
getlogin()
Return the actual login name.
 
getpgid(pid)
Call the system call getpgid().
 
getpgrp()
Return the current process group id.
 
getpid()
Return the current process id
 
getppid()
Return the parent's process id.
 
getsid(pid)
Call the system call getsid().
 
getuid()
Return the current process's user id.
 
isatty(fd)
Return True if the file descriptor 'fd' is an open file descriptor connected to the slave end of a terminal.
 
kill(pid, sig)
Kill a process with a signal.
 
killpg(pgid, sig)
Kill a process group with a signal.
 
lchown(path, uid, gid)
Change the owner and group id of path to the numeric uid and gid.
 
link(src, dst)
Create a hard link to a file.
 
listdir(path)
Return a list containing the names of the entries in the directory.
 
lseek(fd, pos, how)
Set the current position of a file descriptor.
 
lstat(path)
Like stat(path), but do not follow symbolic links.
 
major(device)
Extracts a device major number from a raw device number.
 
makedev(major, minor)
Composes a raw device number from the major and minor device numbers.
 
makedirs(path, mode=0777)
Super-mkdir; create a leaf directory and all intermediate ones.		 source code
 
minor(device)
Extracts a device minor number from a raw device number.
 
mkdir(path, mode=0777)
Create a directory.
 
mkfifo(filename, mode=0666)
Create a FIFO (a POSIX named pipe).
 
mknod(filename, mode=0600, device=...)
Create a filesystem node (file, device special file or named pipe) named filename.
 
nice(inc)
Decrease the priority of process by inc and return the new priority.
 
open(filename, flag, mode=0777)
Open a file (for low level IO).
 
openpty()
Open a pseudo-terminal, returning open fd's for both master and slave end.
 
pathconf(path, name)
Return the configuration limit name for the file or directory path.
 
pipe()
Create a pipe.
 
popen(command, mode='r' , bufsize=...)
Open a pipe to/from a command returning a file object.
 
popen2(cmd, mode='t', bufsize=-1)
Execute the shell command 'cmd' in a sub-process.		 source code
 
popen3(cmd, mode='t', bufsize=-1)
Execute the shell command 'cmd' in a sub-process.		 source code
 
popen4(cmd, mode='t', bufsize=-1)
Execute the shell command 'cmd' in a sub-process.		 source code
 
putenv(key, value)
Change or add an environment variable.
 
read(fd, buffersize)
Read a file descriptor.
 
readlink(path)
Return a string representing the path to which the symbolic link points.
 
remove(path)
Remove a file (same as unlink(path)).
 
removedirs(path)
Super-rmdir; remove a leaf directory and all empty intermediate ones.		 source code
 
rename(old, new)
Rename a file or directory.
 
renames(old, new)
Super-rename; create directories as necessary and delete any left empty.		 source code
 
rmdir(path)
Remove a directory.
 
setegid(gid)
Set the current process's effective group id.
 
seteuid(uid)
Set the current process's effective user id.
 
setgid(gid)
Set the current process's group id.
 
setgroups(list)
Set the groups of the current process to list.
 
setpgid(pid, pgrp)
Call the system call setpgid().
 
setpgrp()
Make this process a session leader.
 
setregid(rgid, egid)
Set the current process's real and effective group ids.
 
setreuid(ruid, euid)
Set the current process's real and effective user ids.
 
setsid()
Call the system call setsid().
 
setuid(uid)
Set the current process's user id.
 
spawnl(mode, file, *args)
Execute file with arguments from args in a subprocess.		 source code
 
spawnle(mode, file, env, *args)
Execute file with arguments from args in a subprocess with the supplied environment.		 source code
 
spawnlp(mode, file, *args)
Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment.		 source code
 
spawnlpe(mode, file, env, *args)
Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment.		 source code
 
spawnv(mode, file, args)
Execute file with arguments from args in a subprocess.		 source code
 
spawnve(mode, file, args, env)
Execute file with arguments from args in a subprocess with the specified environment.		 source code
 
spawnvp(mode, file, args)
Execute file (which is looked for along $PATH) with arguments from args in a subprocess.		 source code
 
spawnvpe(mode, file, args, env)
Execute file (which is looked for along $PATH) with arguments from args in a subprocess with the supplied environment.		 source code
 
stat(path)
Perform a stat system call on the given path.
 
stat_float_times(newval=...)
Determine whether os.[lf]stat represents time stamps as float objects.
 
statvfs(path)
Perform a statvfs system call on the given path.
 
strerror(code)
Translate an error code to a message string.
 
symlink(src, dst)
Create a symbolic link pointing to src named dst.
 
sysconf(name)
Return an integer-valued system configuration variable.
 
system(command)
Execute the command (a string) in a subshell.
 
tcgetpgrp(fd)
Return the process group associated with the terminal given by a fd.
 
tcsetpgrp(fd, pgid)
Set the process group associated with the terminal given by a fd.
 
tempnam(dir=..., prefix=...)
Return a unique name for a temporary file.
 
times()
Return a tuple of floating point numbers indicating process times.
 
tmpfile()
Create a temporary file with no directory entries.
 
tmpnam()
Return a unique name for a temporary file.
 
ttyname(fd)
Return the name of the terminal device connected to 'fd'.
 
umask(new_mask)
Set the current numeric umask and return the previous umask.
 
uname()
Return a tuple identifying the current operating system.
 
unlink(path)
Remove a file (same as remove(path)).
 
unsetenv(key)
Delete an environment variable.
 
urandom(n)
Return a string of n random bytes suitable for cryptographic use.		 source code
 
utime(...)
utime(path, (atime, mtime)) utime(path, None) Set the access and modified time of the file to the given values.
 
wait()
Wait for completion of a child process.
 
wait3(options)
Wait for completion of a child process.
 
wait4(pid, options)
Wait for completion of a given child process.
 
waitpid(pid, options)
Wait for completion of a given child process.
 
walk(top, topdown=True, onerror=False)
Directory tree generator.		 source code
 
write(fd, string)
Write a string to a file descriptor.
Variables [hide private]
  EX_CANTCREAT = 73
  EX_CONFIG = 78
  EX_DATAERR = 65
  EX_IOERR = 74
  EX_NOHOST = 68
  EX_NOINPUT = 66
  EX_NOPERM = 77
  EX_NOUSER = 67
  EX_OK = 0
  EX_OSERR = 71
  EX_OSFILE = 72
  EX_PROTOCOL = 76
  EX_SOFTWARE = 70
  EX_TEMPFAIL = 75
  EX_UNAVAILABLE = 69
  EX_USAGE = 64
  F_OK = 0
  NGROUPS_MAX = 65536
  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 = False
  P_NOWAIT = False
  P_NOWAITO = False
  P_WAIT = 0
  R_OK = 4
  SEEK_CUR = False
  SEEK_END = 2
  SEEK_SET = 0
  TMP_MAX = 238328
  WCONTINUED = 8
  WNOHANG = False
  WUNTRACED = 2
  W_OK = 2
  X_OK = False
  altsep = False
  confstr_names = {'CS_LFS64_CFLAGS': 1004, 'CS_LFS64_LDFLAGS': ...
  curdir = '.'
  defpath = ':/bin:/usr/bin'
  devnull = '/dev/null'
  environ = {'PATH': '/home/scons/bin:/home/scons/bin:/usr/local...
  extsep = '.'
  linesep = '\n'
  name = 'posix'
  pardir = '..'
  pathconf_names = {'PC_ASYNC_IO': 10, 'PC_CHOWN_RESTRICTED': 6,...
  pathsep = ':'
  sep = '/'
  sysconf_names = {'SC_2_CHAR_TERM': 95, 'SC_2_C_BIND': 47, 'SC_...
Function Details [hide private]

WCOREDUMP(status)

  
Return True if the process returning 'status' was dumped to a core file.
Returns:
bool

WEXITSTATUS(status)

  
Return the process return code from 'status'.
Returns:
integer

WIFCONTINUED(status)

  
Return True if the process returning 'status' was continued from a
job control stop.
Returns:
bool

WIFEXITED(status)

  
Return true if the process returning 'status' exited using the exit()
system call.
Returns:
bool

WIFSIGNALED(status)

  
Return True if the process returning 'status' was terminated by a signal.
Returns:
bool

WIFSTOPPED(status)

  
Return True if the process returning 'status' was stopped.
Returns:
bool

WSTOPSIG(status)

  
Return the signal that stopped the process that provided
the 'status' value.
Returns:
integer

WTERMSIG(status)

  
Return the signal that terminated the process that provided the 'status'
value.
Returns:
integer

abort()

  
Abort the interpreter immediately.  This 'dumps core' or otherwise fails
in the hardest way possible on the hosting operating system.
Returns:
does not return!

access(path, mode)

  
Use the real uid/gid to test for access to a path.  Note that most
operations will use the effective uid/gid, therefore this routine can
be used in a suid/sgid environment to test if the invoking user has the
specified access to the path.  The mode argument can be F_OK to test
existence, or the inclusive-OR of R_OK, W_OK, and X_OK.
Returns:
True if granted, False otherwise

confstr(name)

  
Return a string-valued system configuration variable.
Returns:
string

ctermid()

  
Return the name of the controlling terminal for this process.
Returns:
string

dup(fd)

  
Return a duplicate of a file descriptor.
Returns:
fd2

execv(path, args)

  
Execute an executable path with arguments, replacing current process.

        path: path of executable file
        args: tuple or list of strings

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)

source code  
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)

source code  
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.

fchdir(fildes)

  
Change to the directory of the given file descriptor.  fildes must be
opened on a directory, not a file.

fdatasync(fildes)

  
force write of file with filedescriptor to disk.
 does not force update of metadata.

fdopen(fd, mode='r' , bufsize=...)

  
Return an open file object connected to a file descriptor.
Returns:
file_object