Python: module os

From 34a60763e79546e0f84e30fbcc430632f3dbb39e Mon Sep 17 00:00:00 2001 From: hut Date: Tue, 16 Feb 2010 01:56:21 +0100 Subject: incremented version number and updated pydoc html files --- doc/pydoc/os.html | 149 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 95 insertions(+), 54 deletions(-) (limited to 'doc/pydoc/os.html') diff --git a/doc/pydoc/os.html b/doc/pydoc/os.html index 9d1b6771..b0b2b308 100644 --- a/doc/pydoc/os.html +++ b/doc/pydoc/os.html @@ -1,6 +1,6 @@ + Python: module os - @@ -8,17 +8,17 @@

os	index /usr/lib/python3.1/os.py Module Docs

+>index
/usr/lib/python2.6/os.py
Module Docs

OS routines for Mac, NT, or Posix depending on what system we're on. This exports: - all functions from posix, nt, os2, or ce, e.g. unlink, stat, etc. - - os.path is either posixpath or ntpath - - os.name is either 'posix', 'nt', 'os2' or 'ce'. + - os.path is one of the modules posixpath, or ntpath + - os.name is 'posix', 'nt', 'os2', '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 (always '.') + - 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') @@ -37,11 +37,12 @@ and opendir), and leave all pathname manipulation& Modules -copyreg + UserDict +copy_reg errno - posixpath +posixpath sys -

+

@@ -49,17 +50,17 @@ and opendir), and leave all pathname manipulation& -builtins.EnvironmentError(builtins.Exception) + __builtin__.object -builtins.OSError + posix.stat_result + posix.statvfs_result -builtins.object + exceptions.EnvironmentError(exceptions.StandardError) -posix.stat_result - posix.statvfs_result + exceptions.OSError @@ -67,17 +68,18 @@ and opendir), and leave all pathname manipulation& +error = class OSError(EnvironmentError) -error = class OSError(EnvironmentError) OS system call failed. Method resolution order: -OSError -EnvironmentError -Exception -BaseException -object +OSError +EnvironmentError +StandardError +Exception +BaseException +__builtin__.object Methods defined here: @@ -85,16 +87,16 @@ Methods defined here: Data and other attributes defined here: -__new__ = <built-in method __new__ of type object at 0x7f6a9223efc0> T.__new__(S, ...) -> a new object with type S, a subtype of T +__new__ = <built-in method __new__ of type object at 0x7fdbe7034f80> T.__new__(S, ...) -> a new object with type S, a subtype of T -Methods inherited from EnvironmentError: +Methods inherited from EnvironmentError: __reduce__(...) __str__(...) x.__str__() <==> str(x) -Data descriptors inherited from EnvironmentError: +Data descriptors inherited from EnvironmentError: errno exception errno @@ -105,44 +107,43 @@ Data descriptors inherited from Environ exception strerror -Methods inherited from BaseException: +Methods inherited from BaseException: __delattr__(...) x.__delattr__('name') <==> del x.name __getattribute__(...) x.__getattribute__('name') <==> x.name +__getitem__(...) x.__getitem__(y) <==> x[y] + +__getslice__(...) x.__getslice__(i, j) <==> x[i:j] + +Use of negative indices is not supported. + __repr__(...) x.__repr__() <==> repr(x) __setattr__(...) x.__setattr__('name', value) <==> x.name = value __setstate__(...) -with_traceback(...) Exception.with_traceback(tb) -- -set self.__traceback__ to tb and return self. +__unicode__(...) -Data descriptors inherited from BaseException: -__cause__ -exception cause - -__context__ -exception context - +Data descriptors inherited from BaseException: __dict__ -__traceback__ - args +message + +class stat_result(__builtin__.object)__getitem__(...) x.__getitem__(y) <==> x[y] +__getslice__(...) x.__getslice__(i, j) <==> x[i:j] + +Use of negative indices is not supported. + __gt__(...) x.__gt__(y) <==> x>y __hash__(...) x.__hash__() <==> hash(x) @@ -225,7 +230,7 @@ Data descriptors defined here: Data and other attributes defined here: -__new__ = <built-in method __new__ of type object at 0x7f6a92292840> T.__new__(S, ...) -> a new object with type S, a subtype of T +__new__ = <built-in method __new__ of type object at 0x7fdbe7073800> T.__new__(S, ...) -> a new object with type S, a subtype of T n_fields = 16 @@ -237,12 +242,12 @@ Data and other attributes defined here: -class stat_result(builtins.object) stat_result: Result from stat or lstat. -This object may be accessed either as a tuple of +This object may be accessed either as a tuple of (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime) or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on. @@ -162,6 +163,10 @@ See os.stat for more information. +class statvfs_result(__builtin__.object)__getitem__(...) x.__getitem__(y) <==> x[y] +__getslice__(...) x.__getslice__(i, j) <==> x[i:j] + +Use of negative indices is not supported. + __gt__(...) x.__gt__(y) <==> x>y __hash__(...) x.__hash__() <==> hash(x) @@ -303,7 +312,7 @@ Data descriptors defined here: Data and other attributes defined here: -__new__ = <built-in method __new__ of type object at 0x7f6a922929e0> T.__new__(S, ...) -> a new object with type S, a subtype of T +__new__ = <built-in method __new__ of type object at 0x7fdbe70739a0> T.__new__(S, ...) -> a new object with type S, a subtype of T n_fields = 10 @@ -381,10 +390,6 @@ Return a string-valued system configuration variable.ctermid(...) ctermid() -> string Return the name of the controlling terminal for this process. - device_encoding(...) device_encoding(fd) -> str - -Return a string describing the encoding of the device -if the output is a terminal; else return None. dup(...) dup(fd) -> fd2 Return a duplicate of a file descriptor. @@ -448,6 +453,9 @@ fd to the numeric uid and gid. 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. @@ -476,10 +484,10 @@ force write of file with filedescriptor to di Truncate a file to a specified length. getcwd(...) getcwd() -> path -Return a unicode string representing the current working directory. - getcwdb(...) getcwdb() -> path +Return a string representing the current working directory. + getcwdu(...) getcwdu() -> path -Return a bytes string representing the current working directory. +Return a unicode string representing the current working directory.getegid(...) getegid() -> egid Return the current process's effective group id. @@ -555,7 +563,7 @@ Like stat(path), but do not follow Extracts a device major number from a raw device number.makedev(...) makedev(major, minor) -> device number Composes a raw device number from the major and minor device numbers. - makedirs(name, mode=511) makedirs(path [, mode=0o777]) + makedirs(name, mode=511) makedirs(path [, mode=0777]) Super-mkdir; create a leaf directory and all intermediate ones. Works like mkdir, except that any intermediate path segment (not @@ -593,6 +601,27 @@ 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) Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd' +may be a sequence, in which case arguments will be passed directly to +the program without shell intervention (as with os.spawnv()). If 'cmd' +is a string it will be passed to the shell (as with os.system()). If +'bufsize' is specified, it sets the buffer size for the I/O pipes. The +file objects (child_stdin, child_stdout) are returned. + popen3(cmd, mode='t', bufsize=-1) Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd' +may be a sequence, in which case arguments will be passed directly to +the program without shell intervention (as with os.spawnv()). If 'cmd' +is a string it will be passed to the shell (as with os.system()). If +'bufsize' is specified, it sets the buffer size for the I/O pipes. The +file objects (child_stdin, child_stdout, child_stderr) are returned. + popen4(cmd, mode='t', bufsize=-1) Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd' +may be a sequence, in which case arguments will be passed directly to +the program without shell intervention (as with os.spawnv()). If 'cmd' +is a string it will be passed to the shell (as with os.system()). If +'bufsize' is specified, it sets the buffer size for the I/O pipes. The +file objects (child_stdin, child_stdout_stderr) are returned. putenv(...) putenv(key, value) Change or add an environment variable. @@ -745,9 +774,20 @@ Return the process group associated with the tcsetpgrp(...) tcsetpgrp(fd, pgid) 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 prefix 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'. @@ -813,7 +853,7 @@ optional arg 'onerror' is specified, it should&nbs will be called with one argument, an os.error instance. It can report the error to continue with the walk, or raise the exception to abort the walk. Note that the filename is available as the -filename attribute of the exception object. +filename attribute of the exception object. By default, os.walk does not follow symbolic links to subdirectories on systems that support them. In order to get this functionality, set the @@ -829,9 +869,9 @@ Example: import os from os.path import join, getsize for root, dirs, files in os.walk('python/Lib/email'): - print(root, "consumes", end="") - print(sum([getsize(join(root, name)) for name in files]), end="") - print("bytes in", len(files), "non-directory files") + print root, "consumes", + print sum([getsize(join(root, name)) for name in files]), + print "bytes in", len(files), "non-directory files" if 'CVS' in dirs: dirs.remove('CVS') # don't visit CVS directories write(...) write(fd, string) -> byteswritten @@ -891,13 +931,14 @@ Write a string to a file descriptor. WUNTRACED = 2 W_OK = 2 X_OK = 1 -__all__ = ['altsep', 'curdir', 'pardir', 'sep', 'pathsep', 'linesep', 'defpath', 'name', 'path', 'devnull', 'SEEK_SET', 'SEEK_CUR', 'SEEK_END', 'EX_CANTCREAT', 'EX_CONFIG', 'EX_DATAERR', 'EX_IOERR', 'EX_NOHOST', 'EX_NOINPUT', 'EX_NOPERM', ...] +__all__ = ['altsep', 'curdir', 'pardir', 'sep', 'extsep', 'pathsep', 'linesep', 'defpath', 'name', 'path', 'devnull', 'SEEK_SET', 'SEEK_CUR', 'SEEK_END', 'EX_CANTCREAT', 'EX_CONFIG', 'EX_DATAERR', 'EX_IOERR', 'EX_NOHOST', 'EX_NOINPUT', ...] 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' devnull = '/dev/null' -environ = <os._Environ object at 0x7f6a9127be50> +environ = {'PROMPT_COMMAND': 'echo -ne "\\033]0;${USER}@${...L': '/var/spool/mail/hut', 'OLDPWD': '/home/hut'} +extsep = '.' linesep = '\n' name = 'posix' pardir = '..' -- cgit 1.4.1-2-gfad0 -class statvfs_result(builtins.object) statvfs_result: Result from statvfs or fstatvfs. -This object may be accessed either as a tuple of +This object may be accessed either as a tuple of (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax), or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on. @@ -259,6 +264,10 @@ See os.statvfs for more information.