Module posix
[hide private]
[frames] | no frames]

Module posix

This module provides access to operating system functionality that is standardized by the C Standard and the POSIX standard (a thinly disguised Unix interface). Refer to the library manual and corresponding Unix manual entries for more information on calls.

Classes [hide private]
stat_result
stat_result: Result from stat or lstat.
statvfs_result
statvfs_result: Result from statvfs or fstatvfs.
Functions [hide private]
bool
WCOREDUMP(status)
Return True if the process returning 'status' was dumped to a core file.
integer
WEXITSTATUS(status)
Return the process return code from 'status'.
bool
WIFCONTINUED(status)
Return True if the process returning 'status' was continued from a job control stop.
bool
WIFEXITED(status)
Return true if the process returning 'status' exited using the exit() system call.
bool
WIFSIGNALED(status)
Return True if the process returning 'status' was terminated by a signal.
bool
WIFSTOPPED(status)
Return True if the process returning 'status' was stopped.
integer
WSTOPSIG(status)
Return the signal that stopped the process that provided the 'status' value.
integer
WTERMSIG(status)
Return the signal that terminated the process that provided the 'status' value.
 
_exit(status)
Exit to the system with specified status, without normal exit processing.
does not return!
abort()
Abort the interpreter immediately.
1 if granted, 0 otherwise
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).
string
confstr(name)
Return a string-valued system configuration variable.
string
ctermid()
Return the name of the controlling terminal for this process.
fd2
dup(fd)
Return a duplicate of a file descriptor.
 
dup2(old_fd, new_fd)
Duplicate file descriptor.
 
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.
 
fchdir(fildes)
Change to the directory of the given file descriptor.
 
fdatasync(fildes)
force write of file with filedescriptor to disk.
file_object
fdopen(fd, mode='r' , bufsize=...)
Return an open file object connected to a file descriptor.
pid
fork()
Fork a child process.
(pid, master_fd)
forkpty()
Fork a new process with a new pseudo-terminal as controlling tty.
integer
fpathconf(fd, name)
Return the configuration limit name for the file descriptor fd.
stat result
fstat(fd)
Like stat(), but for an open file descriptor.
statvfs result
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.
path
getcwd()
Return a string representing the current working directory.
path
getcwdu()
Return a unicode string representing the current working directory.
egid
getegid()
Return the current process's effective group id.
euid
geteuid()
Return the current process's effective user id.
gid
getgid()
Return the current process's group id.
list of group IDs
getgroups()
Return list of supplemental group IDs for the process.
(float, float, float)
getloadavg()
Return the number of processes in the system run queue averaged over the last 1, 5, and 15 minutes or raises OSError if the load average was unobtainable
string
getlogin()
Return the actual login name.
pgid
getpgid(pid)
Call the system call getpgid().
pgrp
getpgrp()
Return the current process group id.
pid
getpid()
Return the current process id
ppid
getppid()
Return the parent's process id.
sid
getsid(pid)
Call the system call getsid().
uid
getuid()
Return the current process's user id.
bool
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.
list_of_strings
listdir(path)
Return a list containing the names of the entries in the directory.
newpos
lseek(fd, pos, how)
Set the current position of a file descriptor.
stat result
lstat(path)
Like stat(path), but do not follow symbolic links.
major number
major(device)
Extracts a device major number from a raw device number.
device number
makedev(major, minor)
Composes a raw device number from the major and minor device numbers.
minor number
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.
new_priority
nice(inc)
Decrease the priority of process by inc and return the new priority.
fd
open(filename, flag, mode=0777)
Open a file (for low level IO).
(master_fd, slave_fd)
openpty()
Open a pseudo-terminal, returning open fd's for both master and slave end.
integer
pathconf(path, name)
Return the configuration limit name for the file or directory path.
(read_end, write_end)
pipe()
Create a pipe.
pipe
popen(command, mode='r' , bufsize=...)
Open a pipe to/from a command returning a file object.
 
putenv(key, value)
Change or add an environment variable.
string
read(fd, buffersize)
Read a file descriptor.
path
readlink(path)
Return a string representing the path to which the symbolic link points.
 
remove(path)
Remove a file (same as unlink(path)).
 
rename(old, new)
Rename a file or directory.
 
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.
stat result
stat(path)
Perform a stat system call on the given path.
oldval
stat_float_times(newval=...)
Determine whether os.[lf]stat represents time stamps as float objects.
statvfs result
statvfs(path)
Perform a statvfs system call on the given path.
string
strerror(code)
Translate an error code to a message string.
 
symlink(src, dst)
Create a symbolic link pointing to src named dst.
integer
sysconf(name)
Return an integer-valued system configuration variable.
exit_status
system(command)
Execute the command (a string) in a subshell.
pgid
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.
string
tempnam(dir=..., prefix=...)
Return a unique name for a temporary file.
(utime, stime, cutime, cstime, elapsed_time)
times()
Return a tuple of floating point numbers indicating process times.
file object
tmpfile()
Create a temporary file with no directory entries.
string
tmpnam()
Return a unique name for a temporary file.
string
ttyname(fd)
Return the name of the terminal device connected to 'fd'.
old_mask
umask(new_mask)
Set the current numeric umask and return the previous umask.
(sysname, nodename, release, version, machine)
uname()
Return a tuple identifying the current operating system.
 
unlink(path)
Remove a file (same as remove(path)).
 
unsetenv(key)
Delete an environment variable.
 
utime(...)
utime(path, (atime, mtime)) utime(path, None)
(pid, status)
wait()
Wait for completion of a child process.
(pid, status, rusage)
wait3(options)
Wait for completion of a child process.
(pid, status, rusage)
wait4(pid, options)
Wait for completion of a given child process.
(pid, status)
waitpid(pid, options)
Wait for completion of a given child process.
byteswritten
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 = 1
  R_OK = 4
  TMP_MAX = 238328
  WCONTINUED = 8
  WNOHANG = 1
  WUNTRACED = 2
  W_OK = 2
  X_OK = 1
  confstr_names = {'CS_LFS64_CFLAGS': 1004, 'CS_LFS64_LDFLAGS': ...
  environ = {'BASH_ENV': '/home/edloper/.bashrc', 'CONSOLE': '/d...
  pathconf_names = {'PC_ASYNC_IO': 10, 'PC_CHOWN_RESTRICTED': 6,...
  sysconf_names = {'SC_2_CHAR_TERM': 95, 'SC_2_C_BIND': 47, 'SC_...

Imports: error


Function Details [hide private]

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: 1 if granted, 0 otherwise

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

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.

fork()

 

Fork a child process. Return 0 to child process and PID of child to parent process.

Returns: pid

forkpty()

 

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.

Returns: (pid, master_fd)

fpathconf(fd, name)

 

Return the configuration limit name for the file descriptor fd. If there is no limit, return -1.

Returns: integer

lchown(path, uid, gid)

 

Change the owner and group id of path to the numeric uid and gid. This function will not follow symbolic links.

listdir(path)

 
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.

Returns: list_of_strings

mknod(filename, mode=0600, device=...)

 

Create a filesystem node (file, device special file or named pipe) named filename. mode specifies both the permissions to use and the type of node to be created, being combined (bitwise OR) with one of S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. For S_IFCHR and S_IFBLK, device defines the newly created device special file (probably using os.makedev()), otherwise it is ignored.

pathconf(path, name)

 

Return the configuration limit name for the file or directory path. If there is no limit, return -1.

Returns: integer

stat_float_times(newval=...)

 

Determine whether os.[lf]stat represents time stamps as float objects. If newval is True, future calls to stat() return floats, if it is False, future calls return ints. If newval is omitted, return the current setting.

Returns: oldval

tempnam(dir=..., prefix=...)

 

Return a unique name for a temporary file. The directory and a prefix may be specified as strings; they may be omitted or None if not needed.

Returns: string

utime(...)

 

utime(path, (atime, mtime)) utime(path, 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.


Variables Details [hide private]

confstr_names

Value:
{'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,
...

environ

Value:
{'BASH_ENV': '/home/edloper/.bashrc',
 'CONSOLE': '/dev/console',
 'CVSROOT': '/home/edloper/cvs',
 'DISPLAY': ':1.0',
 'DPKG_ARCH': 'i386',
 'EDITOR': 'emacs',
 'FONT_PATH': '/home/edloper/.afterstep/desktop/fonts/:/usr/share/afte\
rstep/desktop/fonts/:/usr/share/fonts/default/TrueType/:/usr/share/fon\
...

pathconf_names

Value:
{'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,
...

sysconf_names

Value:
{'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,
...