[Python-checkins] CVS: python/dist/src/Lib dospath.py,1.10,1.11 filecmp.py,1.2,1.3 fpformat.py,1.6,1.7 gopherlib.py,1.5,1.6 gzip.py,1.15,1.16 htmlentitydefs.py,1.4,1.5 imghdr.py,1.8,1.9 keyword.py,1.7,1.8 linecache.py,1.4,1.5 macpath.py,1.20,1.21 mailcap.py,1.4,1.5 mhlib.py,1.18,1.19 mimetools.py,1.15,1.16 mimify.py,1.13,1.14 multifile.py,1.8,1.9 mutex.py,1.5,1.6 netrc.py,1.3,1.4 nntplib.py,1.16,1.17 nturl2path.py,1.4,1.5 os.py,1.28,1.29 pdb.py,1.40,1.41 pickle.py,1.35,1.36 pipes.py,1.4,1.5 popen2.py,1.8,1.9 posixfile.py,1.12,1.13 posixpath.py,1.26,1.27 profile.py,1.21,1.22 pstats.py,1.6,1.7 pty.py,1.2,1.3 py_compile.py,1.14,1.15
Guido van Rossum
guido@cnri.reston.va.us
Fri, 4 Feb 2000 10:10:40 -0500 (EST)
- Previous message: [Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.56.2.7,1.56.2.8
- Next message: [Python-checkins] CVS: python/dist/src/Lib quopri.py,1.5,1.6 random.py,1.12,1.13 regex_syntax.py,1.2,1.3 regsub.py,1.6,1.7 repr.py,1.5,1.6 sgmllib.py,1.18,1.19 shlex.py,1.4,1.5 shutil.py,1.14,1.15 stat.py,1.6,1.7 statcache.py,1.5,1.6 statvfs.py,1.3,1.4 string.py,1.45,1.46 sunau.py,1.14,1.15 sunaudio.py,1.3,1.4 symbol.py,1.8,1.9 tempfile.py,1.19,1.20 threading.py,1.5,1.6 toaiff.py,1.4,1.5 token.py,1.6,1.7 traceback.py,1.13,1.14 tty.py,1.1,1.2 types.py,1.12,1.13 tzparse.py,1.6,1.7 urllib.py,1.90,1.91 urllib2.py,1.1,1.2 urlparse.py,1.21,1.22 uu.py,1.10,1.11 wave.py,1.8,1.9 whrandom.py,1.14,1.15
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /projects/cvsroot/python/dist/src/Lib
In directory eric:/projects/python/develop/guido/src/Lib
Modified Files:
dospath.py filecmp.py fpformat.py gopherlib.py gzip.py
htmlentitydefs.py imghdr.py keyword.py linecache.py macpath.py
mailcap.py mhlib.py mimetools.py mimify.py multifile.py
mutex.py netrc.py nntplib.py nturl2path.py os.py pdb.py
pickle.py pipes.py popen2.py posixfile.py posixpath.py
profile.py pstats.py pty.py py_compile.py
Log Message:
More trivial comment -> docstring transformations by Ka-Ping Yee,
who writes:
Here is batch 2, as a big collection of CVS context diffs.
Along with moving comments into docstrings, i've added a
couple of missing docstrings and attempted to make sure more
module docstrings begin with a one-line summary.
I did not add docstrings to the methods in profile.py for
fear of upsetting any careful optimizations there, though
i did move class documentation into class docstrings.
The convention i'm using is to leave credits/version/copyright
type of stuff in # comments, and move the rest of the descriptive
stuff about module usage into module docstrings. Hope this is
okay.
Index: dospath.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/dospath.py,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** dospath.py 1999/03/19 21:05:12 1.10
--- dospath.py 2000/02/04 15:10:32 1.11
***************
*** 1,3 ****
! # Module 'dospath' -- common operations on DOS pathnames
import os
--- 1,3 ----
! """Module 'dospath' -- common operations on DOS pathnames"""
import os
***************
*** 6,63 ****
- # Normalize the case of a pathname.
- # On MS-DOS it maps the pathname to lowercase, turns slashes into
- # backslashes.
- # Other normalizations (such as optimizing '../' away) are not allowed
- # (this is done by normpath).
- # Previously, this version mapped invalid consecutive characters to a
- # single '_', but this has been removed. This functionality should
- # possibly be added as a new function.
-
def normcase(s):
! return string.lower(string.replace(s, "/", "\\"))
- # Return wheter a path is absolute.
- # Trivial in Posix, harder on the Mac or MS-DOS.
- # For DOS it is absolute if it starts with a slash or backslash (current
- # volume), or if a pathname after the volume letter and colon starts with
- # a slash or backslash.
def isabs(s):
! s = splitdrive(s)[1]
! return s != '' and s[:1] in '/\\'
- # Join two (or more) paths.
def join(a, *p):
! path = a
! for b in p:
! if isabs(b):
! path = b
! elif path == '' or path[-1:] in '/\\':
! path = path + b
! else:
! path = path + os.sep + b
! return path
- # Split a path in a drive specification (a drive letter followed by a
- # colon) and the path specification.
- # It is always true that drivespec + pathspec == p
def splitdrive(p):
! if p[1:2] == ':':
! return p[0:2], p[2:]
! return '', p
!
- # Split a path in head (everything up to the last '/') and tail (the
- # rest). After the trailing '/' is stripped, the invariant
- # join(head, tail) == p holds.
- # The resulting head won't end in '/' unless it is the root.
def split(p):
d, p = splitdrive(p)
# set i to index beyond p's last slash
--- 6,63 ----
def normcase(s):
! """Normalize the case of a pathname.
! On MS-DOS it maps the pathname to lowercase, turns slashes into
! backslashes.
! Other normalizations (such as optimizing '../' away) are not allowed
! (this is done by normpath).
! Previously, this version mapped invalid consecutive characters to a
! single '_', but this has been removed. This functionality should
! possibly be added as a new function."""
+ return string.lower(string.replace(s, "/", "\\"))
def isabs(s):
! """Return whether a path is absolute.
! Trivial in Posix, harder on the Mac or MS-DOS.
! For DOS it is absolute if it starts with a slash or backslash (current
! volume), or if a pathname after the volume letter and colon starts with
! a slash or backslash."""
+ s = splitdrive(s)[1]
+ return s != '' and s[:1] in '/\\'
def join(a, *p):
! """Join two (or more) paths."""
+ path = a
+ for b in p:
+ if isabs(b):
+ path = b
+ elif path == '' or path[-1:] in '/\\':
+ path = path + b
+ else:
+ path = path + os.sep + b
+ return path
def splitdrive(p):
! """Split a path into a drive specification (a drive letter followed
! by a colon) and path specification.
! It is always true that drivespec + pathspec == p."""
!
! if p[1:2] == ':':
! return p[0:2], p[2:]
! return '', p
def split(p):
+ """Split a path into head (everything up to the last '/') and tail
+ (the rest). After the trailing '/' is stripped, the invariant
+ join(head, tail) == p holds.
+ The resulting head won't end in '/' unless it is the root."""
+
d, p = splitdrive(p)
# set i to index beyond p's last slash
***************
*** 74,118 ****
- # Split a path in root and extension.
- # The extension is everything starting at the first dot in the last
- # pathname component; the root is everything before that.
- # It is always true that root + ext == p.
-
def splitext(p):
! root, ext = '', ''
! for c in p:
! if c in '/\\':
! root, ext = root + ext + c, ''
! elif c == '.' or ext:
! ext = ext + c
! else:
! root = root + c
! return root, ext
!
- # Return the tail (basename) part of a path.
def basename(p):
! return split(p)[1]
- # Return the head (dirname) part of a path.
def dirname(p):
! return split(p)[0]
- # Return the longest prefix of all list elements.
def commonprefix(m):
! if not m: return ''
! prefix = m[0]
! for item in m:
! for i in range(len(prefix)):
! if prefix[:i+1] <> item[:i+1]:
! prefix = prefix[:i]
! if i == 0: return ''
! break
! return prefix
--- 74,118 ----
def splitext(p):
! """Split a path into root and extension.
! The extension is everything starting at the first dot in the last
! pathname component; the root is everything before that.
! It is always true that root + ext == p."""
!
! root, ext = '', ''
! for c in p:
! if c in '/\\':
! root, ext = root + ext + c, ''
! elif c == '.' or ext:
! ext = ext + c
! else:
! root = root + c
! return root, ext
def basename(p):
! """Return the tail (basename) part of a path."""
+ return split(p)[1]
def dirname(p):
! """Return the head (dirname) part of a path."""
+ return split(p)[0]
def commonprefix(m):
! """Return the longest prefix of all list elements."""
!
! if not m: return ''
! prefix = m[0]
! for item in m:
! for i in range(len(prefix)):
! if prefix[:i+1] <> item[:i+1]:
! prefix = prefix[:i]
! if i == 0: return ''
! break
! return prefix
***************
*** 135,332 ****
- # Is a path a symbolic link?
- # This will always return false on systems where posix.lstat doesn't exist.
-
def islink(path):
! return 0
- # Does a path exist?
- # This is false for dangling symbolic links.
def exists(path):
! try:
! st = os.stat(path)
! except os.error:
! return 0
! return 1
- # Is a path a dos directory?
- # This follows symbolic links, so both islink() and isdir() can be true
- # for the same path.
def isdir(path):
! try:
! st = os.stat(path)
! except os.error:
! return 0
! return stat.S_ISDIR(st[stat.ST_MODE])
- # Is a path a regular file?
- # This follows symbolic links, so both islink() and isdir() can be true
- # for the same path.
def isfile(path):
! try:
! st = os.stat(path)
! except os.error:
! return 0
! return stat.S_ISREG(st[stat.ST_MODE])
- # Is a path a mount point?
- # XXX This degenerates in: 'is this the root?' on DOS
def ismount(path):
! return isabs(splitdrive(path)[1])
- # Directory tree walk.
- # For each directory under top (including top itself, but excluding
- # '.' and '..'), func(arg, dirname, filenames) is called, where
- # dirname is the name of the directory and filenames is the list
- # files files (and subdirectories etc.) in the directory.
- # The func may modify the filenames list, to implement a filter,
- # or to impose a different order of visiting.
def walk(top, func, arg):
! try:
! names = os.listdir(top)
! except os.error:
! return
! func(arg, top, names)
! exceptions = ('.', '..')
! for name in names:
! if name not in exceptions:
! name = join(top, name)
! if isdir(name):
! walk(name, func, arg)
!
!
! # Expand paths beginning with '~' or '~user'.
! # '~' means $HOME; '~user' means that user's home directory.
! # If the path doesn't begin with '~', or if the user or $HOME is unknown,
! # the path is returned unchanged (leaving error reporting to whatever
! # function is called with the expanded path as argument).
! # See also module 'glob' for expansion of *, ? and [...] in pathnames.
! # (A function should also be defined to do full *sh-style environment
! # variable expansion.)
def expanduser(path):
! if path[:1] <> '~':
! return path
! i, n = 1, len(path)
! while i < n and path[i] not in '/\\':
! i = i+1
! if i == 1:
! if not os.environ.has_key('HOME'):
! return path
! userhome = os.environ['HOME']
! else:
! return path
! return userhome + path[i:]
!
!
! # Expand paths containing shell variable substitutions.
! # The following rules apply:
! # - no expansion within single quotes
! # - no escape character, except for '$$' which is translated into '$'
! # - ${varname} is accepted.
! # - varnames can be made out of letters, digits and the character '_'
! # XXX With COMMAND.COM you can use any characters in a variable name,
! # XXX except '^|<>='.
varchars = string.letters + string.digits + '_-'
def expandvars(path):
! if '$' not in path:
! return path
! res = ''
! index = 0
! pathlen = len(path)
! while index < pathlen:
! c = path[index]
! if c == '\'': # no expansion within single quotes
! path = path[index + 1:]
! pathlen = len(path)
! try:
! index = string.index(path, '\'')
! res = res + '\'' + path[:index + 1]
! except string.index_error:
! res = res + path
! index = pathlen -1
! elif c == '$': # variable or '$$'
! if path[index + 1:index + 2] == '$':
! res = res + c
! index = index + 1
! elif path[index + 1:index + 2] == '{':
! path = path[index+2:]
! pathlen = len(path)
! try:
! index = string.index(path, '}')
! var = path[:index]
! if os.environ.has_key(var):
! res = res + os.environ[var]
! except string.index_error:
! res = res + path
! index = pathlen - 1
! else:
! var = ''
! index = index + 1
! c = path[index:index + 1]
! while c != '' and c in varchars:
! var = var + c
! index = index + 1
! c = path[index:index + 1]
! if os.environ.has_key(var):
! res = res + os.environ[var]
! if c != '':
! res = res + c
! else:
! res = res + c
! index = index + 1
! return res
- # Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A/B.
- # Also, components of the path are silently truncated to 8+3 notation.
-
def normpath(path):
! path = string.replace(path, "/", "\\")
! prefix, path = splitdrive(path)
! while path[:1] == os.sep:
! prefix = prefix + os.sep
! path = path[1:]
! comps = string.splitfields(path, os.sep)
! i = 0
! while i < len(comps):
! if comps[i] == '.':
! del comps[i]
! elif comps[i] == '..' and i > 0 and \
! comps[i-1] not in ('', '..'):
! del comps[i-1:i+1]
! i = i-1
! elif comps[i] == '' and i > 0 and comps[i-1] <> '':
! del comps[i]
! elif '.' in comps[i]:
! comp = string.splitfields(comps[i], '.')
! comps[i] = comp[0][:8] + '.' + comp[1][:3]
! i = i+1
! elif len(comps[i]) > 8:
! comps[i] = comps[i][:8]
! i = i+1
! else:
! i = i+1
! # If the path is now empty, substitute '.'
! if not prefix and not comps:
! comps.append('.')
! return prefix + string.joinfields(comps, os.sep)
- # Return an absolute path.
def abspath(path):
if not isabs(path):
path = join(os.getcwd(), path)
--- 135,328 ----
def islink(path):
! """Is a path a symbolic link?
! This will always return false on systems where posix.lstat doesn't exist."""
+ return 0
def exists(path):
! """Does a path exist?
! This is false for dangling symbolic links."""
+ try:
+ st = os.stat(path)
+ except os.error:
+ return 0
+ return 1
def isdir(path):
! """Is a path a dos directory?"""
+ try:
+ st = os.stat(path)
+ except os.error:
+ return 0
+ return stat.S_ISDIR(st[stat.ST_MODE])
def isfile(path):
! """Is a path a regular file?"""
+ try:
+ st = os.stat(path)
+ except os.error:
+ return 0
+ return stat.S_ISREG(st[stat.ST_MODE])
def ismount(path):
! """Is a path a mount point?"""
! # XXX This degenerates in: 'is this the root?' on DOS
+ return isabs(splitdrive(path)[1])
def walk(top, func, arg):
! """Directory tree walk.
! For each directory under top (including top itself, but excluding
! '.' and '..'), func(arg, dirname, filenames) is called, where
! dirname is the name of the directory and filenames is the list
! files files (and subdirectories etc.) in the directory.
! The func may modify the filenames list, to implement a filter,
! or to impose a different order of visiting."""
!
! try:
! names = os.listdir(top)
! except os.error:
! return
! func(arg, top, names)
! exceptions = ('.', '..')
! for name in names:
! if name not in exceptions:
! name = join(top, name)
! if isdir(name):
! walk(name, func, arg)
!
def expanduser(path):
! """Expand paths beginning with '~' or '~user'.
! '~' means $HOME; '~user' means that user's home directory.
! If the path doesn't begin with '~', or if the user or $HOME is unknown,
! the path is returned unchanged (leaving error reporting to whatever
! function is called with the expanded path as argument).
! See also module 'glob' for expansion of *, ? and [...] in pathnames.
! (A function should also be defined to do full *sh-style environment
! variable expansion.)"""
!
! if path[:1] <> '~':
! return path
! i, n = 1, len(path)
! while i < n and path[i] not in '/\\':
! i = i+1
! if i == 1:
! if not os.environ.has_key('HOME'):
! return path
! userhome = os.environ['HOME']
! else:
! return path
! return userhome + path[i:]
!
varchars = string.letters + string.digits + '_-'
def expandvars(path):
! """Expand paths containing shell variable substitutions.
! The following rules apply:
! - no expansion within single quotes
! - no escape character, except for '$$' which is translated into '$'
! - ${varname} is accepted.
! - varnames can be made out of letters, digits and the character '_'"""
! # XXX With COMMAND.COM you can use any characters in a variable name,
! # XXX except '^|<>='.
!
! if '$' not in path:
! return path
! res = ''
! index = 0
! pathlen = len(path)
! while index < pathlen:
! c = path[index]
! if c == '\'': # no expansion within single quotes
! path = path[index + 1:]
! pathlen = len(path)
! try:
! index = string.index(path, '\'')
! res = res + '\'' + path[:index + 1]
! except string.index_error:
! res = res + path
! index = pathlen -1
! elif c == '$': # variable or '$$'
! if path[index + 1:index + 2] == '$':
! res = res + c
! index = index + 1
! elif path[index + 1:index + 2] == '{':
! path = path[index+2:]
! pathlen = len(path)
! try:
! index = string.index(path, '}')
! var = path[:index]
! if os.environ.has_key(var):
! res = res + os.environ[var]
! except string.index_error:
! res = res + path
! index = pathlen - 1
! else:
! var = ''
! index = index + 1
! c = path[index:index + 1]
! while c != '' and c in varchars:
! var = var + c
! index = index + 1
! c = path[index:index + 1]
! if os.environ.has_key(var):
! res = res + os.environ[var]
! if c != '':
! res = res + c
! else:
! res = res + c
! index = index + 1
! return res
def normpath(path):
! """Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A/B.
! Also, components of the path are silently truncated to 8+3 notation."""
!
! path = string.replace(path, "/", "\\")
! prefix, path = splitdrive(path)
! while path[:1] == os.sep:
! prefix = prefix + os.sep
! path = path[1:]
! comps = string.splitfields(path, os.sep)
! i = 0
! while i < len(comps):
! if comps[i] == '.':
! del comps[i]
! elif comps[i] == '..' and i > 0 and \
! comps[i-1] not in ('', '..'):
! del comps[i-1:i+1]
! i = i-1
! elif comps[i] == '' and i > 0 and comps[i-1] <> '':
! del comps[i]
! elif '.' in comps[i]:
! comp = string.splitfields(comps[i], '.')
! comps[i] = comp[0][:8] + '.' + comp[1][:3]
! i = i+1
! elif len(comps[i]) > 8:
! comps[i] = comps[i][:8]
! i = i+1
! else:
! i = i+1
! # If the path is now empty, substitute '.'
! if not prefix and not comps:
! comps.append('.')
! return prefix + string.joinfields(comps, os.sep)
def abspath(path):
+ """Return an absolute path."""
if not isabs(path):
path = join(os.getcwd(), path)
Index: filecmp.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/filecmp.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** filecmp.py 2000/02/03 00:41:22 1.2
--- filecmp.py 2000/02/04 15:10:32 1.3
***************
*** 1,318 ****
! """Utilities for comparing files and directories.
! Classes:
! dircmp
- Functions:
- cmp(f1, f2, shallow=1, use_statcache=0) -> int
- cmpfiles(a, b, common) -> ([], [], [])
-
- """
-
- import os
- import stat
- import statcache
-
_cache = {}
BUFSIZE=8*1024
! def cmp(f1, f2, shallow=1,use_statcache=0):
! """Compare two files.
! Arguments:
! f1 -- First file name
! f2 -- Second file name
! shallow -- Just check stat signature (do not read the files).
! defaults to 1.
! use_statcache -- Do not stat() each file directly: go through
! the statcache module for more efficiency.
! Return value:
! integer -- 1 if the files are the same, 0 otherwise.
! This function uses a cache for past comparisons and the results,
! with a cache invalidation mechanism relying on stale signatures.
! Of course, if 'use_statcache' is true, this mechanism is defeated,
! and the cache will never grow stale.
! """
! stat_function = (os.stat, statcache.stat)[use_statcache]
! s1, s2 = _sig(stat_function(f1)), _sig(stat_function(f2))
! if s1[0]!=stat.S_IFREG or s2[0]!=stat.S_IFREG: return 0
! if shallow and s1 == s2: return 1
! if s1[1]!=s2[1]: return 0
! result = _cache.get((f1, f2))
! if result and (s1, s2)==result[:2]:
! return result[2]
! outcome = _do_cmp(f1, f2)
! _cache[f1, f2] = s1, s2, outcome
! return outcome
def _sig(st):
! return (stat.S_IFMT(st[stat.ST_MODE]),
! st[stat.ST_SIZE],
! st[stat.ST_MTIME])
def _do_cmp(f1, f2):
! bufsize = BUFSIZE
! fp1 , fp2 = open(f1, 'rb'), open(f2, 'rb')
! while 1:
! b1, b2 = fp1.read(bufsize), fp2.read(bufsize)
! if b1!=b2: return 0
! if not b1: return 1
!
! # Directory comparison class.
! #
! class dircmp:
! """A class that manages the comparison of 2 directories.
!
! dircmp(a,b,ignore=None,hide=None)
! A and B are directories.
! IGNORE is a list of names to ignore,
! defaults to ['RCS', 'CVS', 'tags'].
! HIDE is a list of names to hide,
! defaults to [os.curdir, os.pardir].
!
! High level usage:
! x = dircmp(dir1, dir2)
! x.report() -> prints a report on the differences between dir1 and dir2
! or
! x.report_partial_closure() -> prints report on differences between dir1
! and dir2, and reports on common immediate subdirectories.
! x.report_full_closure() -> like report_partial_closure,
! but fully recursive.
!
! Attributes:
! left_list, right_list: The files in dir1 and dir2,
! filtered by hide and ignore.
! common: a list of names in both dir1 and dir2.
! left_only, right_only: names only in dir1, dir2.
! common_dirs: subdirectories in both dir1 and dir2.
! common_files: files in both dir1 and dir2.
! common_funny: names in both dir1 and dir2 where the type differs between
! dir1 and dir2, or the name is not stat-able.
! same_files: list of identical files.
! diff_files: list of filenames which differ.
! funny_files: list of files which could not be compared.
! subdirs: a dictionary of dircmp objects, keyed by names in common_dirs.
! """
!
! def __init__(self, a, b, ignore=None, hide=None): # Initialize
! self.left = a
! self.right = b
! if hide is None:
! self.hide = [os.curdir, os.pardir] # Names never to be shown
! else:
! self.hide = hide
! if ignore is None:
! self.ignore = ['RCS', 'CVS', 'tags'] # Names ignored in comparison
! else:
! self.ignore = ignore
!
! def phase0(self): # Compare everything except common subdirectories
! self.left_list = _filter(os.listdir(self.left),
! self.hide+self.ignore)
! self.right_list = _filter(os.listdir(self.right),
! self.hide+self.ignore)
! self.left_list.sort()
! self.right_list.sort()
!
! __p4_attrs = ('subdirs',)
! __p3_attrs = ('same_files', 'diff_files', 'funny_files')
! __p2_attrs = ('common_dirs', 'common_files', 'common_funny')
! __p1_attrs = ('common', 'left_only', 'right_only')
! __p0_attrs = ('left_list', 'right_list')
!
! def __getattr__(self, attr):
! if attr in self.__p4_attrs:
! self.phase4()
! elif attr in self.__p3_attrs:
! self.phase3()
! elif attr in self.__p2_attrs:
! self.phase2()
! elif attr in self.__p1_attrs:
! self.phase1()
! elif attr in self.__p0_attrs:
! self.phase0()
! else:
! raise AttributeError, attr
! return getattr(self, attr)
!
! def phase1(self): # Compute common names
! a_only, b_only = [], []
! common = {}
! b = {}
! for fnm in self.right_list:
! b[fnm] = 1
! for x in self.left_list:
! if b.get(x, 0):
! common[x] = 1
! else:
! a_only.append(x)
! for x in self.right_list:
! if common.get(x, 0):
! pass
! else:
! b_only.append(x)
! self.common = common.keys()
! self.left_only = a_only
! self.right_only = b_only
!
! def phase2(self): # Distinguish files, directories, funnies
! self.common_dirs = []
! self.common_files = []
! self.common_funny = []
!
! for x in self.common:
! a_path = os.path.join(self.left, x)
! b_path = os.path.join(self.right, x)
!
! ok = 1
! try:
! a_stat = statcache.stat(a_path)
! except os.error, why:
! # print 'Can\'t stat', a_path, ':', why[1]
! ok = 0
! try:
! b_stat = statcache.stat(b_path)
! except os.error, why:
! # print 'Can\'t stat', b_path, ':', why[1]
! ok = 0
!
! if ok:
! a_type = stat.S_IFMT(a_stat[stat.ST_MODE])
! b_type = stat.S_IFMT(b_stat[stat.ST_MODE])
! if a_type <> b_type:
! self.common_funny.append(x)
! elif stat.S_ISDIR(a_type):
! self.common_dirs.append(x)
! elif stat.S_ISREG(a_type):
! self.common_files.append(x)
! else:
! self.common_funny.append(x)
! else:
! self.common_funny.append(x)
!
! def phase3(self): # Find out differences between common files
! xx = cmpfiles(self.left, self.right, self.common_files)
! self.same_files, self.diff_files, self.funny_files = xx
!
! def phase4(self): # Find out differences between common subdirectories
! # A new dircmp object is created for each common subdirectory,
! # these are stored in a dictionary indexed by filename.
! # The hide and ignore properties are inherited from the parent
! self.subdirs = {}
! for x in self.common_dirs:
! a_x = os.path.join(self.left, x)
! b_x = os.path.join(self.right, x)
! self.subdirs[x] = dircmp(a_x, b_x, self.ignore, self.hide)
!
! def phase4_closure(self): # Recursively call phase4() on subdirectories
! self.phase4()
! for x in self.subdirs.keys():
! self.subdirs[x].phase4_closure()
!
! def report(self): # Print a report on the differences between a and b
! # Output format is purposely lousy
! print 'diff', self.left, self.right
! if self.left_only:
! self.left_only.sort()
! print 'Only in', self.left, ':', self.left_only
! if self.right_only:
! self.right_only.sort()
! print 'Only in', self.right, ':', self.right_only
! if self.same_files:
! self.same_files.sort()
! print 'Identical files :', self.same_files
! if self.diff_files:
! self.diff_files.sort()
! print 'Differing files :', self.diff_files
! if self.funny_files:
! self.funny_files.sort()
! print 'Trouble with common files :', self.funny_files
! if self.common_dirs:
! self.common_dirs.sort()
! print 'Common subdirectories :', self.common_dirs
! if self.common_funny:
! self.common_funny.sort()
! print 'Common funny cases :', self.common_funny
!
! def report_partial_closure(self): # Print reports on self and on subdirs
! self.report()
! for x in self.subdirs.keys():
! print
! self.subdirs[x].report()
!
! def report_full_closure(self): # Report on self and subdirs recursively
! self.report()
! for x in self.subdirs.keys():
! print
! self.subdirs[x].report_full_closure()
!
!
! # Compare common files in two directories.
! # Return:
! # - files that compare equal
! # - files that compare different
! # - funny cases (can't stat etc.)
! #
! def cmpfiles(a, b, common):
! """Compare common files in two directories.
!
! cmpfiles(a,b,common)
! A and B are directory names
! COMMON is a list of file names
! returns a tuple of three lists:
! files that compare equal
! files that are different
! filenames that aren't regular files."""
!
! res = ([], [], [])
! for x in common:
! res[_cmp(os.path.join(a, x), os.path.join(b, x))].append(x)
! return res
!
!
! # Compare two files.
! # Return:
! # 0 for equal
! # 1 for different
! # 2 for funny cases (can't stat, etc.)
! #
! def _cmp(a, b):
! try:
! return not abs(cmp(a, b))
! except os.error:
! return 2
!
!
! # Return a copy with items that occur in skip removed.
! #
! def _filter(list, skip):
! result = []
! for item in list:
! if item not in skip: result.append(item)
! return result
!
!
! # Demonstration and testing.
! #
! def demo():
! import sys
! import getopt
! options, args = getopt.getopt(sys.argv[1:], 'r')
! if len(args) <> 2: raise getopt.error, 'need exactly two args'
! dd = dircmp(args[0], args[1])
! if ('-r', '') in options:
! dd.report_full_closure()
! else:
! dd.report()
!
! if __name__ == '__main__':
! demo()
--- 1,57 ----
! """Compare files."""
! import os, stat, statcache
_cache = {}
BUFSIZE=8*1024
! def cmp(f1, f2, shallow=1,use_statcache=0):
! """Compare two files.
! Arguments:
! f1 -- First file name
! f2 -- Second file name
! shallow -- Just check stat signature (do not read the files).
! defaults to 1.
! use_statcache -- Do not stat() each file directly: go through
! the statcache module for more efficiency.
! Return value:
! integer -- 1 if the files are the same, 0 otherwise.
! This function uses a cache for past comparisons and the results,
! with a cache invalidation mechanism relying on stale signatures.
! Of course, if 'use_statcache' is true, this mechanism is defeated,
! and the cache will never grow stale.
! """
! stat_function = (os.stat, statcache.stat)[use_statcache]
! s1, s2 = _sig(stat_function(f1)), _sig(stat_function(f2))
! if s1[0]!=stat.S_IFREG or s2[0]!=stat.S_IFREG: return 0
! if shallow and s1 == s2: return 1
! if s1[1]!=s2[1]: return 0
! result = _cache.get((f1, f2))
! if result and (s1, s2)==result[:2]:
! return result[2]
! outcome = _do_cmp(f1, f2)
! _cache[f1, f2] = s1, s2, outcome
! return outcome
def _sig(st):
! return (stat.S_IFMT(st[stat.ST_MODE]),
! st[stat.ST_SIZE],
! st[stat.ST_MTIME])
def _do_cmp(f1, f2):
! bufsize = BUFSIZE
! fp1 , fp2 = open(f1, 'rb'), open(f2, 'rb')
! while 1:
! b1, b2 = fp1.read(bufsize), fp2.read(bufsize)
! if b1!=b2: return 0
! if not b1: return 1
Index: fpformat.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/fpformat.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** fpformat.py 2000/02/02 15:10:13 1.6
--- fpformat.py 2000/02/04 15:10:32 1.7
***************
*** 23,141 ****
try:
! class NotANumber(ValueError):
! pass
except TypeError:
! NotANumber = 'fpformat.NotANumber'
- # Return (sign, intpart, fraction, expo) or raise an exception:
- # sign is '+' or '-'
- # intpart is 0 or more digits beginning with a nonzero
- # fraction is 0 or more digits
- # expo is an integer
def extract(s):
! res = decoder.match(s)
! if res is None: raise NotANumber, s
! sign, intpart, fraction, exppart = res.group(1,2,3,4)
! if sign == '+': sign = ''
! if fraction: fraction = fraction[1:]
! if exppart: expo = int(exppart[1:])
! else: expo = 0
! return sign, intpart, fraction, expo
- # Remove the exponent by changing intpart and fraction
def unexpo(intpart, fraction, expo):
! if expo > 0: # Move the point left
! f = len(fraction)
! intpart, fraction = intpart + fraction[:expo], fraction[expo:]
! if expo > f:
! intpart = intpart + '0'*(expo-f)
! elif expo < 0: # Move the point right
! i = len(intpart)
! intpart, fraction = intpart[:expo], intpart[expo:] + fraction
! if expo < -i:
! fraction = '0'*(-expo-i) + fraction
! return intpart, fraction
- # Round or extend the fraction to size digs
def roundfrac(intpart, fraction, digs):
! f = len(fraction)
! if f <= digs:
! return intpart, fraction + '0'*(digs-f)
! i = len(intpart)
! if i+digs < 0:
! return '0'*-digs, ''
! total = intpart + fraction
! nextdigit = total[i+digs]
! if nextdigit >= '5': # Hard case: increment last digit, may have carry!
! n = i + digs - 1
! while n >= 0:
! if total[n] != '9': break
! n = n-1
! else:
! total = '0' + total
! i = i+1
! n = 0
! total = total[:n] + chr(ord(total[n]) + 1) + '0'*(len(total)-n-1)
! intpart, fraction = total[:i], total[i:]
! if digs >= 0:
! return intpart, fraction[:digs]
! else:
! return intpart[:digs] + '0'*-digs, ''
!
! # Format x as [-]ddd.ddd with 'digs' digits after the point
! # and at least one digit before.
! # If digs <= 0, the point is suppressed.
def fix(x, digs):
! if type(x) != type(''): x = `x`
! try:
! sign, intpart, fraction, expo = extract(x)
! except NotANumber:
! return x
! intpart, fraction = unexpo(intpart, fraction, expo)
! intpart, fraction = roundfrac(intpart, fraction, digs)
! while intpart and intpart[0] == '0': intpart = intpart[1:]
! if intpart == '': intpart = '0'
! if digs > 0: return sign + intpart + '.' + fraction
! else: return sign + intpart
!
! # Format x as [-]d.dddE[+-]ddd with 'digs' digits after the point
! # and exactly one digit before.
! # If digs is <= 0, one digit is kept and the point is suppressed.
def sci(x, digs):
! if type(x) != type(''): x = `x`
! sign, intpart, fraction, expo = extract(x)
! if not intpart:
! while fraction and fraction[0] == '0':
! fraction = fraction[1:]
! expo = expo - 1
! if fraction:
! intpart, fraction = fraction[0], fraction[1:]
! expo = expo - 1
! else:
! intpart = '0'
! else:
! expo = expo + len(intpart) - 1
! intpart, fraction = intpart[0], intpart[1:] + fraction
! digs = max(0, digs)
! intpart, fraction = roundfrac(intpart, fraction, digs)
! if len(intpart) > 1:
! intpart, fraction, expo = \
! intpart[0], intpart[1:] + fraction[:-1], \
! expo + len(intpart) - 1
! s = sign + intpart
! if digs > 0: s = s + '.' + fraction
! e = `abs(expo)`
! e = '0'*(3-len(e)) + e
! if expo < 0: e = '-' + e
! else: e = '+' + e
! return s + 'e' + e
- # Interactive test run
def test():
! try:
! while 1:
! x, digs = input('Enter (x, digs): ')
! print x, fix(x, digs), sci(x, digs)
! except (EOFError, KeyboardInterrupt):
! pass
--- 23,141 ----
try:
! class NotANumber(ValueError):
! pass
except TypeError:
! NotANumber = 'fpformat.NotANumber'
def extract(s):
! """Return (sign, intpart, fraction, expo) or raise an exception:
! sign is '+' or '-'
! intpart is 0 or more digits beginning with a nonzero
! fraction is 0 or more digits
! expo is an integer"""
! res = decoder.match(s)
! if res is None: raise NotANumber, s
! sign, intpart, fraction, exppart = res.group(1,2,3,4)
! if sign == '+': sign = ''
! if fraction: fraction = fraction[1:]
! if exppart: expo = int(exppart[1:])
! else: expo = 0
! return sign, intpart, fraction, expo
def unexpo(intpart, fraction, expo):
! """Remove the exponent by changing intpart and fraction."""
! if expo > 0: # Move the point left
! f = len(fraction)
! intpart, fraction = intpart + fraction[:expo], fraction[expo:]
! if expo > f:
! intpart = intpart + '0'*(expo-f)
! elif expo < 0: # Move the point right
! i = len(intpart)
! intpart, fraction = intpart[:expo], intpart[expo:] + fraction
! if expo < -i:
! fraction = '0'*(-expo-i) + fraction
! return intpart, fraction
def roundfrac(intpart, fraction, digs):
! """Round or extend the fraction to size digs."""
! f = len(fraction)
! if f <= digs:
! return intpart, fraction + '0'*(digs-f)
! i = len(intpart)
! if i+digs < 0:
! return '0'*-digs, ''
! total = intpart + fraction
! nextdigit = total[i+digs]
! if nextdigit >= '5': # Hard case: increment last digit, may have carry!
! n = i + digs - 1
! while n >= 0:
! if total[n] != '9': break
! n = n-1
! else:
! total = '0' + total
! i = i+1
! n = 0
! total = total[:n] + chr(ord(total[n]) + 1) + '0'*(len(total)-n-1)
! intpart, fraction = total[:i], total[i:]
! if digs >= 0:
! return intpart, fraction[:digs]
! else:
! return intpart[:digs] + '0'*-digs, ''
!
def fix(x, digs):
! """Format x as [-]ddd.ddd with 'digs' digits after the point
! and at least one digit before.
! If digs <= 0, the point is suppressed."""
! if type(x) != type(''): x = `x`
! try:
! sign, intpart, fraction, expo = extract(x)
! except NotANumber:
! return x
! intpart, fraction = unexpo(intpart, fraction, expo)
! intpart, fraction = roundfrac(intpart, fraction, digs)
! while intpart and intpart[0] == '0': intpart = intpart[1:]
! if intpart == '': intpart = '0'
! if digs > 0: return sign + intpart + '.' + fraction
! else: return sign + intpart
!
def sci(x, digs):
! """Format x as [-]d.dddE[+-]ddd with 'digs' digits after the point
! and exactly one digit before.
! If digs is <= 0, one digit is kept and the point is suppressed."""
! if type(x) != type(''): x = `x`
! sign, intpart, fraction, expo = extract(x)
! if not intpart:
! while fraction and fraction[0] == '0':
! fraction = fraction[1:]
! expo = expo - 1
! if fraction:
! intpart, fraction = fraction[0], fraction[1:]
! expo = expo - 1
! else:
! intpart = '0'
! else:
! expo = expo + len(intpart) - 1
! intpart, fraction = intpart[0], intpart[1:] + fraction
! digs = max(0, digs)
! intpart, fraction = roundfrac(intpart, fraction, digs)
! if len(intpart) > 1:
! intpart, fraction, expo = \
! intpart[0], intpart[1:] + fraction[:-1], \
! expo + len(intpart) - 1
! s = sign + intpart
! if digs > 0: s = s + '.' + fraction
! e = `abs(expo)`
! e = '0'*(3-len(e)) + e
! if expo < 0: e = '-' + e
! else: e = '+' + e
! return s + 'e' + e
def test():
! """Interactive test run."""
! try:
! while 1:
! x, digs = input('Enter (x, digs): ')
! print x, fix(x, digs), sci(x, digs)
! except (EOFError, KeyboardInterrupt):
! pass
Index: gopherlib.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/gopherlib.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** gopherlib.py 1998/03/26 20:43:41 1.5
--- gopherlib.py 2000/02/04 15:10:32 1.6
***************
*** 1,3 ****
! # Gopher protocol client interface
import string
--- 1,3 ----
! """Gopher protocol client interface."""
import string
***************
*** 30,35 ****
A_QUERY = 'q'
A_GIF = 'g'
! A_HTML = 'h' # HTML file
! A_WWW = 'w' # WWW address
A_PLUS_IMAGE = ':'
A_PLUS_MOVIE = ';'
--- 30,35 ----
A_QUERY = 'q'
A_GIF = 'g'
! A_HTML = 'h' # HTML file
! A_WWW = 'w' # WWW address
A_PLUS_IMAGE = ':'
A_PLUS_MOVIE = ';'
***************
*** 37,52 ****
- # Function mapping all file types to strings; unknown types become TYPE='x'
_names = dir()
_type_to_name_map = {}
def type_to_name(gtype):
! global _type_to_name_map
! if _type_to_name_map=={}:
! for name in _names:
! if name[:2] == 'A_':
! _type_to_name_map[eval(name)] = name[2:]
! if _type_to_name_map.has_key(gtype):
! return _type_to_name_map[gtype]
! return 'TYPE=' + `gtype`
# Names for characters and strings
--- 37,52 ----
_names = dir()
_type_to_name_map = {}
def type_to_name(gtype):
! """Map all file types to strings; unknown types become TYPE='x'."""
! global _type_to_name_map
! if _type_to_name_map=={}:
! for name in _names:
! if name[:2] == 'A_':
! _type_to_name_map[eval(name)] = name[2:]
! if _type_to_name_map.has_key(gtype):
! return _type_to_name_map[gtype]
! return 'TYPE=' + `gtype`
# Names for characters and strings
***************
*** 54,208 ****
TAB = '\t'
- # Send a selector to a given host and port, return a file with the reply
def send_selector(selector, host, port = 0):
! import socket
! import string
! if not port:
! i = string.find(host, ':')
! if i >= 0:
! host, port = host[:i], string.atoi(host[i+1:])
! if not port:
! port = DEF_PORT
! elif type(port) == type(''):
! port = string.atoi(port)
! s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
! s.connect(host, port)
! s.send(selector + CRLF)
! s.shutdown(1)
! return s.makefile('rb')
- # Send a selector and a query string
def send_query(selector, query, host, port = 0):
! return send_selector(selector + '\t' + query, host, port)
- # Takes a path as returned by urlparse and returns the appropriate selector
def path_to_selector(path):
! if path=="/":
! return "/"
! else:
! return path[2:] # Cuts initial slash and data type identifier
- # Takes a path as returned by urlparse and maps it to a string
- # See section 3.4 of RFC 1738 for details
def path_to_datatype_name(path):
! if path=="/":
! # No way to tell, although "INDEX" is likely
! return "TYPE='unknown'"
! else:
! return type_to_name(path[1])
# The following functions interpret the data returned by the gopher
# server according to the expected type, e.g. textfile or directory
- # Get a directory in the form of a list of entries
def get_directory(f):
! import string
! list = []
! while 1:
! line = f.readline()
! if not line:
! print '(Unexpected EOF from server)'
! break
! if line[-2:] == CRLF:
! line = line[:-2]
! elif line[-1:] in CRLF:
! line = line[:-1]
! if line == '.':
! break
! if not line:
! print '(Empty line from server)'
! continue
! gtype = line[0]
! parts = string.splitfields(line[1:], TAB)
! if len(parts) < 4:
! print '(Bad line from server:', `line`, ')'
! continue
! if len(parts) > 4:
! if parts[4:] != ['+']:
! print '(Extra info from server:',
! print parts[4:], ')'
! else:
! parts.append('')
! parts.insert(0, gtype)
! list.append(parts)
! return list
- # Get a text file as a list of lines, with trailing CRLF stripped
def get_textfile(f):
! list = []
! get_alt_textfile(f, list.append)
! return list
- # Get a text file and pass each line to a function, with trailing CRLF stripped
def get_alt_textfile(f, func):
! while 1:
! line = f.readline()
! if not line:
! print '(Unexpected EOF from server)'
! break
! if line[-2:] == CRLF:
! line = line[:-2]
! elif line[-1:] in CRLF:
! line = line[:-1]
! if line == '.':
! break
! if line[:2] == '..':
! line = line[1:]
! func(line)
- # Get a binary file as one solid data block
def get_binary(f):
! data = f.read()
! return data
- # Get a binary file and pass each block to a function
def get_alt_binary(f, func, blocksize):
! while 1:
! data = f.read(blocksize)
! if not data:
! break
! func(data)
- # Trivial test program
def test():
! import sys
! import getopt
! opts, args = getopt.getopt(sys.argv[1:], '')
! selector = DEF_SELECTOR
! type = selector[0]
! host = DEF_HOST
! port = DEF_PORT
! if args:
! host = args[0]
! args = args[1:]
! if args:
! type = args[0]
! args = args[1:]
! if len(type) > 1:
! type, selector = type[0], type
! else:
! selector = ''
! if args:
! selector = args[0]
! args = args[1:]
! query = ''
! if args:
! query = args[0]
! args = args[1:]
! if type == A_INDEX:
! f = send_query(selector, query, host)
! else:
! f = send_selector(selector, host)
! if type == A_TEXT:
! list = get_textfile(f)
! for item in list: print item
! elif type in (A_MENU, A_INDEX):
! list = get_directory(f)
! for item in list: print item
! else:
! data = get_binary(f)
! print 'binary data:', len(data), 'bytes:', `data[:100]`[:40]
# Run the test when run as script
if __name__ == '__main__':
! test()
--- 54,208 ----
TAB = '\t'
def send_selector(selector, host, port = 0):
! """Send a selector to a given host and port, return a file with the reply."""
! import socket
! import string
! if not port:
! i = string.find(host, ':')
! if i >= 0:
! host, port = host[:i], string.atoi(host[i+1:])
! if not port:
! port = DEF_PORT
! elif type(port) == type(''):
! port = string.atoi(port)
! s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
! s.connect(host, port)
! s.send(selector + CRLF)
! s.shutdown(1)
! return s.makefile('rb')
def send_query(selector, query, host, port = 0):
! """Send a selector and a query string."""
! return send_selector(selector + '\t' + query, host, port)
def path_to_selector(path):
! """Takes a path as returned by urlparse and returns the appropriate selector."""
! if path=="/":
! return "/"
! else:
! return path[2:] # Cuts initial slash and data type identifier
def path_to_datatype_name(path):
! """Takes a path as returned by urlparse and maps it to a string.
! See section 3.4 of RFC 1738 for details."""
! if path=="/":
! # No way to tell, although "INDEX" is likely
! return "TYPE='unknown'"
! else:
! return type_to_name(path[1])
# The following functions interpret the data returned by the gopher
# server according to the expected type, e.g. textfile or directory
def get_directory(f):
! """Get a directory in the form of a list of entries."""
! import string
! list = []
! while 1:
! line = f.readline()
! if not line:
! print '(Unexpected EOF from server)'
! break
! if line[-2:] == CRLF:
! line = line[:-2]
! elif line[-1:] in CRLF:
! line = line[:-1]
! if line == '.':
! break
! if not line:
! print '(Empty line from server)'
! continue
! gtype = line[0]
! parts = string.splitfields(line[1:], TAB)
! if len(parts) < 4:
! print '(Bad line from server:', `line`, ')'
! continue
! if len(parts) > 4:
! if parts[4:] != ['+']:
! print '(Extra info from server:',
! print parts[4:], ')'
! else:
! parts.append('')
! parts.insert(0, gtype)
! list.append(parts)
! return list
def get_textfile(f):
! """Get a text file as a list of lines, with trailing CRLF stripped."""
! list = []
! get_alt_textfile(f, list.append)
! return list
def get_alt_textfile(f, func):
! """Get a text file and pass each line to a function, with trailing CRLF stripped."""
! while 1:
! line = f.readline()
! if not line:
! print '(Unexpected EOF from server)'
! break
! if line[-2:] == CRLF:
! line = line[:-2]
! elif line[-1:] in CRLF:
! line = line[:-1]
! if line == '.':
! break
! if line[:2] == '..':
! line = line[1:]
! func(line)
def get_binary(f):
! """Get a binary file as one solid data block."""
! data = f.read()
! return data
def get_alt_binary(f, func, blocksize):
! """Get a binary file and pass each block to a function."""
! while 1:
! data = f.read(blocksize)
! if not data:
! break
! func(data)
def test():
! """Trivial test program."""
! import sys
! import getopt
! opts, args = getopt.getopt(sys.argv[1:], '')
! selector = DEF_SELECTOR
! type = selector[0]
! host = DEF_HOST
! port = DEF_PORT
! if args:
! host = args[0]
! args = args[1:]
! if args:
! type = args[0]
! args = args[1:]
! if len(type) > 1:
! type, selector = type[0], type
! else:
! selector = ''
! if args:
! selector = args[0]
! args = args[1:]
! query = ''
! if args:
! query = args[0]
! args = args[1:]
! if type == A_INDEX:
! f = send_query(selector, query, host)
! else:
! f = send_selector(selector, host)
! if type == A_TEXT:
! list = get_textfile(f)
! for item in list: print item
! elif type in (A_MENU, A_INDEX):
! list = get_directory(f)
! for item in list: print item
! else:
! data = get_binary(f)
! print 'binary data:', len(data), 'bytes:', `data[:100]`[:40]
# Run the test when run as script
if __name__ == '__main__':
! test()
Index: gzip.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/gzip.py,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** gzip.py 2000/02/02 16:51:06 1.15
--- gzip.py 2000/02/04 15:10:32 1.16
***************
*** 1,2 ****
--- 1,8 ----
+ """This module implements a function that reads and writes a gzipped file.
+ The user of the file doesn't have to worry about the compression,
+ but random access is not allowed."""
+
+ # based on Andrew Kuchling's minigzip.py distributed with the zlib module
+
import time
import string
***************
*** 4,13 ****
import struct
import __builtin__
-
- # implements a python function that reads and writes a gzipped file
- # the user of the file doesn't have to worry about the compression,
- # but random access is not allowed
-
- # based on Andrew Kuchling's minigzip.py distributed with the zlib module
FTEXT, FHCRC, FEXTRA, FNAME, FCOMMENT = 1, 2, 4, 8, 16
--- 10,13 ----
Index: htmlentitydefs.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/htmlentitydefs.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** htmlentitydefs.py 1999/08/19 15:59:35 1.4
--- htmlentitydefs.py 2000/02/04 15:10:33 1.5
***************
*** 1,2 ****
--- 1,4 ----
+ """HTML character entity references."""
+
entitydefs = {
'AElig': '\306', # latin capital letter AE = latin capital ligature AE, U+00C6 ISOlat1
Index: imghdr.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/imghdr.py,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** imghdr.py 1997/10/08 15:22:32 1.8
--- imghdr.py 2000/02/04 15:10:33 1.9
***************
*** 1,3 ****
! # Recognizing image files based on their first few bytes.
--- 1,3 ----
! """Recognize image file formats based on their first few bytes."""
***************
*** 7,29 ****
def what(file, h=None):
! if h is None:
! if type(file) == type(''):
! f = open(file, 'rb')
! h = f.read(32)
! else:
! location = file.tell()
! h = file.read(32)
! file.seek(location)
! f = None
! else:
! f = None
! try:
! for tf in tests:
! res = tf(h, f)
! if res:
! return res
! finally:
! if f: f.close()
! return None
--- 7,29 ----
def what(file, h=None):
! if h is None:
! if type(file) == type(''):
! f = open(file, 'rb')
! h = f.read(32)
! else:
! location = file.tell()
! h = file.read(32)
! file.seek(location)
! f = None
! else:
! f = None
! try:
! for tf in tests:
! res = tf(h, f)
! if res:
! return res
! finally:
! if f: f.close()
! return None
***************
*** 35,113 ****
def test_rgb(h, f):
! # SGI image library
! if h[:2] == '\001\332':
! return 'rgb'
tests.append(test_rgb)
def test_gif(h, f):
! # GIF ('87 and '89 variants)
! if h[:6] in ('GIF87a', 'GIF89a'):
! return 'gif'
tests.append(test_gif)
def test_pbm(h, f):
! # PBM (portable bitmap)
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '14' and h[2] in ' \t\n\r':
! return 'pbm'
tests.append(test_pbm)
def test_pgm(h, f):
! # PGM (portable graymap)
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '25' and h[2] in ' \t\n\r':
! return 'pgm'
tests.append(test_pgm)
def test_ppm(h, f):
! # PPM (portable pixmap)
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '36' and h[2] in ' \t\n\r':
! return 'ppm'
tests.append(test_ppm)
def test_tiff(h, f):
! # TIFF (can be in Motorola or Intel byte order)
! if h[:2] in ('MM', 'II'):
! return 'tiff'
tests.append(test_tiff)
def test_rast(h, f):
! # Sun raster file
! if h[:4] == '\x59\xA6\x6A\x95':
! return 'rast'
tests.append(test_rast)
def test_xbm(h, f):
! # X bitmap (X10 or X11)
! s = '#define '
! if h[:len(s)] == s:
! return 'xbm'
tests.append(test_xbm)
def test_jpeg(h, f):
! # JPEG data in JFIF format
! if h[6:10] == 'JFIF':
! return 'jpeg'
tests.append(test_jpeg)
def test_bmp(h, f):
! if h[:2] == 'BM':
! return 'bmp'
!
tests.append(test_bmp)
def test_png(h, f):
! if h[:8] == "\211PNG\r\n\032\n":
! return 'png'
tests.append(test_png)
--- 35,113 ----
def test_rgb(h, f):
! """SGI image library"""
! if h[:2] == '\001\332':
! return 'rgb'
tests.append(test_rgb)
def test_gif(h, f):
! """GIF ('87 and '89 variants)"""
! if h[:6] in ('GIF87a', 'GIF89a'):
! return 'gif'
tests.append(test_gif)
def test_pbm(h, f):
! """PBM (portable bitmap)"""
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '14' and h[2] in ' \t\n\r':
! return 'pbm'
tests.append(test_pbm)
def test_pgm(h, f):
! """PGM (portable graymap)"""
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '25' and h[2] in ' \t\n\r':
! return 'pgm'
tests.append(test_pgm)
def test_ppm(h, f):
! """PPM (portable pixmap)"""
! if len(h) >= 3 and \
! h[0] == 'P' and h[1] in '36' and h[2] in ' \t\n\r':
! return 'ppm'
tests.append(test_ppm)
def test_tiff(h, f):
! """TIFF (can be in Motorola or Intel byte order)"""
! if h[:2] in ('MM', 'II'):
! return 'tiff'
tests.append(test_tiff)
def test_rast(h, f):
! """Sun raster file"""
! if h[:4] == '\x59\xA6\x6A\x95':
! return 'rast'
tests.append(test_rast)
def test_xbm(h, f):
! """X bitmap (X10 or X11)"""
! s = '#define '
! if h[:len(s)] == s:
! return 'xbm'
tests.append(test_xbm)
def test_jpeg(h, f):
! """JPEG data in JFIF format"""
! if h[6:10] == 'JFIF':
! return 'jpeg'
tests.append(test_jpeg)
def test_bmp(h, f):
! if h[:2] == 'BM':
! return 'bmp'
!
tests.append(test_bmp)
def test_png(h, f):
! if h[:8] == "\211PNG\r\n\032\n":
! return 'png'
tests.append(test_png)
***************
*** 118,153 ****
def test():
! import sys
! recursive = 0
! if sys.argv[1:] and sys.argv[1] == '-r':
! del sys.argv[1:2]
! recursive = 1
! try:
! if sys.argv[1:]:
! testall(sys.argv[1:], recursive, 1)
! else:
! testall(['.'], recursive, 1)
! except KeyboardInterrupt:
! sys.stderr.write('\n[Interrupted]\n')
! sys.exit(1)
def testall(list, recursive, toplevel):
! import sys
! import os
! for filename in list:
! if os.path.isdir(filename):
! print filename + '/:',
! if recursive or toplevel:
! print 'recursing down:'
! import glob
! names = glob.glob(os.path.join(filename, '*'))
! testall(names, recursive, 0)
! else:
! print '*** directory (use -r) ***'
! else:
! print filename + ':',
! sys.stdout.flush()
! try:
! print what(filename)
! except IOError:
! print '*** not found ***'
--- 118,153 ----
def test():
! import sys
! recursive = 0
! if sys.argv[1:] and sys.argv[1] == '-r':
! del sys.argv[1:2]
! recursive = 1
! try:
! if sys.argv[1:]:
! testall(sys.argv[1:], recursive, 1)
! else:
! testall(['.'], recursive, 1)
! except KeyboardInterrupt:
! sys.stderr.write('\n[Interrupted]\n')
! sys.exit(1)
def testall(list, recursive, toplevel):
! import sys
! import os
! for filename in list:
! if os.path.isdir(filename):
! print filename + '/:',
! if recursive or toplevel:
! print 'recursing down:'
! import glob
! names = glob.glob(os.path.join(filename, '*'))
! testall(names, recursive, 0)
! else:
! print '*** directory (use -r) ***'
! else:
! print filename + ':',
! sys.stdout.flush()
! try:
! print what(filename)
! except IOError:
! print '*** not found ***'
Index: keyword.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/keyword.py,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -r1.7 -r1.8
*** keyword.py 1998/03/26 21:12:18 1.7
--- keyword.py 2000/02/04 15:10:33 1.8
***************
*** 1,12 ****
#! /usr/bin/env python
! #
! # Keywords (from "graminit.c")
! #
! # This file is automatically generated; please don't muck it up!
! #
! # To update the symbols in this file, 'cd' to the top directory of
! # the python source tree after building the interpreter and run:
! #
! # python Lib/keyword.py
kwlist = [
--- 1,13 ----
#! /usr/bin/env python
!
! """Keywords (from "graminit.c")
!
! This file is automatically generated; please don't muck it up!
!
! To update the symbols in this file, 'cd' to the top directory of
! the python source tree after building the interpreter and run:
!
! python Lib/keyword.py
! """
kwlist = [
Index: linecache.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/linecache.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** linecache.py 1995/08/10 19:32:22 1.4
--- linecache.py 2000/02/04 15:10:33 1.5
***************
*** 1,7 ****
! # Cache lines from files.
! # This is intended to read lines from modules imported -- hence if a filename
! # is not found, it will look down the module search path for a file by
! # that name.
import sys
import os
--- 1,9 ----
! """Cache lines from files.
+ This is intended to read lines from modules imported -- hence if a filename
+ is not found, it will look down the module search path for a file by
+ that name.
+ """
+
import sys
import os
***************
*** 9,17 ****
def getline(filename, lineno):
! lines = getlines(filename)
! if 1 <= lineno <= len(lines):
! return lines[lineno-1]
! else:
! return ''
--- 11,19 ----
def getline(filename, lineno):
! lines = getlines(filename)
! if 1 <= lineno <= len(lines):
! return lines[lineno-1]
! else:
! return ''
***************
*** 21,90 ****
- # Clear the cache entirely
-
def clearcache():
! global cache
! cache = {}
- # Get the lines for a file from the cache.
- # Update the cache if it doesn't contain an entry for this file already.
def getlines(filename):
! if cache.has_key(filename):
! return cache[filename][2]
! else:
! return updatecache(filename)
- # Discard cache entries that are out of date.
- # (This is not checked upon each call!)
def checkcache():
! for filename in cache.keys():
! size, mtime, lines, fullname = cache[filename]
! try:
! stat = os.stat(fullname)
! except os.error:
! del cache[filename]
! continue
! if size <> stat[ST_SIZE] or mtime <> stat[ST_MTIME]:
! del cache[filename]
- # Update a cache entry and return its list of lines.
- # If something's wrong, print a message, discard the cache entry,
- # and return an empty list.
def updatecache(filename):
! if cache.has_key(filename):
! del cache[filename]
! if not filename or filename[0] + filename[-1] == '<>':
! return []
! fullname = filename
! try:
! stat = os.stat(fullname)
! except os.error, msg:
! # Try looking through the module search path
! basename = os.path.split(filename)[1]
! for dirname in sys.path:
! fullname = os.path.join(dirname, basename)
! try:
! stat = os.stat(fullname)
! break
! except os.error:
! pass
! else:
! # No luck
! ## print '*** Cannot stat', filename, ':', msg
! return []
! try:
! fp = open(fullname, 'r')
! lines = fp.readlines()
! fp.close()
! except IOError, msg:
! ## print '*** Cannot open', fullname, ':', msg
! return []
! size, mtime = stat[ST_SIZE], stat[ST_MTIME]
! cache[filename] = size, mtime, lines, fullname
! return lines
--- 23,92 ----
def clearcache():
! """Clear the cache entirely."""
+ global cache
+ cache = {}
def getlines(filename):
! """Get the lines for a file from the cache.
! Update the cache if it doesn't contain an entry for this file already."""
+ if cache.has_key(filename):
+ return cache[filename][2]
+ else:
+ return updatecache(filename)
def checkcache():
! """Discard cache entries that are out of date.
! (This is not checked upon each call!)"""
+ for filename in cache.keys():
+ size, mtime, lines, fullname = cache[filename]
+ try:
+ stat = os.stat(fullname)
+ except os.error:
+ del cache[filename]
+ continue
+ if size <> stat[ST_SIZE] or mtime <> stat[ST_MTIME]:
+ del cache[filename]
def updatecache(filename):
! """Update a cache entry and return its list of lines.
! If something's wrong, print a message, discard the cache entry,
! and return an empty list."""
!
! if cache.has_key(filename):
! del cache[filename]
! if not filename or filename[0] + filename[-1] == '<>':
! return []
! fullname = filename
! try:
! stat = os.stat(fullname)
! except os.error, msg:
! # Try looking through the module search path
! basename = os.path.split(filename)[1]
! for dirname in sys.path:
! fullname = os.path.join(dirname, basename)
! try:
! stat = os.stat(fullname)
! break
! except os.error:
! pass
! else:
! # No luck
! ## print '*** Cannot stat', filename, ':', msg
! return []
! try:
! fp = open(fullname, 'r')
! lines = fp.readlines()
! fp.close()
! except IOError, msg:
! ## print '*** Cannot open', fullname, ':', msg
! return []
! size, mtime = stat[ST_SIZE], stat[ST_MTIME]
! cache[filename] = size, mtime, lines, fullname
! return lines
Index: macpath.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/macpath.py,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -r1.20 -r1.21
*** macpath.py 1999/07/23 15:04:05 1.20
--- macpath.py 2000/02/04 15:10:33 1.21
***************
*** 1,3 ****
! # module 'macpath' -- pathname (or -related) operations for the Macintosh
import string
--- 1,3 ----
! """Pathname and path-related operations for the Macintosh."""
import string
***************
*** 11,85 ****
- # Return true if a path is absolute.
- # On the Mac, relative paths begin with a colon,
- # but as a special case, paths with no colons at all are also relative.
- # Anything else is absolute (the string up to the first colon is the
- # volume name).
-
def isabs(s):
! return ':' in s and s[0] <> ':'
def join(s, *p):
! path = s
! for t in p:
! if (not s) or isabs(t):
! path = t
! continue
! if t[:1] == ':':
! t = t[1:]
! if ':' not in path:
! path = ':' + path
! if path[-1:] <> ':':
! path = path + ':'
! path = path + t
! return path
!
!
! # Split a pathname in two parts: the directory leading up to the final bit,
! # and the basename (the filename, without colons, in that directory).
! # The result (s, t) is such that join(s, t) yields the original argument.
- def split(s):
- if ':' not in s: return '', s
- colon = 0
- for i in range(len(s)):
- if s[i] == ':': colon = i+1
- path, file = s[:colon-1], s[colon:]
- if path and not ':' in path:
- path = path + ':'
- return path, file
- # Split a path in root and extension.
- # The extension is everything starting at the last dot in the last
- # pathname component; the root is everything before that.
- # It is always true that root + ext == p.
def splitext(p):
! root, ext = '', ''
! for c in p:
! if c == ':':
! root, ext = root + ext + c, ''
! elif c == '.':
! if ext:
! root, ext = root + ext, c
! else:
! ext = c
! elif ext:
! ext = ext + c
! else:
! root = root + c
! return root, ext
!
!
! # Split a pathname into a drive specification and the rest of the
! # path. Useful on DOS/Windows/NT; on the Mac, the drive is always
! # empty (don't use the volume name -- it doesn't have the same
! # syntactic and semantic oddities as DOS drive letters, such as there
! # being a separate current directory per drive).
def splitdrive(p):
! return '', p
--- 11,85 ----
def isabs(s):
! """Return true if a path is absolute.
! On the Mac, relative paths begin with a colon,
! but as a special case, paths with no colons at all are also relative.
! Anything else is absolute (the string up to the first colon is the
! volume name)."""
!
! return ':' in s and s[0] <> ':'
def join(s, *p):
! path = s
! for t in p:
! if (not s) or isabs(t):
! path = t
! continue
! if t[:1] == ':':
! t = t[1:]
! if ':' not in path:
! path = ':' + path
! if path[-1:] <> ':':
! path = path + ':'
! path = path + t
! return path
+ def split(s):
+ """Split a pathname into two parts: the directory leading up to the final
+ bit, and the basename (the filename, without colons, in that directory).
+ The result (s, t) is such that join(s, t) yields the original argument."""
+
+ if ':' not in s: return '', s
+ colon = 0
+ for i in range(len(s)):
+ if s[i] == ':': colon = i+1
+ path, file = s[:colon-1], s[colon:]
+ if path and not ':' in path:
+ path = path + ':'
+ return path, file
def splitext(p):
! """Split a path into root and extension.
! The extension is everything starting at the last dot in the last
! pathname component; the root is everything before that.
! It is always true that root + ext == p."""
!
! root, ext = '', ''
! for c in p:
! if c == ':':
! root, ext = root + ext + c, ''
! elif c == '.':
! if ext:
! root, ext = root + ext, c
! else:
! ext = c
! elif ext:
! ext = ext + c
! else:
! root = root + c
! return root, ext
+
def splitdrive(p):
! """Split a pathname into a drive specification and the rest of the
! path. Useful on DOS/Windows/NT; on the Mac, the drive is always
! empty (don't use the volume name -- it doesn't have the same
! syntactic and semantic oddities as DOS drive letters, such as there
! being a separate current directory per drive)."""
!
! return '', p
***************
*** 90,101 ****
- # Return true if the pathname refers to an existing directory.
-
def isdir(s):
! try:
! st = os.stat(s)
! except os.error:
! return 0
! return S_ISDIR(st[ST_MODE])
--- 90,101 ----
def isdir(s):
! """Return true if the pathname refers to an existing directory."""
!
! try:
! st = os.stat(s)
! except os.error:
! return 0
! return S_ISDIR(st[ST_MODE])
***************
*** 118,220 ****
- # Return true if the pathname refers to a symbolic link.
- # (Always false on the Mac, until we understand Aliases.)
-
def islink(s):
! return 0
- # Return true if the pathname refers to an existing regular file.
def isfile(s):
! try:
! st = os.stat(s)
! except os.error:
! return 0
! return S_ISREG(st[ST_MODE])
- # Return true if the pathname refers to an existing file or directory.
def exists(s):
! try:
! st = os.stat(s)
! except os.error:
! return 0
! return 1
!
! #
! # dummy expandvars to retain interface-compatability with other
! # operating systems.
def expandvars(path):
! return path
- #
- # dummy expanduser to retain interface-compatability with other
- # operating systems.
- def expanduser(path):
- return path
! # Normalize a pathname: get rid of '::' sequences by backing up,
! # e.g., 'foo:bar::bletch' becomes 'foo:bletch'.
! # Raise the exception norm_error below if backing up is impossible,
! # e.g., for '::foo'.
! # XXX The Unix version doesn't raise an exception but simply
! # returns an unnormalized path. Should do so here too.
norm_error = 'macpath.norm_error: path cannot be normalized'
def normpath(s):
! import string
! if ':' not in s:
! return ':' + s
! f = string.splitfields(s, ':')
! pre = []
! post = []
! if not f[0]:
! pre = f[:1]
! f = f[1:]
! if not f[len(f)-1]:
! post = f[-1:]
! f = f[:-1]
! res = []
! for seg in f:
! if seg:
! res.append(seg)
! else:
! if not res: raise norm_error, 'path starts with ::'
! del res[len(res)-1]
! if not (pre or res):
! raise norm_error, 'path starts with volume::'
! if pre: res = pre + res
! if post: res = res + post
! s = res[0]
! for seg in res[1:]:
! s = s + ':' + seg
! return s
!
!
! # Directory tree walk.
! # For each directory under top (including top itself),
! # func(arg, dirname, filenames) is called, where
! # dirname is the name of the directory and filenames is the list
! # of files (and subdirectories etc.) in the directory.
! # The func may modify the filenames list, to implement a filter,
! # or to impose a different order of visiting.
def walk(top, func, arg):
! try:
! names = os.listdir(top)
! except os.error:
! return
! func(arg, top, names)
! for name in names:
! name = join(top, name)
! if isdir(name):
! walk(name, func, arg)
- # Return an absolute path.
def abspath(path):
if not isabs(path):
path = join(os.getcwd(), path)
--- 118,218 ----
def islink(s):
! """Return true if the pathname refers to a symbolic link.
! Always false on the Mac, until we understand Aliases.)"""
+ return 0
def isfile(s):
! """Return true if the pathname refers to an existing regular file."""
+ try:
+ st = os.stat(s)
+ except os.error:
+ return 0
+ return S_ISREG(st[ST_MODE])
def exists(s):
! """Return true if the pathname refers to an existing file or directory."""
!
! try:
! st = os.stat(s)
! except os.error:
! return 0
! return 1
!
!
def expandvars(path):
! """Dummy to retain interface-compatibility with other operating systems."""
! return path
! def expanduser(path):
! """Dummy to retain interface-compatibility with other operating systems."""
! return path
norm_error = 'macpath.norm_error: path cannot be normalized'
def normpath(s):
! """Normalize a pathname: get rid of '::' sequences by backing up,
! e.g., 'foo:bar::bletch' becomes 'foo:bletch'.
! Raise the exception norm_error below if backing up is impossible,
! e.g., for '::foo'."""
! # XXX The Unix version doesn't raise an exception but simply
! # returns an unnormalized path. Should do so here too.
!
! import string
! if ':' not in s:
! return ':' + s
! f = string.splitfields(s, ':')
! pre = []
! post = []
! if not f[0]:
! pre = f[:1]
! f = f[1:]
! if not f[len(f)-1]:
! post = f[-1:]
! f = f[:-1]
! res = []
! for seg in f:
! if seg:
! res.append(seg)
! else:
! if not res: raise norm_error, 'path starts with ::'
! del res[len(res)-1]
! if not (pre or res):
! raise norm_error, 'path starts with volume::'
! if pre: res = pre + res
! if post: res = res + post
! s = res[0]
! for seg in res[1:]:
! s = s + ':' + seg
! return s
!
def walk(top, func, arg):
! """Directory tree walk.
! For each directory under top (including top itself),
! func(arg, dirname, filenames) is called, where
! dirname is the name of the directory and filenames is the list
! of files (and subdirectories etc.) in the directory.
! The func may modify the filenames list, to implement a filter,
! or to impose a different order of visiting."""
!
! try:
! names = os.listdir(top)
! except os.error:
! return
! func(arg, top, names)
! for name in names:
! name = join(top, name)
! if isdir(name):
! walk(name, func, arg)
def abspath(path):
+ """Return an absolute path."""
if not isabs(path):
path = join(os.getcwd(), path)
Index: mailcap.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/mailcap.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** mailcap.py 1998/03/26 21:12:26 1.4
--- mailcap.py 2000/02/04 15:10:33 1.5
***************
*** 10,15 ****
"""Return a dictionary containing the mailcap database.
! The dictionary maps a MIME type (in all lowercase,
! e.g. 'text/plain') to a list of corresponding mailcap entries.
"""
--- 10,18 ----
"""Return a dictionary containing the mailcap database.
! The dictionary maps a MIME type (in all lowercase, e.g. 'text/plain')
! to a list of dictionaries corresponding to mailcap entries. The list
! collects all the entries for that MIME type from all available mailcap
! files. Each dictionary contains key-value pairs for that MIME type,
! where the viewing command is stored with the key "view".
"""
***************
*** 49,52 ****
--- 52,63 ----
def readmailcapfile(fp):
+ """Read a mailcap file and return a dictionary keyed by MIME type.
+
+ Each MIME type is mapped to an entry consisting of a list of
+ dictionaries; the list will contain more than one such dictionary
+ if a given MIME type appears more than once in the mailcap file.
+ Each dictionary contains key-value pairs for that MIME type, where
+ the viewing command is stored with the key "view".
+ """
caps = {}
while 1:
***************
*** 79,82 ****
--- 90,98 ----
def parseline(line):
+ """Parse one entry in a mailcap file and return a dictionary.
+
+ The viewing command is stored as the value with the key "view",
+ and the rest of the fields produce key-value pairs in the dict.
+ """
fields = []
i, n = 0, len(line)
***************
*** 105,108 ****
--- 121,125 ----
def parsefield(line, i, n):
+ """Separate one key-value pair in a mailcap entry."""
start = i
while i < n:
Index: mhlib.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/mhlib.py,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -r1.18 -r1.19
*** mhlib.py 1999/02/24 16:25:17 1.18
--- mhlib.py 2000/02/04 15:10:33 1.19
***************
*** 1,56 ****
! # MH interface -- purely object-oriented (well, almost)
! #
! # Executive summary:
! #
! # import mhlib
! #
! # mh = mhlib.MH() # use default mailbox directory and profile
! # mh = mhlib.MH(mailbox) # override mailbox location (default from profile)
! # mh = mhlib.MH(mailbox, profile) # override mailbox and profile
! #
! # mh.error(format, ...) # print error message -- can be overridden
! # s = mh.getprofile(key) # profile entry (None if not set)
! # path = mh.getpath() # mailbox pathname
! # name = mh.getcontext() # name of current folder
! # mh.setcontext(name) # set name of current folder
! #
! # list = mh.listfolders() # names of top-level folders
! # list = mh.listallfolders() # names of all folders, including subfolders
! # list = mh.listsubfolders(name) # direct subfolders of given folder
! # list = mh.listallsubfolders(name) # all subfolders of given folder
! #
! # mh.makefolder(name) # create new folder
! # mh.deletefolder(name) # delete folder -- must have no subfolders
! #
! # f = mh.openfolder(name) # new open folder object
! #
! # f.error(format, ...) # same as mh.error(format, ...)
! # path = f.getfullname() # folder's full pathname
! # path = f.getsequencesfilename() # full pathname of folder's sequences file
! # path = f.getmessagefilename(n) # full pathname of message n in folder
! #
! # list = f.listmessages() # list of messages in folder (as numbers)
! # n = f.getcurrent() # get current message
! # f.setcurrent(n) # set current message
! # list = f.parsesequence(seq) # parse msgs syntax into list of messages
! # n = f.getlast() # get last message (0 if no messagse)
! # f.setlast(n) # set last message (internal use only)
! #
! # dict = f.getsequences() # dictionary of sequences in folder {name: list}
! # f.putsequences(dict) # write sequences back to folder
! #
! # f.createmessage(n, fp) # add message from file f as number n
! # f.removemessages(list) # remove messages in list from folder
! # f.refilemessages(list, tofolder) # move messages in list to other folder
! # f.movemessage(n, tofolder, ton) # move one message to a given destination
! # f.copymessage(n, tofolder, ton) # copy one message to a given destination
! #
! # m = f.openmessage(n) # new open message object (costs a file descriptor)
! # m is a derived class of mimetools.Message(rfc822.Message), with:
! # s = m.getheadertext() # text of message's headers
! # s = m.getheadertext(pred) # text of message's headers, filtered by pred
! # s = m.getbodytext() # text of message's body, decoded
! # s = m.getbodytext(0) # text of message's body, not decoded
! #
# XXX To do, functionality:
# - annotate messages
--- 1,57 ----
! """MH interface -- purely object-oriented (well, almost)
!
! Executive summary:
!
! import mhlib
!
! mh = mhlib.MH() # use default mailbox directory and profile
! mh = mhlib.MH(mailbox) # override mailbox location (default from profile)
! mh = mhlib.MH(mailbox, profile) # override mailbox and profile
!
! mh.error(format, ...) # print error message -- can be overridden
! s = mh.getprofile(key) # profile entry (None if not set)
! path = mh.getpath() # mailbox pathname
! name = mh.getcontext() # name of current folder
! mh.setcontext(name) # set name of current folder
!
! list = mh.listfolders() # names of top-level folders
! list = mh.listallfolders() # names of all folders, including subfolders
! list = mh.listsubfolders(name) # direct subfolders of given folder
! list = mh.listallsubfolders(name) # all subfolders of given folder
!
! mh.makefolder(name) # create new folder
! mh.deletefolder(name) # delete folder -- must have no subfolders
!
! f = mh.openfolder(name) # new open folder object
!
! f.error(format, ...) # same as mh.error(format, ...)
! path = f.getfullname() # folder's full pathname
! path = f.getsequencesfilename() # full pathname of folder's sequences file
! path = f.getmessagefilename(n) # full pathname of message n in folder
!
! list = f.listmessages() # list of messages in folder (as numbers)
! n = f.getcurrent() # get current message
! f.setcurrent(n) # set current message
! list = f.parsesequence(seq) # parse msgs syntax into list of messages
! n = f.getlast() # get last message (0 if no messagse)
! f.setlast(n) # set last message (internal use only)
!
! dict = f.getsequences() # dictionary of sequences in folder {name: list}
! f.putsequences(dict) # write sequences back to folder
!
! f.createmessage(n, fp) # add message from file f as number n
! f.removemessages(list) # remove messages in list from folder
! f.refilemessages(list, tofolder) # move messages in list to other folder
! f.movemessage(n, tofolder, ton) # move one message to a given destination
! f.copymessage(n, tofolder, ton) # copy one message to a given destination
!
! m = f.openmessage(n) # new open message object (costs a file descriptor)
! m is a derived class of mimetools.Message(rfc822.Message), with:
! s = m.getheadertext() # text of message's headers
! s = m.getheadertext(pred) # text of message's headers, filtered by pred
! s = m.getbodytext() # text of message's body, decoded
! s = m.getbodytext(0) # text of message's body, not decoded
! """
!
# XXX To do, functionality:
# - annotate messages
***************
*** 88,101 ****
- # Class representing a particular collection of folders.
- # Optional constructor arguments are the pathname for the directory
- # containing the collection, and the MH profile to use.
- # If either is omitted or empty a default is used; the default
- # directory is taken from the MH profile if it is specified there.
-
class MH:
- # Constructor
def __init__(self, path = None, profile = None):
if not profile: profile = MH_PROFILE
self.profile = os.path.expanduser(profile)
--- 89,101 ----
class MH:
+ """Class representing a particular collection of folders.
+ Optional constructor arguments are the pathname for the directory
+ containing the collection, and the MH profile to use.
+ If either is omitted or empty a default is used; the default
+ directory is taken from the MH profile if it is specified there."""
def __init__(self, path = None, profile = None):
+ """Constructor."""
if not profile: profile = MH_PROFILE
self.profile = os.path.expanduser(profile)
***************
*** 108,129 ****
self.path = path
- # String representation
def __repr__(self):
return 'MH(%s, %s)' % (`self.path`, `self.profile`)
- # Routine to print an error. May be overridden by a derived class
def error(self, msg, *args):
sys.stderr.write('MH error: %s\n' % (msg % args))
- # Return a profile entry, None if not found
def getprofile(self, key):
return pickline(self.profile, key)
- # Return the path (the name of the collection's directory)
def getpath(self):
return self.path
- # Return the name of the current folder
def getcontext(self):
context = pickline(os.path.join(self.getpath(), 'context'),
'Current-Folder')
--- 108,129 ----
self.path = path
def __repr__(self):
+ """String representation."""
return 'MH(%s, %s)' % (`self.path`, `self.profile`)
def error(self, msg, *args):
+ """Routine to print an error. May be overridden by a derived class."""
sys.stderr.write('MH error: %s\n' % (msg % args))
def getprofile(self, key):
+ """Return a profile entry, None if not found."""
return pickline(self.profile, key)
def getpath(self):
+ """Return the path (the name of the collection's directory)."""
return self.path
def getcontext(self):
+ """Return the name of the current folder."""
context = pickline(os.path.join(self.getpath(), 'context'),
'Current-Folder')
***************
*** 131,136 ****
return context
- # Set the name of the current folder
def setcontext(self, context):
fn = os.path.join(self.getpath(), 'context')
f = open(fn, "w")
--- 131,136 ----
return context
def setcontext(self, context):
+ """Set the name of the current folder."""
fn = os.path.join(self.getpath(), 'context')
f = open(fn, "w")
***************
*** 138,143 ****
f.close()
- # Return the names of the top-level folders
def listfolders(self):
folders = []
path = self.getpath()
--- 138,143 ----
f.close()
def listfolders(self):
+ """Return the names of the top-level folders."""
folders = []
path = self.getpath()
***************
*** 149,155 ****
return folders
- # Return the names of the subfolders in a given folder
- # (prefixed with the given folder name)
def listsubfolders(self, name):
fullname = os.path.join(self.path, name)
# Get the link count so we can avoid listing folders
--- 149,155 ----
return folders
def listsubfolders(self, name):
+ """Return the names of the subfolders in a given folder
+ (prefixed with the given folder name)."""
fullname = os.path.join(self.path, name)
# Get the link count so we can avoid listing folders
***************
*** 174,183 ****
return subfolders
- # Return the names of all folders, including subfolders, recursively
def listallfolders(self):
return self.listallsubfolders('')
- # Return the names of subfolders in a given folder, recursively
def listallsubfolders(self, name):
fullname = os.path.join(self.path, name)
# Get the link count so we can avoid listing folders
--- 174,183 ----
return subfolders
def listallfolders(self):
+ """Return the names of all folders and subfolders, recursively."""
return self.listallsubfolders('')
def listallsubfolders(self, name):
+ """Return the names of subfolders in a given folder, recursively."""
fullname = os.path.join(self.path, name)
# Get the link count so we can avoid listing folders
***************
*** 207,217 ****
return subfolders
- # Return a new Folder object for the named folder
def openfolder(self, name):
return Folder(self, name)
- # Create a new folder. This raises os.error if the folder
- # cannot be created
def makefolder(self, name):
protect = pickline(self.profile, 'Folder-Protect')
if protect and isnumeric(protect):
--- 207,216 ----
return subfolders
def openfolder(self, name):
+ """Return a new Folder object for the named folder."""
return Folder(self, name)
def makefolder(self, name):
+ """Create a new folder (or raise os.error if it cannot be created)."""
protect = pickline(self.profile, 'Folder-Protect')
if protect and isnumeric(protect):
***************
*** 221,228 ****
os.mkdir(os.path.join(self.getpath(), name), mode)
- # Delete a folder. This removes files in the folder but not
- # subdirectories. If deleting the folder itself fails it
- # raises os.error
def deletefolder(self, name):
fullname = os.path.join(self.getpath(), name)
for subname in os.listdir(fullname):
--- 220,226 ----
os.mkdir(os.path.join(self.getpath(), name), mode)
def deletefolder(self, name):
+ """Delete a folder. This removes files in the folder but not
+ subdirectories. Raise os.error if deleting the folder itself fails."""
fullname = os.path.join(self.getpath(), name)
for subname in os.listdir(fullname):
***************
*** 236,241 ****
- # Class representing a particular folder
-
numericprog = re.compile('^[1-9][0-9]*$')
def isnumeric(str):
--- 234,237 ----
***************
*** 243,249 ****
class Folder:
- # Constructor
def __init__(self, mh, name):
self.mh = mh
self.name = name
--- 239,246 ----
class Folder:
+ """Class representing a particular folder."""
def __init__(self, mh, name):
+ """Constructor."""
self.mh = mh
self.name = name
***************
*** 251,285 ****
raise Error, 'no folder %s' % name
- # String representation
def __repr__(self):
return 'Folder(%s, %s)' % (`self.mh`, `self.name`)
- # Error message handler
def error(self, *args):
apply(self.mh.error, args)
- # Return the full pathname of the folder
def getfullname(self):
return os.path.join(self.mh.path, self.name)
- # Return the full pathname of the folder's sequences file
def getsequencesfilename(self):
return os.path.join(self.getfullname(), MH_SEQUENCES)
- # Return the full pathname of a message in the folder
def getmessagefilename(self, n):
return os.path.join(self.getfullname(), str(n))
- # Return list of direct subfolders
def listsubfolders(self):
return self.mh.listsubfolders(self.name)
- # Return list of all subfolders
def listallsubfolders(self):
return self.mh.listallsubfolders(self.name)
- # Return the list of messages currently present in the folder.
- # As a side effect, set self.last to the last message (or 0)
def listmessages(self):
messages = []
match = numericprog.match
--- 248,282 ----
raise Error, 'no folder %s' % name
def __repr__(self):
+ """String representation."""
return 'Folder(%s, %s)' % (`self.mh`, `self.name`)
def error(self, *args):
+ """Error message handler."""
apply(self.mh.error, args)
def getfullname(self):
+ """Return the full pathname of the folder."""
return os.path.join(self.mh.path, self.name)
def getsequencesfilename(self):
+ """Return the full pathname of the folder's sequences file."""
return os.path.join(self.getfullname(), MH_SEQUENCES)
def getmessagefilename(self, n):
+ """Return the full pathname of a message in the folder."""
return os.path.join(self.getfullname(), str(n))
def listsubfolders(self):
+ """Return list of direct subfolders."""
return self.mh.listsubfolders(self.name)
def listallsubfolders(self):
+ """Return list of all subfolders."""
return self.mh.listallsubfolders(self.name)
def listmessages(self):
+ """Return the list of messages currently present in the folder.
+ As a side effect, set self.last to the last message (or 0)."""
messages = []
match = numericprog.match
***************
*** 296,301 ****
return messages
- # Return the set of sequences for the folder
def getsequences(self):
sequences = {}
fullname = self.getsequencesfilename()
--- 293,298 ----
return messages
def getsequences(self):
+ """Return the set of sequences for the folder."""
sequences = {}
fullname = self.getsequencesfilename()
***************
*** 316,321 ****
return sequences
- # Write the set of sequences back to the folder
def putsequences(self, sequences):
fullname = self.getsequencesfilename()
f = None
--- 313,318 ----
return sequences
def putsequences(self, sequences):
+ """Write the set of sequences back to the folder."""
fullname = self.getsequencesfilename()
f = None
***************
*** 333,338 ****
f.close()
- # Return the current message. Raise KeyError when there is none
def getcurrent(self):
seqs = self.getsequences()
try:
--- 330,335 ----
f.close()
def getcurrent(self):
+ """Return the current message. Raise KeyError when there is none."""
seqs = self.getsequences()
try:
***************
*** 341,353 ****
raise Error, "no cur message"
- # Set the current message
def setcurrent(self, n):
updateline(self.getsequencesfilename(), 'cur', str(n), 0)
- # Parse an MH sequence specification into a message list.
- # Attempt to mimic mh-sequence(5) as close as possible.
- # Also attempt to mimic observed behavior regarding which
- # conditions cause which error messages
def parsesequence(self, seq):
# XXX Still not complete (see mh-format(5)).
# Missing are:
--- 338,350 ----
raise Error, "no cur message"
def setcurrent(self, n):
+ """Set the current message."""
updateline(self.getsequencesfilename(), 'cur', str(n), 0)
def parsesequence(self, seq):
+ """Parse an MH sequence specification into a message list.
+ Attempt to mimic mh-sequence(5) as close as possible.
+ Also attempt to mimic observed behavior regarding which
+ conditions cause which error messages."""
# XXX Still not complete (see mh-format(5)).
# Missing are:
***************
*** 429,434 ****
return [n]
- # Internal: parse a message number (or cur, first, etc.)
def _parseindex(self, seq, all):
if isnumeric(seq):
try:
--- 426,431 ----
return [n]
def _parseindex(self, seq, all):
+ """Internal: parse a message number (or cur, first, etc.)."""
if isnumeric(seq):
try:
***************
*** 460,469 ****
raise Error, None
- # Open a message -- returns a Message object
def openmessage(self, n):
return Message(self, n)
- # Remove one or more messages -- may raise os.error
def removemessages(self, list):
errors = []
deleted = []
--- 457,466 ----
raise Error, None
def openmessage(self, n):
+ """Open a message -- returns a Message object."""
return Message(self, n)
def removemessages(self, list):
+ """Remove one or more messages -- may raise os.error."""
errors = []
deleted = []
***************
*** 489,495 ****
raise os.error, ('multiple errors:', errors)
- # Refile one or more messages -- may raise os.error.
- # 'tofolder' is an open folder object
def refilemessages(self, list, tofolder, keepsequences=0):
errors = []
refiled = {}
--- 486,492 ----
raise os.error, ('multiple errors:', errors)
def refilemessages(self, list, tofolder, keepsequences=0):
+ """Refile one or more messages -- may raise os.error.
+ 'tofolder' is an open folder object."""
errors = []
refiled = {}
***************
*** 524,529 ****
raise os.error, ('multiple errors:', errors)
- # Helper for refilemessages() to copy sequences
def _copysequences(self, fromfolder, refileditems):
fromsequences = fromfolder.getsequences()
tosequences = self.getsequences()
--- 521,526 ----
raise os.error, ('multiple errors:', errors)
def _copysequences(self, fromfolder, refileditems):
+ """Helper for refilemessages() to copy sequences."""
fromsequences = fromfolder.getsequences()
tosequences = self.getsequences()
***************
*** 545,551 ****
self.putsequences(tosequences)
- # Move one message over a specific destination message,
- # which may or may not already exist.
def movemessage(self, n, tofolder, ton):
path = self.getmessagefilename(n)
# Open it to check that it exists
--- 542,548 ----
self.putsequences(tosequences)
def movemessage(self, n, tofolder, ton):
+ """Move one message over a specific destination message,
+ which may or may not already exist."""
path = self.getmessagefilename(n)
# Open it to check that it exists
***************
*** 577,583 ****
self.removefromallsequences([n])
- # Copy one message over a specific destination message,
- # which may or may not already exist.
def copymessage(self, n, tofolder, ton):
path = self.getmessagefilename(n)
# Open it to check that it exists
--- 574,580 ----
self.removefromallsequences([n])
def copymessage(self, n, tofolder, ton):
+ """Copy one message over a specific destination message,
+ which may or may not already exist."""
path = self.getmessagefilename(n)
# Open it to check that it exists
***************
*** 603,608 ****
pass
- # Create a message, with text from the open file txt.
def createmessage(self, n, txt):
path = self.getmessagefilename(n)
backuppath = self.getmessagefilename(',%d' % n)
--- 600,605 ----
pass
def createmessage(self, n, txt):
+ """Create a message, with text from the open file txt."""
path = self.getmessagefilename(n)
backuppath = self.getmessagefilename(',%d' % n)
***************
*** 629,635 ****
pass
- # Remove one or more messages from all sequeuces (including last)
- # -- but not from 'cur'!!!
def removefromallsequences(self, list):
if hasattr(self, 'last') and self.last in list:
del self.last
--- 626,632 ----
pass
def removefromallsequences(self, list):
+ """Remove one or more messages from all sequeuces (including last)
+ -- but not from 'cur'!!!"""
if hasattr(self, 'last') and self.last in list:
del self.last
***************
*** 648,659 ****
self.putsequences(sequences)
- # Return the last message number
def getlast(self):
if not hasattr(self, 'last'):
messages = self.listmessages()
return self.last
- # Set the last message number
def setlast(self, last):
if last is None:
if hasattr(self, 'last'):
--- 645,656 ----
self.putsequences(sequences)
def getlast(self):
+ """Return the last message number."""
if not hasattr(self, 'last'):
messages = self.listmessages()
return self.last
def setlast(self, last):
+ """Set the last message number."""
if last is None:
if hasattr(self, 'last'):
***************
*** 664,669 ****
class Message(mimetools.Message):
- # Constructor
def __init__(self, f, n, fp = None):
self.folder = f
self.number = n
--- 661,666 ----
class Message(mimetools.Message):
def __init__(self, f, n, fp = None):
+ """Constructor."""
self.folder = f
self.number = n
***************
*** 673,685 ****
mimetools.Message.__init__(self, fp)
- # String representation
def __repr__(self):
return 'Message(%s, %s)' % (repr(self.folder), self.number)
- # Return the message's header text as a string. If an
- # argument is specified, it is used as a filter predicate to
- # decide which headers to return (its argument is the header
- # name converted to lower case).
def getheadertext(self, pred = None):
if not pred:
return string.joinfields(self.headers, '')
--- 670,682 ----
mimetools.Message.__init__(self, fp)
def __repr__(self):
+ """String representation."""
return 'Message(%s, %s)' % (repr(self.folder), self.number)
def getheadertext(self, pred = None):
+ """Return the message's header text as a string. If an
+ argument is specified, it is used as a filter predicate to
+ decide which headers to return (its argument is the header
+ name converted to lower case)."""
if not pred:
return string.joinfields(self.headers, '')
***************
*** 694,702 ****
return string.joinfields(headers, '')
- # Return the message's body text as string. This undoes a
- # Content-Transfer-Encoding, but does not interpret other MIME
- # features (e.g. multipart messages). To suppress to
- # decoding, pass a 0 as argument
def getbodytext(self, decode = 1):
self.fp.seek(self.startofbody)
encoding = self.getencoding()
--- 691,699 ----
return string.joinfields(headers, '')
def getbodytext(self, decode = 1):
+ """Return the message's body text as string. This undoes a
+ Content-Transfer-Encoding, but does not interpret other MIME
+ features (e.g. multipart messages). To suppress decoding,
+ pass 0 as an argument."""
self.fp.seek(self.startofbody)
encoding = self.getencoding()
***************
*** 708,715 ****
return output.getvalue()
- # Only for multipart messages: return the message's body as a
- # list of SubMessage objects. Each submessage object behaves
- # (almost) as a Message object.
def getbodyparts(self):
if self.getmaintype() != 'multipart':
raise Error, 'Content-Type is not multipart/*'
--- 705,712 ----
return output.getvalue()
def getbodyparts(self):
+ """Only for multipart messages: return the message's body as a
+ list of SubMessage objects. Each submessage object behaves
+ (almost) as a Message object."""
if self.getmaintype() != 'multipart':
raise Error, 'Content-Type is not multipart/*'
***************
*** 728,733 ****
return parts
- # Return body, either a string or a list of messages
def getbody(self):
if self.getmaintype() == 'multipart':
return self.getbodyparts()
--- 725,730 ----
return parts
def getbody(self):
+ """Return body, either a string or a list of messages."""
if self.getmaintype() == 'multipart':
return self.getbodyparts()
***************
*** 738,743 ****
class SubMessage(Message):
- # Constructor
def __init__(self, f, n, fp):
Message.__init__(self, f, n, fp)
if self.getmaintype() == 'multipart':
--- 735,740 ----
class SubMessage(Message):
def __init__(self, f, n, fp):
+ """Constructor."""
Message.__init__(self, f, n, fp)
if self.getmaintype() == 'multipart':
***************
*** 748,753 ****
# XXX If this is big, should remember file pointers
- # String representation
def __repr__(self):
f, n, fp = self.folder, self.number, self.fp
return 'SubMessage(%s, %s, %s)' % (f, n, fp)
--- 745,750 ----
# XXX If this is big, should remember file pointers
def __repr__(self):
+ """String representation."""
f, n, fp = self.folder, self.number, self.fp
return 'SubMessage(%s, %s, %s)' % (f, n, fp)
***************
*** 767,792 ****
- # Class implementing sets of integers.
- #
- # This is an efficient representation for sets consisting of several
- # continuous ranges, e.g. 1-100,200-400,402-1000 is represented
- # internally as a list of three pairs: [(1,100), (200,400),
- # (402,1000)]. The internal representation is always kept normalized.
- #
- # The constructor has up to three arguments:
- # - the string used to initialize the set (default ''),
- # - the separator between ranges (default ',')
- # - the separator between begin and end of a range (default '-')
- # The separators must be strings (not regexprs) and should be different.
- #
- # The tostring() function yields a string that can be passed to another
- # IntSet constructor; __repr__() is a valid IntSet constructor itself.
- #
- # XXX The default begin/end separator means that negative numbers are
- # not supported very well.
- #
- # XXX There are currently no operations to remove set elements.
-
class IntSet:
def __init__(self, data = None, sep = ',', rng = '-'):
--- 764,789 ----
class IntSet:
+ """Class implementing sets of integers.
+
+ This is an efficient representation for sets consisting of several
+ continuous ranges, e.g. 1-100,200-400,402-1000 is represented
+ internally as a list of three pairs: [(1,100), (200,400),
+ (402,1000)]. The internal representation is always kept normalized.
+
+ The constructor has up to three arguments:
+ - the string used to initialize the set (default ''),
+ - the separator between ranges (default ',')
+ - the separator between begin and end of a range (default '-')
+ The separators must be strings (not regexprs) and should be different.
+
+ The tostring() function yields a string that can be passed to another
+ IntSet constructor; __repr__() is a valid IntSet constructor itself.
+ """
+
+ # XXX The default begin/end separator means that negative numbers are
+ # not supported very well.
+ #
+ # XXX There are currently no operations to remove set elements.
def __init__(self, data = None, sep = ',', rng = '-'):
Index: mimetools.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/mimetools.py,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** mimetools.py 1998/05/20 17:05:35 1.15
--- mimetools.py 2000/02/04 15:10:33 1.16
***************
*** 1,3 ****
! # Various tools used by MIME-reading or MIME-writing programs.
--- 1,3 ----
! """Various tools used by MIME-reading or MIME-writing programs."""
***************
*** 8,15 ****
- # A derived class of rfc822.Message that knows about MIME headers and
- # contains some hooks for decoding encoded and multipart messages.
-
class Message(rfc822.Message):
def __init__(self, fp, seekable = 1):
--- 8,14 ----
class Message(rfc822.Message):
+ """A derived class of rfc822.Message that knows about MIME headers and
+ contains some hooks for decoding encoded and multipart messages."""
def __init__(self, fp, seekable = 1):
***************
*** 97,111 ****
- # Return a random string usable as a multipart boundary.
- # The method used is so that it is *very* unlikely that the same
- # string of characters will every occur again in the Universe,
- # so the caller needn't check the data it is packing for the
- # occurrence of the boundary.
- #
- # The boundary contains dots so you have to quote it in the header.
-
_prefix = None
def choose_boundary():
global _prefix
import time
--- 96,110 ----
_prefix = None
def choose_boundary():
+ """Return a random string usable as a multipart boundary.
+ The method used is so that it is *very* unlikely that the same
+ string of characters will every occur again in the Universe,
+ so the caller needn't check the data it is packing for the
+ occurrence of the boundary.
+
+ The boundary contains dots so you have to quote it in the header."""
+
global _prefix
import time
***************
*** 132,135 ****
--- 131,135 ----
def decode(input, output, encoding):
+ """Decode common content-transfer-encodings (base64, quopri, uuencode)."""
if encoding == 'base64':
import base64
***************
*** 148,151 ****
--- 148,152 ----
def encode(input, output, encoding):
+ """Encode common content-transfer-encodings (base64, quopri, uuencode)."""
if encoding == 'base64':
import base64
Index: mimify.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/mimify.py,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** mimify.py 1998/08/07 15:26:56 1.13
--- mimify.py 2000/02/04 15:10:33 1.14
***************
*** 3,7 ****
'''Mimification and unmimification of mail messages.
! decode quoted-printable parts of a mail message or encode using
quoted-printable.
--- 3,7 ----
'''Mimification and unmimification of mail messages.
! Decode quoted-printable parts of a mail message or encode using
quoted-printable.
***************
*** 40,46 ****
class File:
! '''A simple fake file object that knows about limited
! read-ahead and boundaries.
! The only supported method is readline().'''
def __init__(self, file, boundary):
--- 40,45 ----
class File:
! """A simple fake file object that knows about limited read-ahead and
! boundaries. The only supported method is readline()."""
def __init__(self, file, boundary):
***************
*** 88,92 ****
def mime_decode(line):
! '''Decode a single line of quoted-printable text to 8bit.'''
newline = ''
pos = 0
--- 87,91 ----
def mime_decode(line):
! """Decode a single line of quoted-printable text to 8bit."""
newline = ''
pos = 0
***************
*** 101,105 ****
def mime_decode_header(line):
! '''Decode a header line to 8bit.'''
newline = ''
pos = 0
--- 100,104 ----
def mime_decode_header(line):
! """Decode a header line to 8bit."""
newline = ''
pos = 0
***************
*** 116,120 ****
def unmimify_part(ifile, ofile, decode_base64 = 0):
! '''Convert a quoted-printable part of a MIME mail message to 8bit.'''
multipart = None
quoted_printable = 0
--- 115,119 ----
def unmimify_part(ifile, ofile, decode_base64 = 0):
! """Convert a quoted-printable part of a MIME mail message to 8bit."""
multipart = None
quoted_printable = 0
***************
*** 201,205 ****
def unmimify(infile, outfile, decode_base64 = 0):
! '''Convert quoted-printable parts of a MIME mail message to 8bit.'''
if type(infile) == type(''):
ifile = open(infile)
--- 200,204 ----
def unmimify(infile, outfile, decode_base64 = 0):
! """Convert quoted-printable parts of a MIME mail message to 8bit."""
if type(infile) == type(''):
ifile = open(infile)
***************
*** 222,227 ****
def mime_encode(line, header):
! '''Code a single line as quoted-printable.
! If header is set, quote some extra characters.'''
if header:
reg = mime_header_char
--- 221,226 ----
def mime_encode(line, header):
! """Code a single line as quoted-printable.
! If header is set, quote some extra characters."""
if header:
reg = mime_header_char
***************
*** 256,260 ****
def mime_encode_header(line):
! '''Code a single header line as quoted-printable.'''
newline = ''
pos = 0
--- 255,259 ----
def mime_encode_header(line):
! """Code a single header line as quoted-printable."""
newline = ''
pos = 0
***************
*** 274,278 ****
def mimify_part(ifile, ofile, is_mime):
! '''Convert an 8bit part of a MIME mail message to quoted-printable.'''
has_cte = is_qp = is_base64 = 0
multipart = None
--- 273,277 ----
def mimify_part(ifile, ofile, is_mime):
! """Convert an 8bit part of a MIME mail message to quoted-printable."""
has_cte = is_qp = is_base64 = 0
multipart = None
***************
*** 409,413 ****
def mimify(infile, outfile):
! '''Convert 8bit parts of a MIME mail message to quoted-printable.'''
if type(infile) == type(''):
ifile = open(infile)
--- 408,412 ----
def mimify(infile, outfile):
! """Convert 8bit parts of a MIME mail message to quoted-printable."""
if type(infile) == type(''):
ifile = open(infile)
Index: multifile.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/multifile.py,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** multifile.py 1998/06/29 17:58:43 1.8
--- multifile.py 2000/02/04 15:10:33 1.9
***************
*** 1,28 ****
! # A class that makes each part of a multipart message "feel" like an
! # ordinary file, as long as you use fp.readline(). Allows recursive
! # use, for nested multipart messages. Probably best used together
! # with module mimetools.
! #
! # Suggested use:
! #
! # real_fp = open(...)
! # fp = MultiFile(real_fp)
! #
! # "read some lines from fp"
! # fp.push(separator)
! # while 1:
! # "read lines from fp until it returns an empty string" (A)
! # if not fp.next(): break
! # fp.pop()
! # "read remaining lines from fp until it returns an empty string"
! #
! # The latter sequence may be used recursively at (A).
! # It is also allowed to use multiple push()...pop() sequences.
! #
! # If seekable is given as 0, the class code will not do the bookeeping
! # it normally attempts in order to make seeks relative to the beginning of the
! # current file part. This may be useful when using MultiFile with a non-
! # seekable stream object.
import sys
import string
--- 1,31 ----
! """A readline()-style interface to the parts of a multipart message.
+ The MultiFile class makes each part of a multipart message "feel" like
+ an ordinary file, as long as you use fp.readline(). Allows recursive
+ use, for nested multipart messages. Probably best used together
+ with module mimetools.
+
+ Suggested use:
+
+ real_fp = open(...)
+ fp = MultiFile(real_fp)
+
+ "read some lines from fp"
+ fp.push(separator)
+ while 1:
+ "read lines from fp until it returns an empty string" (A)
+ if not fp.next(): break
+ fp.pop()
+ "read remaining lines from fp until it returns an empty string"
+
+ The latter sequence may be used recursively at (A).
+ It is also allowed to use multiple push()...pop() sequences.
+
+ If seekable is given as 0, the class code will not do the bookeeping
+ it normally attempts in order to make seeks relative to the beginning of the
+ current file part. This may be useful when using MultiFile with a non-
+ seekable stream object.
+ """
+
import sys
import string
***************
*** 31,37 ****
class MultiFile:
! #
seekable = 0
! #
def __init__(self, fp, seekable=1):
self.fp = fp
--- 34,40 ----
class MultiFile:
!
seekable = 0
!
def __init__(self, fp, seekable=1):
self.fp = fp
***************
*** 43,52 ****
self.start = self.fp.tell()
self.posstack = [] # Grows down
! #
def tell(self):
if self.level > 0:
return self.lastpos
return self.fp.tell() - self.start
! #
def seek(self, pos, whence=0):
here = self.tell()
--- 46,55 ----
self.start = self.fp.tell()
self.posstack = [] # Grows down
!
def tell(self):
if self.level > 0:
return self.lastpos
return self.fp.tell() - self.start
!
def seek(self, pos, whence=0):
here = self.tell()
***************
*** 65,69 ****
self.level = 0
self.last = 0
! #
def readline(self):
if self.level > 0:
--- 68,72 ----
self.level = 0
self.last = 0
!
def readline(self):
if self.level > 0:
***************
*** 106,110 ****
raise Error,'Missing endmarker in MultiFile.readline()'
return ''
! #
def readlines(self):
list = []
--- 109,113 ----
raise Error,'Missing endmarker in MultiFile.readline()'
return ''
!
def readlines(self):
list = []
***************
*** 114,121 ****
list.append(line)
return list
! #
def read(self): # Note: no size argument -- read until EOF only!
return string.joinfields(self.readlines(), '')
! #
def next(self):
while self.readline(): pass
--- 117,124 ----
list.append(line)
return list
!
def read(self): # Note: no size argument -- read until EOF only!
return string.joinfields(self.readlines(), '')
!
def next(self):
while self.readline(): pass
***************
*** 127,131 ****
self.start = self.fp.tell()
return 1
! #
def push(self, sep):
if self.level > 0:
--- 130,134 ----
self.start = self.fp.tell()
return 1
!
def push(self, sep):
if self.level > 0:
***************
*** 135,139 ****
self.posstack.insert(0, self.start)
self.start = self.fp.tell()
! #
def pop(self):
if self.stack == []:
--- 138,142 ----
self.posstack.insert(0, self.start)
self.start = self.fp.tell()
!
def pop(self):
if self.stack == []:
***************
*** 150,160 ****
if self.level > 0:
self.lastpos = abslastpos - self.start
! #
def is_data(self, line):
return line[:2] <> '--'
! #
def section_divider(self, str):
return "--" + str
! #
def end_marker(self, str):
return "--" + str + "--"
--- 153,163 ----
if self.level > 0:
self.lastpos = abslastpos - self.start
!
def is_data(self, line):
return line[:2] <> '--'
!
def section_divider(self, str):
return "--" + str
!
def end_marker(self, str):
return "--" + str + "--"
Index: mutex.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/mutex.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** mutex.py 1996/10/08 14:06:17 1.5
--- mutex.py 2000/02/04 15:10:33 1.6
***************
*** 1,32 ****
! # Mutual exclusion -- for use with module sched
! # A mutex has two pieces of state -- a 'locked' bit and a queue.
! # When the mutex is not locked, the queue is empty.
! # Otherwise, the queue contains 0 or more (function, argument) pairs
! # representing functions (or methods) waiting to acquire the lock.
! # When the mutex is unlocked while the queue is not empty,
! # the first queue entry is removed and its function(argument) pair called,
! # implying it now has the lock.
! #
! # Of course, no multi-threading is implied -- hence the funny interface
! # for lock, where a function is called once the lock is aquired.
! #
class mutex:
- #
- # Create a new mutex -- initially unlocked
- #
def __init__(self):
self.locked = 0
self.queue = []
! #
! # Test the locked bit of the mutex
! #
def test(self):
return self.locked
! #
! # Atomic test-and-set -- grab the lock if it is not set,
! # return true if it succeeded
! #
def testandset(self):
if not self.locked:
self.locked = 1
--- 1,29 ----
! """Mutual exclusion -- for use with module sched
! A mutex has two pieces of state -- a 'locked' bit and a queue.
! When the mutex is not locked, the queue is empty.
! Otherwise, the queue contains 0 or more (function, argument) pairs
! representing functions (or methods) waiting to acquire the lock.
! When the mutex is unlocked while the queue is not empty,
! the first queue entry is removed and its function(argument) pair called,
! implying it now has the lock.
!
! Of course, no multi-threading is implied -- hence the funny interface
! for lock, where a function is called once the lock is aquired.
! """
!
class mutex:
def __init__(self):
+ """Create a new mutex -- initially unlocked."""
self.locked = 0
self.queue = []
!
def test(self):
+ """Test the locked bit of the mutex."""
return self.locked
!
def testandset(self):
+ """Atomic test-and-set -- grab the lock if it is not set,
+ return true if it succeeded."""
if not self.locked:
self.locked = 1
***************
*** 34,53 ****
else:
return 0
! #
! # Lock a mutex, call the function with supplied argument
! # when it is acquired.
! # If the mutex is already locked, place function and argument
! # in the queue.
! #
def lock(self, function, argument):
if self.testandset():
function(argument)
else:
self.queue.append((function, argument))
! #
! # Unlock a mutex. If the queue is not empty, call the next
! # function with its argument.
! #
def unlock(self):
if self.queue:
function, argument = self.queue[0]
--- 31,47 ----
else:
return 0
!
def lock(self, function, argument):
+ """Lock a mutex, call the function with supplied argument
+ when it is acquired. If the mutex is already locked, place
+ function and argument in the queue."""
if self.testandset():
function(argument)
else:
self.queue.append((function, argument))
!
def unlock(self):
+ """Unlock a mutex. If the queue is not empty, call the next
+ function with its argument."""
if self.queue:
function, argument = self.queue[0]
***************
*** 56,58 ****
else:
self.locked = 0
- #
--- 50,51 ----
Index: netrc.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/netrc.py,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** netrc.py 1999/05/03 18:10:37 1.3
--- netrc.py 2000/02/04 15:10:33 1.4
***************
*** 1,2 ****
--- 1,4 ----
+ """An object-oriented interface to .netrc files."""
+
# Module and documentation by Eric S. Raymond, 21 Dec 1998
***************
*** 64,68 ****
def authenticators(self, host):
! "Return a (user, account, password) tuple for given host."
if self.hosts.has_key(host):
return self.hosts[host]
--- 66,70 ----
def authenticators(self, host):
! """Return a (user, account, password) tuple for given host."""
if self.hosts.has_key(host):
return self.hosts[host]
***************
*** 73,77 ****
def __repr__(self):
! "Dump the class data in the format of a .netrc file"
rep = ""
for host in self.hosts.keys():
--- 75,79 ----
def __repr__(self):
! """Dump the class data in the format of a .netrc file."""
rep = ""
for host in self.hosts.keys():
Index: nntplib.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/nntplib.py,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** nntplib.py 1998/12/21 18:51:23 1.16
--- nntplib.py 2000/02/04 15:10:33 1.17
***************
*** 1,30 ****
! # An NNTP client class. Based on RFC 977: Network News Transfer
! # Protocol, by Brian Kantor and Phil Lapsley.
! # Example:
! #
! # >>> from nntplib import NNTP
! # >>> s = NNTP('news')
! # >>> resp, count, first, last, name = s.group('comp.lang.python')
! # >>> print 'Group', name, 'has', count, 'articles, range', first, 'to', last
! # Group comp.lang.python has 51 articles, range 5770 to 5821
! # >>> resp, subs = s.xhdr('subject', first + '-' + last)
! # >>> resp = s.quit()
! # >>>
! #
! # Here 'resp' is the server response line.
! # Error responses are turned into exceptions.
! #
! # To post an article from a file:
! # >>> f = open(filename, 'r') # file containing article, including header
! # >>> resp = s.post(f)
! # >>>
! #
! # For descriptions of all methods, read the comments in the code below.
! # Note that all arguments and return values representing article numbers
! # are strings, not numbers, since they are rarely used for calculations.
! # (xover, xgtitle, xpath, date methods by Kevan Heydon)
--- 1,30 ----
! """An NNTP client class based on RFC 977: Network News Transfer Protocol.
+ Example:
! >>> from nntplib import NNTP
! >>> s = NNTP('news')
! >>> resp, count, first, last, name = s.group('comp.lang.python')
! >>> print 'Group', name, 'has', count, 'articles, range', first, 'to', last
! Group comp.lang.python has 51 articles, range 5770 to 5821
! >>> resp, subs = s.xhdr('subject', first + '-' + last)
! >>> resp = s.quit()
! >>>
!
! Here 'resp' is the server response line.
! Error responses are turned into exceptions.
!
! To post an article from a file:
! >>> f = open(filename, 'r') # file containing article, including header
! >>> resp = s.post(f)
! >>>
!
! For descriptions of all methods, read the comments in the code below.
! Note that all arguments and return values representing article numbers
! are strings, not numbers, since they are rarely used for calculations.
! """
! # RFC 977 by Brian Kantor and Phil Lapsley.
! # xover, xgtitle, xpath, date methods by Kevan Heydon
***************
*** 36,40 ****
# Exception raised when an error or invalid response is received
-
error_reply = 'nntplib.error_reply' # unexpected [123]xx reply
error_temp = 'nntplib.error_temp' # 4xx errors
--- 36,39 ----
***************
*** 60,68 ****
class NNTP:
- # Initialize an instance. Arguments:
- # - host: hostname to connect to
- # - port: port to connect to (default the standard NNTP port)
-
def __init__(self, host, port = NNTP_PORT, user=None, password=None):
self.host = host
self.port = port
--- 59,67 ----
class NNTP:
def __init__(self, host, port = NNTP_PORT, user=None, password=None):
+ """Initialize an instance. Arguments:
+ - host: hostname to connect to
+ - port: port to connect to (default the standard NNTP port)"""
+
self.host = host
self.port = port
***************
*** 83,118 ****
raise error_perm, resp
- # Get the welcome message from the server
- # (this is read and squirreled away by __init__()).
- # If the response code is 200, posting is allowed;
- # if it 201, posting is not allowed
-
def getwelcome(self):
if self.debugging: print '*welcome*', `self.welcome`
return self.welcome
- # Set the debugging level. Argument level means:
- # 0: no debugging output (default)
- # 1: print commands and responses but not body text etc.
- # 2: also print raw lines read and sent before stripping CR/LF
-
def set_debuglevel(self, level):
self.debugging = level
debug = set_debuglevel
- # Internal: send one line to the server, appending CRLF
def putline(self, line):
line = line + CRLF
if self.debugging > 1: print '*put*', `line`
self.sock.send(line)
- # Internal: send one command to the server (through putline())
def putcmd(self, line):
if self.debugging: print '*cmd*', `line`
self.putline(line)
- # Internal: return one line from the server, stripping CRLF.
- # Raise EOFError if the connection is closed
def getline(self):
line = self.file.readline()
if self.debugging > 1:
--- 82,117 ----
raise error_perm, resp
def getwelcome(self):
+ """Get the welcome message from the server
+ (this is read and squirreled away by __init__()).
+ If the response code is 200, posting is allowed;
+ if it 201, posting is not allowed."""
+
if self.debugging: print '*welcome*', `self.welcome`
return self.welcome
def set_debuglevel(self, level):
+ """Set the debugging level. Argument 'level' means:
+ 0: no debugging output (default)
+ 1: print commands and responses but not body text etc.
+ 2: also print raw lines read and sent before stripping CR/LF"""
+
self.debugging = level
debug = set_debuglevel
def putline(self, line):
+ """Internal: send one line to the server, appending CRLF."""
line = line + CRLF
if self.debugging > 1: print '*put*', `line`
self.sock.send(line)
def putcmd(self, line):
+ """Internal: send one command to the server (through putline())."""
if self.debugging: print '*cmd*', `line`
self.putline(line)
def getline(self):
+ """Internal: return one line from the server, stripping CRLF.
+ Raise EOFError if the connection is closed."""
line = self.file.readline()
if self.debugging > 1:
***************
*** 123,129 ****
return line
- # Internal: get a response from the server.
- # Raise various errors if the response indicates an error
def getresp(self):
resp = self.getline()
if self.debugging: print '*resp*', `resp`
--- 122,128 ----
return line
def getresp(self):
+ """Internal: get a response from the server.
+ Raise various errors if the response indicates an error."""
resp = self.getline()
if self.debugging: print '*resp*', `resp`
***************
*** 137,143 ****
return resp
- # Internal: get a response plus following text from the server.
- # Raise various errors if the response indicates an error
def getlongresp(self):
resp = self.getresp()
if resp[:3] not in LONGRESP:
--- 136,142 ----
return resp
def getlongresp(self):
+ """Internal: get a response plus following text from the server.
+ Raise various errors if the response indicates an error."""
resp = self.getresp()
if resp[:3] not in LONGRESP:
***************
*** 153,193 ****
return resp, list
- # Internal: send a command and get the response
def shortcmd(self, line):
self.putcmd(line)
return self.getresp()
- # Internal: send a command and get the response plus following text
def longcmd(self, line):
self.putcmd(line)
return self.getlongresp()
- # Process a NEWGROUPS command. Arguments:
- # - date: string 'yymmdd' indicating the date
- # - time: string 'hhmmss' indicating the time
- # Return:
- # - resp: server response if succesful
- # - list: list of newsgroup names
-
def newgroups(self, date, time):
! return self.longcmd('NEWGROUPS ' + date + ' ' + time)
! # Process a NEWNEWS command. Arguments:
! # - group: group name or '*'
! # - date: string 'yymmdd' indicating the date
! # - time: string 'hhmmss' indicating the time
! # Return:
! # - resp: server response if succesful
! # - list: list of article ids
def newnews(self, group, date, time):
cmd = 'NEWNEWS ' + group + ' ' + date + ' ' + time
return self.longcmd(cmd)
- # Process a LIST command. Return:
- # - resp: server response if succesful
- # - list: list of (group, last, first, flag) (strings)
-
def list(self):
resp, list = self.longcmd('LIST')
for i in range(len(list)):
--- 152,192 ----
return resp, list
def shortcmd(self, line):
+ """Internal: send a command and get the response."""
self.putcmd(line)
return self.getresp()
def longcmd(self, line):
+ """Internal: send a command and get the response plus following text."""
self.putcmd(line)
return self.getlongresp()
def newgroups(self, date, time):
! """Process a NEWGROUPS command. Arguments:
! - date: string 'yymmdd' indicating the date
! - time: string 'hhmmss' indicating the time
! Return:
! - resp: server response if succesful
! - list: list of newsgroup names"""
! return self.longcmd('NEWGROUPS ' + date + ' ' + time)
def newnews(self, group, date, time):
+ """Process a NEWNEWS command. Arguments:
+ - group: group name or '*'
+ - date: string 'yymmdd' indicating the date
+ - time: string 'hhmmss' indicating the time
+ Return:
+ - resp: server response if succesful
+ - list: list of article ids"""
+
cmd = 'NEWNEWS ' + group + ' ' + date + ' ' + time
return self.longcmd(cmd)
def list(self):
+ """Process a LIST command. Return:
+ - resp: server response if succesful
+ - list: list of (group, last, first, flag) (strings)"""
+
resp, list = self.longcmd('LIST')
for i in range(len(list)):
***************
*** 196,209 ****
return resp, list
- # Process a GROUP command. Argument:
- # - group: the group name
- # Returns:
- # - resp: server response if succesful
- # - count: number of articles (string)
- # - first: first article number (string)
- # - last: last article number (string)
- # - name: the group name
-
def group(self, name):
resp = self.shortcmd('GROUP ' + name)
if resp[:3] <> '211':
--- 195,208 ----
return resp, list
def group(self, name):
+ """Process a GROUP command. Argument:
+ - group: the group name
+ Returns:
+ - resp: server response if succesful
+ - count: number of articles (string)
+ - first: first article number (string)
+ - last: last article number (string)
+ - name: the group name"""
+
resp = self.shortcmd('GROUP ' + name)
if resp[:3] <> '211':
***************
*** 222,234 ****
return resp, count, first, last, name
- # Process a HELP command. Returns:
- # - resp: server response if succesful
- # - list: list of strings
-
def help(self):
return self.longcmd('HELP')
- # Internal: parse the response of a STAT, NEXT or LAST command
def statparse(self, resp):
if resp[:2] <> '22':
raise error_reply, resp
--- 221,233 ----
return resp, count, first, last, name
def help(self):
+ """Process a HELP command. Returns:
+ - resp: server response if succesful
+ - list: list of strings"""
+
return self.longcmd('HELP')
def statparse(self, resp):
+ """Internal: parse the response of a STAT, NEXT or LAST command."""
if resp[:2] <> '22':
raise error_reply, resp
***************
*** 243,324 ****
return resp, nr, id
- # Internal: process a STAT, NEXT or LAST command
def statcmd(self, line):
resp = self.shortcmd(line)
return self.statparse(resp)
- # Process a STAT command. Argument:
- # - id: article number or message id
- # Returns:
- # - resp: server response if succesful
- # - nr: the article number
- # - id: the article id
-
def stat(self, id):
! return self.statcmd('STAT ' + id)
! # Process a NEXT command. No arguments. Return as for STAT
def next(self):
return self.statcmd('NEXT')
- # Process a LAST command. No arguments. Return as for STAT
-
def last(self):
return self.statcmd('LAST')
- # Internal: process a HEAD, BODY or ARTICLE command
def artcmd(self, line):
resp, list = self.longcmd(line)
resp, nr, id = self.statparse(resp)
return resp, nr, id, list
- # Process a HEAD command. Argument:
- # - id: article number or message id
- # Returns:
- # - resp: server response if succesful
- # - nr: article number
- # - id: message id
- # - list: the lines of the article's header
-
def head(self, id):
! return self.artcmd('HEAD ' + id)
! # Process a BODY command. Argument:
! # - id: article number or message id
! # Returns:
! # - resp: server response if succesful
! # - nr: article number
! # - id: message id
! # - list: the lines of the article's body
def body(self, id):
! return self.artcmd('BODY ' + id)
! # Process an ARTICLE command. Argument:
! # - id: article number or message id
! # Returns:
! # - resp: server response if succesful
! # - nr: article number
! # - id: message id
! # - list: the lines of the article
def article(self, id):
! return self.artcmd('ARTICLE ' + id)
! # Process a SLAVE command. Returns:
! # - resp: server response if succesful
def slave(self):
! return self.shortcmd('SLAVE')
! # Process an XHDR command (optional server extension). Arguments:
! # - hdr: the header type (e.g. 'subject')
! # - str: an article nr, a message id, or a range nr1-nr2
! # Returns:
! # - resp: server response if succesful
! # - list: list of (nr, value) strings
def xhdr(self, hdr, str):
pat = re.compile('^([0-9]+) ?(.*)\n?')
resp, lines = self.longcmd('XHDR ' + hdr + ' ' + str)
--- 242,321 ----
return resp, nr, id
def statcmd(self, line):
+ """Internal: process a STAT, NEXT or LAST command."""
resp = self.shortcmd(line)
return self.statparse(resp)
def stat(self, id):
! """Process a STAT command. Argument:
! - id: article number or message id
! Returns:
! - resp: server response if succesful
! - nr: the article number
! - id: the article id"""
! return self.statcmd('STAT ' + id)
def next(self):
+ """Process a NEXT command. No arguments. Return as for STAT."""
return self.statcmd('NEXT')
def last(self):
+ """Process a LAST command. No arguments. Return as for STAT."""
return self.statcmd('LAST')
def artcmd(self, line):
+ """Internal: process a HEAD, BODY or ARTICLE command."""
resp, list = self.longcmd(line)
resp, nr, id = self.statparse(resp)
return resp, nr, id, list
def head(self, id):
! """Process a HEAD command. Argument:
! - id: article number or message id
! Returns:
! - resp: server response if succesful
! - nr: article number
! - id: message id
! - list: the lines of the article's header"""
! return self.artcmd('HEAD ' + id)
def body(self, id):
! """Process a BODY command. Argument:
! - id: article number or message id
! Returns:
! - resp: server response if succesful
! - nr: article number
! - id: message id
! - list: the lines of the article's body"""
! return self.artcmd('BODY ' + id)
def article(self, id):
! """Process an ARTICLE command. Argument:
! - id: article number or message id
! Returns:
! - resp: server response if succesful
! - nr: article number
! - id: message id
! - list: the lines of the article"""
! return self.artcmd('ARTICLE ' + id)
def slave(self):
! """Process a SLAVE command. Returns:
! - resp: server response if succesful"""
! return self.shortcmd('SLAVE')
def xhdr(self, hdr, str):
+ """Process an XHDR command (optional server extension). Arguments:
+ - hdr: the header type (e.g. 'subject')
+ - str: an article nr, a message id, or a range nr1-nr2
+ Returns:
+ - resp: server response if succesful
+ - list: list of (nr, value) strings"""
+
pat = re.compile('^([0-9]+) ?(.*)\n?')
resp, lines = self.longcmd('XHDR ' + hdr + ' ' + str)
***************
*** 330,341 ****
return resp, lines
- # Process an XOVER command (optional server extension) Arguments:
- # - start: start of range
- # - end: end of range
- # Returns:
- # - resp: server response if succesful
- # - list: list of (art-nr, subject, poster, date, id, refrences, size, lines)
-
def xover(self,start,end):
resp, lines = self.longcmd('XOVER ' + start + '-' + end)
xover_lines = []
--- 327,339 ----
return resp, lines
def xover(self,start,end):
+ """Process an XOVER command (optional server extension) Arguments:
+ - start: start of range
+ - end: end of range
+ Returns:
+ - resp: server response if succesful
+ - list: list of (art-nr, subject, poster, date,
+ id, references, size, lines)"""
+
resp, lines = self.longcmd('XOVER ' + start + '-' + end)
xover_lines = []
***************
*** 355,365 ****
return resp,xover_lines
- # Process an XGTITLE command (optional server extension) Arguments:
- # - group: group name wildcard (i.e. news.*)
- # Returns:
- # - resp: server response if succesful
- # - list: list of (name,title) strings
-
def xgtitle(self, group):
line_pat = re.compile("^([^ \t]+)[ \t]+(.*)$")
resp, raw_lines = self.longcmd('XGTITLE ' + group)
--- 353,363 ----
return resp,xover_lines
def xgtitle(self, group):
+ """Process an XGTITLE command (optional server extension) Arguments:
+ - group: group name wildcard (i.e. news.*)
+ Returns:
+ - resp: server response if succesful
+ - list: list of (name,title) strings"""
+
line_pat = re.compile("^([^ \t]+)[ \t]+(.*)$")
resp, raw_lines = self.longcmd('XGTITLE ' + group)
***************
*** 371,381 ****
return resp, lines
- # Process an XPATH command (optional server extension) Arguments:
- # - id: Message id of article
- # Returns:
- # resp: server response if succesful
- # path: directory path to article
-
def xpath(self,id):
resp = self.shortcmd("XPATH " + id)
if resp[:3] <> '223':
--- 369,379 ----
return resp, lines
def xpath(self,id):
+ """Process an XPATH command (optional server extension) Arguments:
+ - id: Message id of article
+ Returns:
+ resp: server response if succesful
+ path: directory path to article"""
+
resp = self.shortcmd("XPATH " + id)
if resp[:3] <> '223':
***************
*** 388,399 ****
return resp, path
- # Process the DATE command. Arguments:
- # None
- # Returns:
- # resp: server response if succesful
- # date: Date suitable for newnews/newgroups commands etc.
- # time: Time suitable for newnews/newgroups commands etc.
-
def date (self):
resp = self.shortcmd("DATE")
if resp[:3] <> '111':
--- 386,397 ----
return resp, path
def date (self):
+ """Process the DATE command. Arguments:
+ None
+ Returns:
+ resp: server response if succesful
+ date: Date suitable for newnews/newgroups commands etc.
+ time: Time suitable for newnews/newgroups commands etc."""
+
resp = self.shortcmd("DATE")
if resp[:3] <> '111':
***************
*** 409,418 ****
- # Process a POST command. Arguments:
- # - f: file containing the article
- # Returns:
- # - resp: server response if succesful
-
def post(self, f):
resp = self.shortcmd('POST')
# Raises error_??? if posting is not allowed
--- 407,416 ----
def post(self, f):
+ """Process a POST command. Arguments:
+ - f: file containing the article
+ Returns:
+ - resp: server response if succesful"""
+
resp = self.shortcmd('POST')
# Raises error_??? if posting is not allowed
***************
*** 431,442 ****
return self.getresp()
- # Process an IHAVE command. Arguments:
- # - id: message-id of the article
- # - f: file containing the article
- # Returns:
- # - resp: server response if succesful
- # Note that if the server refuses the article an exception is raised
-
def ihave(self, id, f):
resp = self.shortcmd('IHAVE ' + id)
# Raises error_??? if the server already has it
--- 429,440 ----
return self.getresp()
def ihave(self, id, f):
+ """Process an IHAVE command. Arguments:
+ - id: message-id of the article
+ - f: file containing the article
+ Returns:
+ - resp: server response if succesful
+ Note that if the server refuses the article an exception is raised."""
+
resp = self.shortcmd('IHAVE ' + id)
# Raises error_??? if the server already has it
***************
*** 455,462 ****
return self.getresp()
- # Process a QUIT command and close the socket. Returns:
- # - resp: server response if succesful
-
def quit(self):
resp = self.shortcmd('QUIT')
self.file.close()
--- 453,460 ----
return self.getresp()
def quit(self):
+ """Process a QUIT command and close the socket. Returns:
+ - resp: server response if succesful"""
+
resp = self.shortcmd('QUIT')
self.file.close()
***************
*** 466,471 ****
- # Minimal test function
def _test():
s = NNTP('news')
resp, count, first, last, name = s.group('comp.lang.python')
--- 464,469 ----
def _test():
+ """Minimal test function."""
s = NNTP('news')
resp, count, first, last, name = s.group('comp.lang.python')
Index: nturl2path.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/nturl2path.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** nturl2path.py 1999/03/18 14:21:41 1.4
--- nturl2path.py 2000/02/04 15:10:33 1.5
***************
*** 1,5 ****
! #
! # nturl2path convert a NT pathname to a file URL and
! # vice versa
def url2pathname(url):
--- 1,3 ----
! """Convert a NT pathname to a file URL and vice versa."""
def url2pathname(url):
***************
*** 35,39 ****
def pathname2url(p):
-
""" Convert a DOS path name to a file url...
C:\foo\bar\spam.foo
--- 33,36 ----
Index: os.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/os.py,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -r1.28 -r1.29
*** os.py 1999/11/02 20:44:07 1.28
--- os.py 2000/02/04 15:10:33 1.29
***************
*** 1,20 ****
! # os.py -- either mac, dos or posix depending on what system we're on.
! # This exports:
! # - all functions from either posix or mac, e.g., os.unlink, os.stat, etc.
! # - os.path is either module posixpath or macpath
! # - os.name is either 'posix' or 'mac'
! # - 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.altsep is the alternatte pathname separator (None or '/')
! # - os.pathsep is the component separator used in $PATH etc
! # - os.defpath is the default search path for executables
! # 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).
import sys
--- 1,21 ----
! """os.py -- either mac, dos or posix depending on what system we're on.
! This exports:
! - all functions from either posix or mac, e.g., os.unlink, os.stat, etc.
! - os.path is either module posixpath or macpath
! - os.name is either 'posix' or 'mac'
! - 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.altsep is the alternatte pathname separator (None or '/')
! - os.pathsep is the component separator used in $PATH etc
! - os.defpath is the default search path for executables
! 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).
! """
import sys
Index: pdb.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/pdb.py,v
retrieving revision 1.40
retrieving revision 1.41
diff -C2 -r1.40 -r1.41
*** pdb.py 1999/11/03 13:10:07 1.40
--- pdb.py 2000/02/04 15:10:33 1.41
***************
*** 1,5 ****
#! /usr/bin/env python
! # pdb.py -- finally, a Python debugger!
# (See pdb.doc for documentation.)
--- 1,5 ----
#! /usr/bin/env python
! """pdb.py -- finally, a Python debugger!"""
# (See pdb.doc for documentation.)
***************
*** 107,115 ****
def user_line(self, frame):
! # This function is called when we stop or break at this line
self.interaction(frame, None)
def user_return(self, frame, return_value):
! # This function is called when a return trap is set here
frame.f_locals['__return__'] = return_value
print '--Return--'
--- 107,115 ----
def user_line(self, frame):
! """This function is called when we stop or break at this line."""
self.interaction(frame, None)
def user_return(self, frame, return_value):
! """This function is called when a return trap is set here."""
frame.f_locals['__return__'] = return_value
print '--Return--'
***************
*** 117,122 ****
def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
! # This function is called if an exception occurs,
! # but only if we are to stop at or just below this level
frame.f_locals['__exception__'] = exc_type, exc_value
if type(exc_type) == type(''):
--- 117,122 ----
def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
! """This function is called if an exception occurs,
! but only if we are to stop at or just below this level."""
frame.f_locals['__exception__'] = exc_type, exc_value
if type(exc_type) == type(''):
***************
*** 149,153 ****
def precmd(self, line):
! # Handle alias expansion and ';;' separator
if not line:
return line
--- 149,153 ----
def precmd(self, line):
! """Handle alias expansion and ';;' separator."""
if not line:
return line
***************
*** 263,267 ****
# To be overridden in derived debuggers
def defaultFile(self):
! # Produce a reasonable default
filename = self.curframe.f_code.co_filename
if filename == '<string>' and mainpyfile:
--- 263,267 ----
# To be overridden in derived debuggers
def defaultFile(self):
! """Produce a reasonable default."""
filename = self.curframe.f_code.co_filename
if filename == '<string>' and mainpyfile:
***************
*** 385,389 ****
def do_ignore(self,arg):
! # arg is bp number followed by ignore count
args = string.split(arg)
bpnum = int(string.strip(args[0]))
--- 385,389 ----
def do_ignore(self,arg):
! """arg is bp number followed by ignore count."""
args = string.split(arg)
bpnum = int(string.strip(args[0]))
***************
*** 407,414 ****
def do_clear(self, arg):
! # Three possibilities, tried in this order:
! # clear -> clear all breaks, ask for confirmation
! # clear file:lineno -> clear all breaks at file:lineno
! # clear bpno bpno ... -> clear breakpoints by number
if not arg:
try:
--- 407,414 ----
def do_clear(self, arg):
! """Three possibilities, tried in this order:
! clear -> clear all breaks, ask for confirmation
! clear file:lineno -> clear all breaks at file:lineno
! clear bpno bpno ... -> clear breakpoints by number"""
if not arg:
try:
***************
*** 852,858 ****
help()
- # Helper function for break/clear parsing -- may be overridden
-
def lookupmodule(self, filename):
root, ext = os.path.splitext(filename)
if ext == '':
--- 852,857 ----
help()
def lookupmodule(self, filename):
+ """Helper function for break/clear parsing -- may be overridden."""
root, ext = os.path.splitext(filename)
if ext == '':
Index: pickle.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/pickle.py,v
retrieving revision 1.35
retrieving revision 1.36
diff -C2 -r1.35 -r1.36
*** pickle.py 1999/10/10 21:14:25 1.35
--- pickle.py 2000/02/04 15:10:33 1.36
***************
*** 1,3 ****
! """create portable serialized representations of Python objects.
See module cPickle for a (much) faster implementation.
--- 1,3 ----
! """Create portable serialized representations of Python objects.
See module cPickle for a (much) faster implementation.
***************
*** 24,28 ****
"""
! __version__ = "$Revision: 1.35 $" # Code version
from types import *
--- 24,28 ----
"""
! __version__ = "$Revision: 1.36 $" # Code version
from types import *
Index: pipes.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/pipes.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** pipes.py 1999/05/03 18:12:36 1.4
--- pipes.py 2000/02/04 15:10:34 1.5
***************
*** 1,64 ****
! # Conversion pipeline templates
! # =============================
! # The problem:
! # ------------
! #
! # Suppose you have some data that you want to convert to another format
! # (e.g. from GIF image format to PPM image format). Maybe the
! # conversion involves several steps (e.g. piping it through compress or
! # uuencode). Some of the conversion steps may require that their input
! # is a disk file, others may be able to read standard input; similar for
! # their output. The input to the entire conversion may also be read
! # from a disk file or from an open file, and similar for its output.
! #
! # The module lets you construct a pipeline template by sticking one or
! # more conversion steps together. It will take care of creating and
! # removing temporary files if they are necessary to hold intermediate
! # data. You can then use the template to do conversions from many
! # different sources to many different destinations. The temporary
! # file names used are different each time the template is used.
! #
! # The templates are objects so you can create templates for many
! # different conversion steps and store them in a dictionary, for
! # instance.
!
!
! # Directions:
! # -----------
! #
! # To create a template:
! # t = Template()
! #
! # To add a conversion step to a template:
! # t.append(command, kind)
! # where kind is a string of two characters: the first is '-' if the
! # command reads its standard input or 'f' if it requires a file; the
! # second likewise for the output. The command must be valid /bin/sh
! # syntax. If input or output files are required, they are passed as
! # $IN and $OUT; otherwise, it must be possible to use the command in
! # a pipeline.
! #
! # To add a conversion step at the beginning:
! # t.prepend(command, kind)
! #
! # To convert a file to another file using a template:
! # sts = t.copy(infile, outfile)
! # If infile or outfile are the empty string, standard input is read or
! # standard output is written, respectively. The return value is the
! # exit status of the conversion pipeline.
! #
! # To open a file for reading or writing through a conversion pipeline:
! # fp = t.open(file, mode)
! # where mode is 'r' to read the file, or 'w' to write it -- just like
! # for the built-in function open() or for os.popen().
! #
! # To create a new template object initialized to a given one:
! # t2 = t.clone()
! #
! # For an example, see the function test() at the end of the file.
import sys
import re
--- 1,63 ----
! """Conversion pipeline templates.
+ The problem:
+ ------------
! Suppose you have some data that you want to convert to another format
! (e.g. from GIF image format to PPM image format). Maybe the
! conversion involves several steps (e.g. piping it through compress or
! uuencode). Some of the conversion steps may require that their input
! is a disk file, others may be able to read standard input; similar for
! their output. The input to the entire conversion may also be read
! from a disk file or from an open file, and similar for its output.
!
! The module lets you construct a pipeline template by sticking one or
! more conversion steps together. It will take care of creating and
! removing temporary files if they are necessary to hold intermediate
! data. You can then use the template to do conversions from many
! different sources to many different destinations. The temporary
! file names used are different each time the template is used.
!
! The templates are objects so you can create templates for many
! different conversion steps and store them in a dictionary, for
! instance.
!
!
! Directions:
! -----------
!
! To create a template:
! t = Template()
!
! To add a conversion step to a template:
! t.append(command, kind)
! where kind is a string of two characters: the first is '-' if the
! command reads its standard input or 'f' if it requires a file; the
! second likewise for the output. The command must be valid /bin/sh
! syntax. If input or output files are required, they are passed as
! $IN and $OUT; otherwise, it must be possible to use the command in
! a pipeline.
!
! To add a conversion step at the beginning:
! t.prepend(command, kind)
!
! To convert a file to another file using a template:
! sts = t.copy(infile, outfile)
! If infile or outfile are the empty string, standard input is read or
! standard output is written, respectively. The return value is the
! exit status of the conversion pipeline.
!
! To open a file for reading or writing through a conversion pipeline:
! fp = t.open(file, mode)
! where mode is 'r' to read the file, or 'w' to write it -- just like
! for the built-in function open() or for os.popen().
+ To create a new template object initialized to a given one:
+ t2 = t.clone()
+ For an example, see the function test() at the end of the file.
+ """
+
+
import sys
import re
***************
*** 82,105 ****
- # A pipeline template is a Template object:
-
class Template:
- # Template() returns a fresh pipeline template
def __init__(self):
self.debugging = 0
self.reset()
- # t.__repr__() implements `t`
def __repr__(self):
return '<Template instance, steps=' + `self.steps` + '>'
- # t.reset() restores a pipeline template to its initial state
def reset(self):
self.steps = []
- # t.clone() returns a new pipeline template with identical
- # initial state as the current one
def clone(self):
t = Template()
t.steps = self.steps[:]
--- 81,103 ----
class Template:
+ """Class representing a pipeline template."""
def __init__(self):
+ """Template() returns a fresh pipeline template."""
self.debugging = 0
self.reset()
def __repr__(self):
+ """t.__repr__() implements `t`."""
return '<Template instance, steps=' + `self.steps` + '>'
def reset(self):
+ """t.reset() restores a pipeline template to its initial state."""
self.steps = []
def clone(self):
+ """t.clone() returns a new pipeline template with identical
+ initial state as the current one."""
t = Template()
t.steps = self.steps[:]
***************
*** 107,116 ****
return t
- # t.debug(flag) turns debugging on or off
def debug(self, flag):
self.debugging = flag
- # t.append(cmd, kind) adds a new step at the end
def append(self, cmd, kind):
if type(cmd) <> type(''):
raise TypeError, \
--- 105,114 ----
return t
def debug(self, flag):
+ """t.debug(flag) turns debugging on or off."""
self.debugging = flag
def append(self, cmd, kind):
+ """t.append(cmd, kind) adds a new step at the end."""
if type(cmd) <> type(''):
raise TypeError, \
***************
*** 133,138 ****
self.steps.append((cmd, kind))
- # t.prepend(cmd, kind) adds a new step at the front
def prepend(self, cmd, kind):
if type(cmd) <> type(''):
raise TypeError, \
--- 131,136 ----
self.steps.append((cmd, kind))
def prepend(self, cmd, kind):
+ """t.prepend(cmd, kind) adds a new step at the front."""
if type(cmd) <> type(''):
raise TypeError, \
***************
*** 155,161 ****
self.steps.insert(0, (cmd, kind))
- # t.open(file, rw) returns a pipe or file object open for
- # reading or writing; the file is the other end of the pipeline
def open(self, file, rw):
if rw == 'r':
return self.open_r(file)
--- 153,159 ----
self.steps.insert(0, (cmd, kind))
def open(self, file, rw):
+ """t.open(file, rw) returns a pipe or file object open for
+ reading or writing; the file is the other end of the pipeline."""
if rw == 'r':
return self.open_r(file)
***************
*** 165,172 ****
'Template.open: rw must be \'r\' or \'w\', not ' + `rw`
- # t.open_r(file) and t.open_w(file) implement
- # t.open(file, 'r') and t.open(file, 'w') respectively
-
def open_r(self, file):
if self.steps == []:
return open(file, 'r')
--- 163,169 ----
'Template.open: rw must be \'r\' or \'w\', not ' + `rw`
def open_r(self, file):
+ """t.open_r(file) and t.open_w(file) implement
+ t.open(file, 'r') and t.open(file, 'w') respectively."""
if self.steps == []:
return open(file, 'r')
Index: popen2.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/popen2.py,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** popen2.py 1999/04/20 12:27:31 1.8
--- popen2.py 2000/02/04 15:10:34 1.9
***************
*** 1,2 ****
--- 1,10 ----
+ """Spawn a command with pipes to its stdin, stdout, and optionally stderr.
+
+ The normal os.popen(cmd, mode) call spawns a shell command and provides a
+ file interface to just the input or output of the process depending on
+ whether mode is 'r' or 'w'. This module provides the functions popen2(cmd)
+ and popen3(cmd) which return two or three pipes to the spawned command.
+ """
+
import os
import sys
***************
*** 12,16 ****
--- 20,32 ----
class Popen3:
+ """Class representing a child process. Normally instances are created
+ by the factory functions popen2() and popen3()."""
+
def __init__(self, cmd, capturestderr=0, bufsize=-1):
+ """The parameter 'cmd' is the shell command to execute in a
+ sub-process. The 'capturestderr' flag, if true, specifies that
+ the object should capture standard error output of the child process.
+ The default is false. If the 'bufsize' parameter is specified, it
+ specifies the size of the I/O buffers to/from the child process."""
if type(cmd) == type(''):
cmd = ['/bin/sh', '-c', cmd]
***************
*** 52,56 ****
--- 68,75 ----
self.sts = -1 # Child not completed yet
_active.append(self)
+
def poll(self):
+ """Return the exit status of the child process if it has finished,
+ or -1 if it hasn't finished yet."""
if self.sts < 0:
try:
***************
*** 62,66 ****
--- 81,87 ----
pass
return self.sts
+
def wait(self):
+ """Wait for and return the exit status of the child process."""
pid, sts = os.waitpid(self.pid, 0)
if pid == self.pid:
***************
*** 70,73 ****
--- 91,97 ----
def popen2(cmd, bufsize=-1):
+ """Execute the shell command 'cmd' in a sub-process. If 'bufsize' is
+ specified, it sets the buffer size for the I/O pipes. The file objects
+ (child_stdout, child_stdin) are returned."""
_cleanup()
inst = Popen3(cmd, 0, bufsize)
***************
*** 75,78 ****
--- 99,105 ----
def popen3(cmd, bufsize=-1):
+ """Execute the shell command 'cmd' in a sub-process. If 'bufsize' is
+ specified, it sets the buffer size for the I/O pipes. The file objects
+ (child_stdout, child_stdin, child_stderr) are returned."""
_cleanup()
inst = Popen3(cmd, 1, bufsize)
Index: posixfile.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/posixfile.py,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** posixfile.py 1999/12/06 14:51:05 1.12
--- posixfile.py 2000/02/04 15:10:34 1.13
***************
*** 1,63 ****
! #
! # Start of posixfile.py
! #
!
! #
! # Extended file operations
! #
! # f = posixfile.open(filename, [mode, [bufsize]])
! # will create a new posixfile object
! #
! # f = posixfile.fileopen(fileobject)
! # will create a posixfile object from a builtin file object
! #
! # f.file()
! # will return the original builtin file object
! #
! # f.dup()
! # will return a new file object based on a new filedescriptor
! #
! # f.dup2(fd)
! # will return a new file object based on the given filedescriptor
! #
! # f.flags(mode)
! # will turn on the associated flag (merge)
! # mode can contain the following characters:
! #
! # (character representing a flag)
! # a append only flag
! # c close on exec flag
! # n no delay flag
! # s synchronization flag
! # (modifiers)
! # ! turn flags 'off' instead of default 'on'
! # = copy flags 'as is' instead of default 'merge'
! # ? return a string in which the characters represent the flags
! # that are set
! #
! # note: - the '!' and '=' modifiers are mutually exclusive.
! # - the '?' modifier will return the status of the flags after they
! # have been changed by other characters in the mode string
! #
! # f.lock(mode [, len [, start [, whence]]])
! # will (un)lock a region
! # mode can contain the following characters:
! #
! # (character representing type of lock)
! # u unlock
! # r read lock
! # w write lock
! # (modifiers)
! # | wait until the lock can be granted
! # ? return the first lock conflicting with the requested lock
! # or 'None' if there is no conflict. The lock returned is in the
! # format (mode, len, start, whence, pid) where mode is a
! # character representing the type of lock ('r' or 'w')
! #
! # note: - the '?' modifier prevents a region from being locked; it is
! # query only
! #
class _posixfile_:
states = ['open', 'closed']
--- 1,60 ----
! """Extended file operations available in POSIX.
+ f = posixfile.open(filename, [mode, [bufsize]])
+ will create a new posixfile object
+
+ f = posixfile.fileopen(fileobject)
+ will create a posixfile object from a builtin file object
+
+ f.file()
+ will return the original builtin file object
+
+ f.dup()
+ will return a new file object based on a new filedescriptor
+
+ f.dup2(fd)
+ will return a new file object based on the given filedescriptor
+
+ f.flags(mode)
+ will turn on the associated flag (merge)
+ mode can contain the following characters:
+
+ (character representing a flag)
+ a append only flag
+ c close on exec flag
+ n no delay flag
+ s synchronization flag
+ (modifiers)
+ ! turn flags 'off' instead of default 'on'
+ = copy flags 'as is' instead of default 'merge'
+ ? return a string in which the characters represent the flags
+ that are set
+
+ note: - the '!' and '=' modifiers are mutually exclusive.
+ - the '?' modifier will return the status of the flags after they
+ have been changed by other characters in the mode string
+
+ f.lock(mode [, len [, start [, whence]]])
+ will (un)lock a region
+ mode can contain the following characters:
+
+ (character representing type of lock)
+ u unlock
+ r read lock
+ w write lock
+ (modifiers)
+ | wait until the lock can be granted
+ ? return the first lock conflicting with the requested lock
+ or 'None' if there is no conflict. The lock returned is in the
+ format (mode, len, start, whence, pid) where mode is a
+ character representing the type of lock ('r' or 'w')
+
+ note: - the '?' modifier prevents a region from being locked; it is
+ query only
+ """
+
class _posixfile_:
+ """File wrapper class that provides extra POSIX file routines."""
+
states = ['open', 'closed']
***************
*** 216,226 ****
return 'w', l_len, l_start, l_whence, l_pid
- #
- # Public routine to obtain a posixfile object
- #
def open(name, mode='r', bufsize=-1):
return _posixfile_().open(name, mode, bufsize)
def fileopen(file):
return _posixfile_().fileopen(file)
--- 213,222 ----
return 'w', l_len, l_start, l_whence, l_pid
def open(name, mode='r', bufsize=-1):
+ """Public routine to open a file as a posixfile object."""
return _posixfile_().open(name, mode, bufsize)
def fileopen(file):
+ """Public routine to get a posixfile object from a Python file object."""
return _posixfile_().fileopen(file)
Index: posixpath.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/posixpath.py,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -r1.26 -r1.27
*** posixpath.py 1999/11/02 13:28:19 1.26
--- posixpath.py 2000/02/04 15:10:34 1.27
***************
*** 1,12 ****
! # Module 'posixpath' -- common operations on Posix pathnames.
! # Some of this can actually be useful on non-Posix systems too, e.g.
! # for manipulation of the pathname component of URLs.
! # The "os.path" name is an alias for this module on Posix systems;
! # on other systems (e.g. Mac, Windows), os.path provides the same
! # operations in a manner specific to that platform, and is an alias
! # to another module (e.g. macpath, ntpath).
! """Common pathname manipulations, Posix version.
! Instead of importing this module
! directly, import os and refer to this module as os.path.
"""
--- 1,12 ----
! """Common operations on Posix pathnames.
!
! Instead of importing this module directly, import os and refer to
! this module as os.path. The "os.path" name is an alias for this
! module on Posix systems; on other systems (e.g. Mac, Windows),
! os.path provides the same operations in a manner specific to that
! platform, and is an alias to another module (e.g. macpath, ntpath).
!
! Some of this can actually be useful on non-Posix systems too, e.g.
! for manipulation of the pathname component of URLs.
"""
***************
*** 370,375 ****
- # Return an absolute path.
def abspath(path):
if not isabs(path):
path = join(os.getcwd(), path)
--- 370,375 ----
def abspath(path):
+ """Return an absolute path."""
if not isabs(path):
path = join(os.getcwd(), path)
Index: profile.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/profile.py,v
retrieving revision 1.21
retrieving revision 1.22
diff -C2 -r1.21 -r1.22
*** profile.py 1999/05/03 18:13:29 1.21
--- profile.py 2000/02/04 15:10:34 1.22
***************
*** 8,11 ****
--- 8,12 ----
# See profile.doc for more information
+ """Class for profiling Python code."""
# Copyright 1994, by InfoSeek Corporation, all rights reserved.
***************
*** 80,121 ****
- #**************************************************************************
- # class Profile documentation:
- #**************************************************************************
- # self.cur is always a tuple. Each such tuple corresponds to a stack
- # frame that is currently active (self.cur[-2]). The following are the
- # definitions of its members. We use this external "parallel stack" to
- # avoid contaminating the program that we are profiling. (old profiler
- # used to write into the frames local dictionary!!) Derived classes
- # can change the definition of some entries, as long as they leave
- # [-2:] intact.
- #
- # [ 0] = Time that needs to be charged to the parent frame's function. It is
- # used so that a function call will not have to access the timing data
- # for the parents frame.
- # [ 1] = Total time spent in this frame's function, excluding time in
- # subfunctions
- # [ 2] = Cumulative time spent in this frame's function, including time in
- # all subfunctions to this frame.
- # [-3] = Name of the function that corresonds to this frame.
- # [-2] = Actual frame that we correspond to (used to sync exception handling)
- # [-1] = Our parent 6-tuple (corresonds to frame.f_back)
- #**************************************************************************
- # Timing data for each function is stored as a 5-tuple in the dictionary
- # self.timings[]. The index is always the name stored in self.cur[4].
- # The following are the definitions of the members:
- #
- # [0] = The number of times this function was called, not counting direct
- # or indirect recursion,
- # [1] = Number of times this function appears on the stack, minus one
- # [2] = Total time spent internal to this function
- # [3] = Cumulative time that this function was present on the stack. In
- # non-recursive functions, this is the total execution time from start
- # to finish of each invocation of a function, including time spent in
- # all subfunctions.
- # [5] = A dictionary indicating for each function name, the number of times
- # it was called by us.
- #**************************************************************************
class Profile:
def __init__(self, timer=None):
--- 81,121 ----
class Profile:
+ """Profiler class.
+
+ self.cur is always a tuple. Each such tuple corresponds to a stack
+ frame that is currently active (self.cur[-2]). The following are the
+ definitions of its members. We use this external "parallel stack" to
+ avoid contaminating the program that we are profiling. (old profiler
+ used to write into the frames local dictionary!!) Derived classes
+ can change the definition of some entries, as long as they leave
+ [-2:] intact.
+
+ [ 0] = Time that needs to be charged to the parent frame's function.
+ It is used so that a function call will not have to access the
+ timing data for the parent frame.
+ [ 1] = Total time spent in this frame's function, excluding time in
+ subfunctions
+ [ 2] = Cumulative time spent in this frame's function, including time in
+ all subfunctions to this frame.
+ [-3] = Name of the function that corresonds to this frame.
+ [-2] = Actual frame that we correspond to (used to sync exception handling)
+ [-1] = Our parent 6-tuple (corresonds to frame.f_back)
+
+ Timing data for each function is stored as a 5-tuple in the dictionary
+ self.timings[]. The index is always the name stored in self.cur[4].
+ The following are the definitions of the members:
+
+ [0] = The number of times this function was called, not counting direct
+ or indirect recursion,
+ [1] = Number of times this function appears on the stack, minus one
+ [2] = Total time spent internal to this function
+ [3] = Cumulative time that this function was present on the stack. In
+ non-recursive functions, this is the total execution time from start
+ to finish of each invocation of a function, including time spent in
+ all subfunctions.
+ [5] = A dictionary indicating for each function name, the number of times
+ it was called by us.
+ """
def __init__(self, timer=None):
***************
*** 450,466 ****
- #****************************************************************************
- # OldProfile class documentation
- #****************************************************************************
- #
- # The following derived profiler simulates the old style profile, providing
- # errant results on recursive functions. The reason for the usefulnes of this
- # profiler is that it runs faster (i.e., less overhead). It still creates
- # all the caller stats, and is quite useful when there is *no* recursion
- # in the user's code.
- #
- # This code also shows how easy it is to create a modified profiler.
- #****************************************************************************
class OldProfile(Profile):
def trace_dispatch_exception(self, frame, t):
rt, rtt, rct, rfn, rframe, rcur = self.cur
--- 450,463 ----
class OldProfile(Profile):
+ """A derived profiler that simulates the old style profile, providing
+ errant results on recursive functions. The reason for the usefulness of
+ this profiler is that it runs faster (i.e., less overhead). It still
+ creates all the caller stats, and is quite useful when there is *no*
+ recursion in the user's code.
+
+ This code also shows how easy it is to create a modified profiler.
+ """
+
def trace_dispatch_exception(self, frame, t):
rt, rtt, rct, rfn, rframe, rcur = self.cur
***************
*** 510,523 ****
- #****************************************************************************
- # HotProfile class documentation
- #****************************************************************************
- #
- # This profiler is the fastest derived profile example. It does not
- # calculate caller-callee relationships, and does not calculate cumulative
- # time under a function. It only calculates time spent in a function, so
- # it runs very quickly (re: very low overhead)
- #****************************************************************************
class HotProfile(Profile):
def trace_dispatch_exception(self, frame, t):
rt, rtt, rfn, rframe, rcur = self.cur
--- 507,517 ----
class HotProfile(Profile):
+ """The fastest derived profile example. It does not calculate
+ caller-callee relationships, and does not calculate cumulative
+ time under a function. It only calculates time spent in a
+ function, so it runs very quickly due to its very low overhead.
+ """
+
def trace_dispatch_exception(self, frame, t):
rt, rtt, rfn, rframe, rcur = self.cur
Index: pstats.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/pstats.py,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** pstats.py 1999/04/13 04:24:22 1.6
--- pstats.py 2000/02/04 15:10:34 1.7
***************
*** 1,3 ****
! #
# Class for printing reports on profiled python code. rev 1.0 4/1/94
#
--- 1,4 ----
! """Class for printing reports on profiled python code."""
!
# Class for printing reports on profiled python code. rev 1.0 4/1/94
#
***************
*** 38,76 ****
import re
- #**************************************************************************
- # Class Stats documentation
- #**************************************************************************
- # This class is used for creating reports from data generated by the
- # Profile class. It is a "friend" of that class, and imports data either
- # by direct access to members of Profile class, or by reading in a dictionary
- # that was emitted (via marshal) from the Profile class.
- #
- # The big change from the previous Profiler (in terms of raw functionality)
- # is that an "add()" method has been provided to combine Stats from
- # several distinct profile runs. Both the constructor and the add()
- # method now take arbitrarilly many file names as arguments.
- #
- # All the print methods now take an argument that indicats how many lines
- # to print. If the arg is a floating point number between 0 and 1.0, then
- # it is taken as a decimal percentage of the availabel lines to be printed
- # (e.g., .1 means print 10% of all available lines). If it is an integer,
- # it is taken to mean the number of lines of data that you wish to have
- # printed.
- #
- # The sort_stats() method now processes some additionaly options (i.e., in
- # addition to the old -1, 0, 1, or 2). It takes an arbitrary number of quoted
- # strings to select the sort order. For example sort_stats('time', 'name')
- # sorts on the major key of "internal function time", and on the minor
- # key of 'the name of the function'. Look at the two tables in sort_stats()
- # and get_sort_arg_defs(self) for more examples.
- #
- # All methods now return "self", so you can string together commands like:
- # Stats('foo', 'goo').strip_dirs().sort_stats('calls').\
- # print_stats(5).print_callers(5)
- #
- #**************************************************************************
import fpformat
class Stats:
def __init__(self, *args):
if not len(args):
--- 39,74 ----
import re
import fpformat
class Stats:
+ """This class is used for creating reports from data generated by the
+ Profile class. It is a "friend" of that class, and imports data either
+ by direct access to members of Profile class, or by reading in a dictionary
+ that was emitted (via marshal) from the Profile class.
+
+ The big change from the previous Profiler (in terms of raw functionality)
+ is that an "add()" method has been provided to combine Stats from
+ several distinct profile runs. Both the constructor and the add()
+ method now take arbitrarilly many file names as arguments.
+
+ All the print methods now take an argument that indicats how many lines
+ to print. If the arg is a floating point number between 0 and 1.0, then
+ it is taken as a decimal percentage of the availabel lines to be printed
+ (e.g., .1 means print 10% of all available lines). If it is an integer,
+ it is taken to mean the number of lines of data that you wish to have
+ printed.
+
+ The sort_stats() method now processes some additionaly options (i.e., in
+ addition to the old -1, 0, 1, or 2). It takes an arbitrary number of quoted
+ strings to select the sort order. For example sort_stats('time', 'name')
+ sorts on the major key of "internal function time", and on the minor
+ key of 'the name of the function'. Look at the two tables in sort_stats()
+ and get_sort_arg_defs(self) for more examples.
+
+ All methods now return "self", so you can string together commands like:
+ Stats('foo', 'goo').strip_dirs().sort_stats('calls').\
+ print_stats(5).print_callers(5)
+ """
+
def __init__(self, *args):
if not len(args):
***************
*** 183,188 ****
}
- # Expand all abbreviations that are unique
def get_sort_arg_defs(self):
if not self.sort_arg_dict:
self.sort_arg_dict = dict = {}
--- 181,186 ----
}
def get_sort_arg_defs(self):
+ """Expand all abbreviations that are unique."""
if not self.sort_arg_dict:
self.sort_arg_dict = dict = {}
***************
*** 290,296 ****
return
! #******************************************************************
# The following functions support actual printing of reports
! #******************************************************************
# Optional "amount" is either a line count, or a percentage of lines.
--- 288,294 ----
return
! #******************************************************************
# The following functions support actual printing of reports
! #******************************************************************
# Optional "amount" is either a line count, or a percentage of lines.
***************
*** 448,462 ****
- #**************************************************************************
- # class TupleComp Documentation
- #**************************************************************************
- # This class provides a generic function for comparing any two tuples.
- # Each instance records a list of tuple-indicies (from most significant
- # to least significant), and sort direction (ascending or decending) for
- # each tuple-index. The compare functions can then be used as the function
- # argument to the system sort() function when a list of tuples need to be
- # sorted in the instances order.
- #**************************************************************************
class TupleComp:
def __init__(self, comp_select_list):
self.comp_select_list = comp_select_list
--- 446,457 ----
class TupleComp:
+ """This class provides a generic function for comparing any two tuples.
+ Each instance records a list of tuple-indicies (from most significant
+ to least significant), and sort direction (ascending or decending) for
+ each tuple-index. The compare functions can then be used as the function
+ argument to the system sort() function when a list of tuples need to be
+ sorted in the instances order."""
+
def __init__(self, comp_select_list):
self.comp_select_list = comp_select_list
***************
*** 496,501 ****
#**************************************************************************
! # Add together all the stats for two profile entries
! def add_func_stats(target, source):
cc, nc, tt, ct, callers = source
t_cc, t_nc, t_tt, t_ct, t_callers = target
--- 491,496 ----
#**************************************************************************
! def add_func_stats(target, source):
! """Add together all the stats for two profile entries."""
cc, nc, tt, ct, callers = source
t_cc, t_nc, t_tt, t_ct, t_callers = target
***************
*** 504,509 ****
- # Combine two caller lists in a single list.
def add_callers(target, source):
new_callers = {}
for func in target.keys():
--- 499,504 ----
def add_callers(target, source):
+ """Combine two caller lists in a single list."""
new_callers = {}
for func in target.keys():
***************
*** 516,521 ****
return new_callers
- # Sum the caller statistics to get total number of calls recieved
def count_calls(callers):
nc = 0
for func in callers.keys():
--- 511,516 ----
return new_callers
def count_calls(callers):
+ """Sum the caller statistics to get total number of calls received."""
nc = 0
for func in callers.keys():
***************
*** 529,532 ****
def f8(x):
return string.rjust(fpformat.fix(x, 3), 8)
-
--- 524,526 ----
Index: pty.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/pty.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** pty.py 1999/05/03 18:13:51 1.2
--- pty.py 2000/02/04 15:10:34 1.3
***************
*** 1,3 ****
! # pty.py -- Pseudo terminal utilities.
# Bugs: No signal handling. Doesn't set slave termios and window size.
--- 1,3 ----
! """Pseudo terminal utilities."""
# Bugs: No signal handling. Doesn't set slave termios and window size.
***************
*** 17,22 ****
CHILD = 0
- # Open pty master. Returns (master_fd, tty_name). SGI and Linux/BSD version.
def master_open():
try:
import sgi
--- 17,23 ----
CHILD = 0
def master_open():
+ """Open pty master and return (master_fd, tty_name).
+ SGI and Linux/BSD version."""
try:
import sgi
***************
*** 39,50 ****
raise os.error, 'out of pty devices'
- # Open the pty slave. Acquire the controlling terminal.
- # Returns file descriptor. Linux version. (Should be universal? --Guido)
def slave_open(tty_name):
return os.open(tty_name, FCNTL.O_RDWR)
- # Fork and make the child a session leader with a controlling terminal.
- # Returns (pid, master_fd)
def fork():
master_fd, tty_name = master_open()
pid = os.fork()
--- 40,52 ----
raise os.error, 'out of pty devices'
def slave_open(tty_name):
+ """Open the pty slave and acquire the controlling terminal.
+ Return the file descriptor. Linux version."""
+ # (Should be universal? --Guido)
return os.open(tty_name, FCNTL.O_RDWR)
def fork():
+ """Fork and make the child a session leader with a controlling terminal.
+ Return (pid, master_fd)."""
master_fd, tty_name = master_open()
pid = os.fork()
***************
*** 67,85 ****
return pid, master_fd
- # Write all the data to a descriptor.
def writen(fd, data):
while data != '':
n = os.write(fd, data)
data = data[n:]
- # Default read function.
def read(fd):
return os.read(fd, 1024)
- # Parent copy loop.
- # Copies
- # pty master -> standard output (master_read)
- # standard input -> pty master (stdin_read)
def copy(master_fd, master_read=read, stdin_read=read):
while 1:
rfds, wfds, xfds = select(
--- 69,87 ----
return pid, master_fd
def writen(fd, data):
+ """Write all the data to a descriptor."""
while data != '':
n = os.write(fd, data)
data = data[n:]
def read(fd):
+ """Default read function."""
return os.read(fd, 1024)
def copy(master_fd, master_read=read, stdin_read=read):
+ """Parent copy loop.
+ Copies
+ pty master -> standard output (master_read)
+ standard input -> pty master (stdin_read)"""
while 1:
rfds, wfds, xfds = select(
***************
*** 92,97 ****
writen(master_fd, data)
- # Create a spawned process.
def spawn(argv, master_read=read, stdin_read=read):
if type(argv) == type(''):
argv = (argv,)
--- 94,99 ----
writen(master_fd, data)
def spawn(argv, master_read=read, stdin_read=read):
+ """Create a spawned process."""
if type(argv) == type(''):
argv = (argv,)
Index: py_compile.py
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Lib/py_compile.py,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -r1.14 -r1.15
*** py_compile.py 1998/10/07 14:06:03 1.14
--- py_compile.py 2000/02/04 15:10:34 1.15
***************
*** 8,12 ****
def wr_long(f, x):
! "Internal; write a 32-bit int to a file in little-endian order."
f.write(chr( x & 0xff))
f.write(chr((x >> 8) & 0xff))
--- 8,12 ----
def wr_long(f, x):
! """Internal; write a 32-bit int to a file in little-endian order."""
f.write(chr( x & 0xff))
f.write(chr((x >> 8) & 0xff))
- Previous message: [Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.56.2.7,1.56.2.8
- Next message: [Python-checkins] CVS: python/dist/src/Lib quopri.py,1.5,1.6 random.py,1.12,1.13 regex_syntax.py,1.2,1.3 regsub.py,1.6,1.7 repr.py,1.5,1.6 sgmllib.py,1.18,1.19 shlex.py,1.4,1.5 shutil.py,1.14,1.15 stat.py,1.6,1.7 statcache.py,1.5,1.6 statvfs.py,1.3,1.4 string.py,1.45,1.46 sunau.py,1.14,1.15 sunaudio.py,1.3,1.4 symbol.py,1.8,1.9 tempfile.py,1.19,1.20 threading.py,1.5,1.6 toaiff.py,1.4,1.5 token.py,1.6,1.7 traceback.py,1.13,1.14 tty.py,1.1,1.2 types.py,1.12,1.13 tzparse.py,1.6,1.7 urllib.py,1.90,1.91 urllib2.py,1.1,1.2 urlparse.py,1.21,1.22 uu.py,1.10,1.11 wave.py,1.8,1.9 whrandom.py,1.14,1.15
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]