1 r
"""OS routines for Mac, NT, or Posix depending on what system we're on.
4 - all functions from posix, nt, os2, mac, or ce, e.g. unlink, stat, etc.
5 - os.path is one of the modules posixpath, ntpath, or macpath
6 - os.name is 'posix', 'nt', 'os2', 'mac', 'ce' or 'riscos'
7 - os.curdir is a string representing the current directory ('.' or ':')
8 - os.pardir is a string representing the parent directory ('..' or '::')
9 - os.sep is the (or a most common) pathname separator ('/' or ':' or '\\')
10 - os.extsep is the extension separator ('.' or '/')
11 - os.altsep is the alternate pathname separator (None or '/')
12 - os.pathsep is the component separator used in $PATH etc
13 - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n')
14 - os.defpath is the default search path for executables
15 - os.devnull is the file path of the null device ('/dev/null', etc.)
17 Programs that import and use 'os' stand a better chance of being
18 portable between different platforms. Of course, they must then
19 only use functions that are defined by all platforms (e.g., unlink
20 and opendir), and leave all pathname manipulation to os.path
21 (e.g., split and join).
28 _names
= sys
.builtin_module_names
30 # Note: more names are added to __all__ later.
31 __all__
= ["altsep", "curdir", "pardir", "sep", "pathsep", "linesep",
32 "defpath", "name", "path", "devnull",
33 "SEEK_SET", "SEEK_CUR", "SEEK_END"]
35 def _get_exports_list(module
):
37 return list(module
.__all
__)
38 except AttributeError:
39 return [n
for n
in dir(module
) if n
[0] != '_']
46 from posix
import _exit
49 import posixpath
as path
52 __all__
.extend(_get_exports_list(posix
))
66 __all__
.extend(_get_exports_list(nt
))
77 if sys
.version
.find('EMX GCC') == -1:
80 import os2emxpath
as path
81 from _emx_link
import link
84 __all__
.extend(_get_exports_list(os2
))
95 import macpath
as path
98 __all__
.extend(_get_exports_list(mac
))
109 # We can use the standard Windows path.
110 import ntpath
as path
113 __all__
.extend(_get_exports_list(ce
))
116 elif 'riscos' in _names
:
121 from riscos
import _exit
124 import riscospath
as path
127 __all__
.extend(_get_exports_list(riscos
))
131 raise ImportError, 'no os specific module found'
133 sys
.modules
['os.path'] = path
134 from os
.path
import (curdir
, pardir
, sep
, pathsep
, defpath
, extsep
, altsep
,
139 # Python uses fixed values for the SEEK_ constants; they are mapped
140 # to native constants if necessary in posixmodule.c
147 # Super directory utilities.
148 # (Inspired by Eric Raymond; the doc strings are mostly his)
150 def makedirs(name
, mode
=0777):
151 """makedirs(path [, mode=0777])
153 Super-mkdir; create a leaf directory and all intermediate ones.
154 Works like mkdir, except that any intermediate path segment (not
155 just the rightmost) will be created if it does not exist. This is
159 from errno
import EEXIST
160 head
, tail
= path
.split(name
)
162 head
, tail
= path
.split(head
)
163 if head
and tail
and not path
.exists(head
):
167 # be happy if someone already created the path
168 if e
.errno
!= EEXIST
:
170 if tail
== curdir
: # xxx/newdir/. exists if xxx/newdir exists
174 def removedirs(name
):
177 Super-rmdir; remove a leaf directory and all empty intermediate
178 ones. Works like rmdir except that, if the leaf directory is
179 successfully removed, directories corresponding to rightmost path
180 segments will be pruned away until either the whole path is
181 consumed or an error occurs. Errors during this latter phase are
182 ignored -- they generally mean that a directory was not empty.
186 head
, tail
= path
.split(name
)
188 head
, tail
= path
.split(head
)
194 head
, tail
= path
.split(head
)
196 def renames(old
, new
):
199 Super-rename; create directories as necessary and delete any left
200 empty. Works like rename, except creation of any intermediate
201 directories needed to make the new pathname good is attempted
202 first. After the rename, directories corresponding to rightmost
203 path segments of the old name will be pruned way until either the
204 whole path is consumed or a nonempty directory is found.
206 Note: this function can fail with the new directory structure made
207 if you lack permissions needed to unlink the leaf directory or
211 head
, tail
= path
.split(new
)
212 if head
and tail
and not path
.exists(head
):
215 head
, tail
= path
.split(old
)
222 __all__
.extend(["makedirs", "removedirs", "renames"])
224 def walk(top
, topdown
=True, onerror
=None):
225 """Directory tree generator.
227 For each directory in the directory tree rooted at top (including top
228 itself, but excluding '.' and '..'), yields a 3-tuple
230 dirpath, dirnames, filenames
232 dirpath is a string, the path to the directory. dirnames is a list of
233 the names of the subdirectories in dirpath (excluding '.' and '..').
234 filenames is a list of the names of the non-directory files in dirpath.
235 Note that the names in the lists are just names, with no path components.
236 To get a full path (which begins with top) to a file or directory in
237 dirpath, do os.path.join(dirpath, name).
239 If optional arg 'topdown' is true or not specified, the triple for a
240 directory is generated before the triples for any of its subdirectories
241 (directories are generated top down). If topdown is false, the triple
242 for a directory is generated after the triples for all of its
243 subdirectories (directories are generated bottom up).
245 When topdown is true, the caller can modify the dirnames list in-place
246 (e.g., via del or slice assignment), and walk will only recurse into the
247 subdirectories whose names remain in dirnames; this can be used to prune
248 the search, or to impose a specific order of visiting. Modifying
249 dirnames when topdown is false is ineffective, since the directories in
250 dirnames have already been generated by the time dirnames itself is
253 By default errors from the os.listdir() call are ignored. If
254 optional arg 'onerror' is specified, it should be a function; it
255 will be called with one argument, an os.error instance. It can
256 report the error to continue with the walk, or raise the exception
257 to abort the walk. Note that the filename is available as the
258 filename attribute of the exception object.
260 Caution: if you pass a relative pathname for top, don't change the
261 current working directory between resumptions of walk. walk never
262 changes the current directory, and assumes that the client doesn't
267 from os.path import join, getsize
268 for root, dirs, files in walk('python/Lib/email'):
269 print root, "consumes",
270 print sum([getsize(join(root, name)) for name in files]),
271 print "bytes in", len(files), "non-directory files"
273 dirs.remove('CVS') # don't visit CVS directories
276 from os
.path
import join
, isdir
, islink
278 # We may not have read permission for top, in which case we can't
279 # get a list of the files the directory contains. os.path.walk
280 # always suppressed the exception then, rather than blow up for a
281 # minor reason when (say) a thousand readable directories are still
282 # left to visit. That logic is copied here.
284 # Note that listdir and error are globals in this module due
285 # to earlier import-*.
288 if onerror
is not None:
292 dirs
, nondirs
= [], []
294 if isdir(join(top
, name
)):
300 yield top
, dirs
, nondirs
302 path
= join(top
, name
)
304 for x
in walk(path
, topdown
, onerror
):
307 yield top
, dirs
, nondirs
309 __all__
.append("walk")
311 # Make sure os.environ exists, at least
317 def execl(file, *args
):
318 """execl(file, *args)
320 Execute the executable file with argument list args, replacing the
324 def execle(file, *args
):
325 """execle(file, *args, env)
327 Execute the executable file with argument list args and
328 environment env, replacing the current process. """
330 execve(file, args
[:-1], env
)
332 def execlp(file, *args
):
333 """execlp(file, *args)
335 Execute the executable file (which is searched for along $PATH)
336 with argument list args, replacing the current process. """
339 def execlpe(file, *args
):
340 """execlpe(file, *args, env)
342 Execute the executable file (which is searched for along $PATH)
343 with argument list args and environment env, replacing the current
346 execvpe(file, args
[:-1], env
)
348 def execvp(file, args
):
351 Execute the executable file (which is searched for along $PATH)
352 with argument list args, replacing the current process.
353 args may be a list or tuple of strings. """
356 def execvpe(file, args
, env
):
357 """execvpe(file, args, env)
359 Execute the executable file (which is searched for along $PATH)
360 with argument list args and environment env , replacing the
362 args may be a list or tuple of strings. """
363 _execvpe(file, args
, env
)
365 __all__
.extend(["execl","execle","execlp","execlpe","execvp","execvpe"])
367 def _execvpe(file, args
, env
=None):
368 from errno
import ENOENT
, ENOTDIR
372 argrest
= (args
, env
)
378 head
, tail
= path
.split(file)
383 envpath
= env
['PATH']
386 PATH
= envpath
.split(pathsep
)
390 fullname
= path
.join(dir, file)
392 func(fullname
, *argrest
)
394 tb
= sys
.exc_info()[2]
395 if (e
.errno
!= ENOENT
and e
.errno
!= ENOTDIR
396 and saved_exc
is None):
400 raise error
, saved_exc
, saved_tb
403 # Change environ to automatically call putenv() if it exists
405 # This will fail if there's no putenv
412 # Fake unsetenv() for Windows
413 # not sure about os2 here but
414 # I'm guessing they are the same.
416 if name
in ('os2', 'nt'):
421 # On RISC OS, all env access goes through getenv and putenv
422 from riscosenviron
import _Environ
423 elif name
in ('os2', 'nt'): # Where Env Var Names Must Be UPPERCASE
424 # But we store them as upper case
425 class _Environ(UserDict
.IterableUserDict
):
426 def __init__(self
, environ
):
427 UserDict
.UserDict
.__init
__(self
)
429 for k
, v
in environ
.items():
431 def __setitem__(self
, key
, item
):
433 self
.data
[key
.upper()] = item
434 def __getitem__(self
, key
):
435 return self
.data
[key
.upper()]
439 def __delitem__(self
, key
):
440 del self
.data
[key
.upper()]
442 def __delitem__(self
, key
):
444 del self
.data
[key
.upper()]
445 def has_key(self
, key
):
446 return key
.upper() in self
.data
447 def __contains__(self
, key
):
448 return key
.upper() in self
.data
449 def get(self
, key
, failobj
=None):
450 return self
.data
.get(key
.upper(), failobj
)
451 def update(self
, dict=None, **kwargs
):
455 except AttributeError:
456 # List of (key, value)
461 # cannot use items(), since mappings
470 else: # Where Env Var Names Can Be Mixed Case
471 class _Environ(UserDict
.IterableUserDict
):
472 def __init__(self
, environ
):
473 UserDict
.UserDict
.__init
__(self
)
475 def __setitem__(self
, key
, item
):
477 self
.data
[key
] = item
478 def update(self
, dict=None, **kwargs
):
482 except AttributeError:
483 # List of (key, value)
488 # cannot use items(), since mappings
499 def __delitem__(self
, key
):
506 environ
= _Environ(environ
)
508 def getenv(key
, default
=None):
509 """Get an environment variable, return None if it doesn't exist.
510 The optional second argument can specify an alternate default."""
511 return environ
.get(key
, default
)
512 __all__
.append("getenv")
521 # Supply spawn*() (probably only for Unix)
522 if _exists("fork") and not _exists("spawnv") and _exists("execv"):
525 P_NOWAIT
= P_NOWAITO
= 1
527 # XXX Should we support P_DETACH? I suppose it could fork()**2
528 # and close the std I/O streams. Also, P_OVERLAY is the same
531 def _spawnvef(mode
, file, args
, env
, func
):
532 # Internal helper; func is the exec*() function to use
540 func(file, args
, env
)
546 return pid
# Caller is responsible for waiting!
548 wpid
, sts
= waitpid(pid
, 0)
551 elif WIFSIGNALED(sts
):
552 return -WTERMSIG(sts
)
554 return WEXITSTATUS(sts
)
556 raise error
, "Not stopped, signaled or exited???"
558 def spawnv(mode
, file, args
):
559 """spawnv(mode, file, args) -> integer
561 Execute file with arguments from args in a subprocess.
562 If mode == P_NOWAIT return the pid of the process.
563 If mode == P_WAIT return the process's exit code if it exits normally;
564 otherwise return -SIG, where SIG is the signal that killed it. """
565 return _spawnvef(mode
, file, args
, None, execv
)
567 def spawnve(mode
, file, args
, env
):
568 """spawnve(mode, file, args, env) -> integer
570 Execute file with arguments from args in a subprocess with the
571 specified environment.
572 If mode == P_NOWAIT return the pid of the process.
573 If mode == P_WAIT return the process's exit code if it exits normally;
574 otherwise return -SIG, where SIG is the signal that killed it. """
575 return _spawnvef(mode
, file, args
, env
, execve
)
577 # Note: spawnvp[e] is't currently supported on Windows
579 def spawnvp(mode
, file, args
):
580 """spawnvp(mode, file, args) -> integer
582 Execute file (which is looked for along $PATH) with arguments from
583 args in a subprocess.
584 If mode == P_NOWAIT return the pid of the process.
585 If mode == P_WAIT return the process's exit code if it exits normally;
586 otherwise return -SIG, where SIG is the signal that killed it. """
587 return _spawnvef(mode
, file, args
, None, execvp
)
589 def spawnvpe(mode
, file, args
, env
):
590 """spawnvpe(mode, file, args, env) -> integer
592 Execute file (which is looked for along $PATH) with arguments from
593 args in a subprocess with the supplied environment.
594 If mode == P_NOWAIT return the pid of the process.
595 If mode == P_WAIT return the process's exit code if it exits normally;
596 otherwise return -SIG, where SIG is the signal that killed it. """
597 return _spawnvef(mode
, file, args
, env
, execvpe
)
599 if _exists("spawnv"):
600 # These aren't supplied by the basic Windows code
601 # but can be easily implemented in Python
603 def spawnl(mode
, file, *args
):
604 """spawnl(mode, file, *args) -> integer
606 Execute file with arguments from args in a subprocess.
607 If mode == P_NOWAIT return the pid of the process.
608 If mode == P_WAIT return the process's exit code if it exits normally;
609 otherwise return -SIG, where SIG is the signal that killed it. """
610 return spawnv(mode
, file, args
)
612 def spawnle(mode
, file, *args
):
613 """spawnle(mode, file, *args, env) -> integer
615 Execute file with arguments from args in a subprocess with the
616 supplied environment.
617 If mode == P_NOWAIT return the pid of the process.
618 If mode == P_WAIT return the process's exit code if it exits normally;
619 otherwise return -SIG, where SIG is the signal that killed it. """
621 return spawnve(mode
, file, args
[:-1], env
)
624 __all__
.extend(["spawnv", "spawnve", "spawnl", "spawnle",])
627 if _exists("spawnvp"):
628 # At the moment, Windows doesn't implement spawnvp[e],
629 # so it won't have spawnlp[e] either.
630 def spawnlp(mode
, file, *args
):
631 """spawnlp(mode, file, *args) -> integer
633 Execute file (which is looked for along $PATH) with arguments from
634 args in a subprocess with the supplied environment.
635 If mode == P_NOWAIT return the pid of the process.
636 If mode == P_WAIT return the process's exit code if it exits normally;
637 otherwise return -SIG, where SIG is the signal that killed it. """
638 return spawnvp(mode
, file, args
)
640 def spawnlpe(mode
, file, *args
):
641 """spawnlpe(mode, file, *args, env) -> integer
643 Execute file (which is looked for along $PATH) with arguments from
644 args in a subprocess with the supplied environment.
645 If mode == P_NOWAIT return the pid of the process.
646 If mode == P_WAIT return the process's exit code if it exits normally;
647 otherwise return -SIG, where SIG is the signal that killed it. """
649 return spawnvpe(mode
, file, args
[:-1], env
)
652 __all__
.extend(["spawnvp", "spawnvpe", "spawnlp", "spawnlpe",])
655 # Supply popen2 etc. (for Unix)
657 if not _exists("popen2"):
658 def popen2(cmd
, mode
="t", bufsize
=-1):
659 """Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd'
660 may be a sequence, in which case arguments will be passed directly to
661 the program without shell intervention (as with os.spawnv()). If 'cmd'
662 is a string it will be passed to the shell (as with os.system()). If
663 'bufsize' is specified, it sets the buffer size for the I/O pipes. The
664 file objects (child_stdin, child_stdout) are returned."""
666 stdout
, stdin
= popen2
.popen2(cmd
, bufsize
)
668 __all__
.append("popen2")
670 if not _exists("popen3"):
671 def popen3(cmd
, mode
="t", bufsize
=-1):
672 """Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd'
673 may be a sequence, in which case arguments will be passed directly to
674 the program without shell intervention (as with os.spawnv()). If 'cmd'
675 is a string it will be passed to the shell (as with os.system()). If
676 'bufsize' is specified, it sets the buffer size for the I/O pipes. The
677 file objects (child_stdin, child_stdout, child_stderr) are returned."""
679 stdout
, stdin
, stderr
= popen2
.popen3(cmd
, bufsize
)
680 return stdin
, stdout
, stderr
681 __all__
.append("popen3")
683 if not _exists("popen4"):
684 def popen4(cmd
, mode
="t", bufsize
=-1):
685 """Execute the shell command 'cmd' in a sub-process. On UNIX, 'cmd'
686 may be a sequence, in which case arguments will be passed directly to
687 the program without shell intervention (as with os.spawnv()). If 'cmd'
688 is a string it will be passed to the shell (as with os.system()). If
689 'bufsize' is specified, it sets the buffer size for the I/O pipes. The
690 file objects (child_stdin, child_stdout_stderr) are returned."""
692 stdout
, stdin
= popen2
.popen4(cmd
, bufsize
)
694 __all__
.append("popen4")
696 import copy_reg
as _copy_reg
698 def _make_stat_result(tup
, dict):
699 return stat_result(tup
, dict)
701 def _pickle_stat_result(sr
):
702 (type, args
) = sr
.__reduce
__()
703 return (_make_stat_result
, args
)
706 _copy_reg
.pickle(stat_result
, _pickle_stat_result
, _make_stat_result
)
707 except NameError: # stat_result may not exist
710 def _make_statvfs_result(tup
, dict):
711 return statvfs_result(tup
, dict)
713 def _pickle_statvfs_result(sr
):
714 (type, args
) = sr
.__reduce
__()
715 return (_make_statvfs_result
, args
)
718 _copy_reg
.pickle(statvfs_result
, _pickle_statvfs_result
,
719 _make_statvfs_result
)
720 except NameError: # statvfs_result may not exist
723 if not _exists("urandom"):
727 Return a string of n random bytes suitable for cryptographic use.
731 _urandomfd
= open("/dev/urandom", O_RDONLY
)
732 except (OSError, IOError):
733 raise NotImplementedError("/dev/urandom (or equivalent) not found")
735 while len(bytes
) < n
:
736 bytes
+= read(_urandomfd
, n
- len(bytes
))