pymonkey: python-modules/paver/path.py annotate

annotate python-modules/paver/path.py @ 173:5cfb47c9e916 default tip

Minor line wrap and spacing fixes.

author	Atul Varma <varmaa@toolness.com>
date	Tue, 01 Sep 2009 03:22:33 -0700
parents	3c2151124cee
children

rev	line source
25 3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	1 """ path.py - An object representing a path to a file or directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	2
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	3 Example::
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	4
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	5 from path import path
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	6 d = path('/home/guido/bin')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	7 for f in d.files('*.py'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	8 f.chmod(0755)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	9
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	10 This module requires Python 2.2 or later.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	11
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	12
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	13 :URL: http://www.jorendorff.com/articles/python/path
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	14 :Author: Jason Orendorff <jason.orendorff\x40gmail\x2ecom> (and others - see the url!)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	15 :Date: 9 Mar 2007
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	16
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	17 This has been modified from the original to avoid dry run issues.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	18 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	19
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	20
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	21 # TODO
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	22 # - Tree-walking functions don't avoid symlink loops. Matt Harrison
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	23 # sent me a patch for this.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	24 # - Bug in write_text(). It doesn't support Universal newline mode.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	25 # - Better error message in listdir() when self isn't a
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	26 # directory. (On Windows, the error message really sucks.)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	27 # - Make sure everything has a good docstring.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	28 # - Add methods for regex find and replace.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	29 # - guess_content_type() method?
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	30 # - Perhaps support arguments to touch().
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	31
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	32 import sys, warnings, os, fnmatch, glob, shutil, codecs
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	33
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	34 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	35 from hashlib import md5
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	36 except ImportError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	37 # compatibility for versions before 2.5
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	38 import md5
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	39 md5 = md5.new
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	40
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	41 __version__ = '2.2'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	42 __all__ = ['path']
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	43
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	44 # Platform-specific support for path.owner
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	45 if os.name == 'nt':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	46 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	47 import win32security
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	48 except ImportError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	49 win32security = None
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	50 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	51 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	52 import pwd
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	53 except ImportError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	54 pwd = None
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	55
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	56 # Pre-2.3 support. Are unicode filenames supported?
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	57 _base = str
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	58 _getcwd = os.getcwd
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	59 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	60 if os.path.supports_unicode_filenames:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	61 _base = unicode
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	62 _getcwd = os.getcwdu
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	63 except AttributeError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	64 pass
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	65
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	66 # Pre-2.3 workaround for booleans
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	67 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	68 True, False
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	69 except NameError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	70 True, False = 1, 0
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	71
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	72 # Pre-2.3 workaround for basestring.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	73 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	74 basestring
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	75 except NameError:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	76 basestring = (str, unicode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	77
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	78 # Universal newline support
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	79 _textmode = 'r'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	80 if hasattr(file, 'newlines'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	81 _textmode = 'U'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	82
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	83
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	84 class TreeWalkWarning(Warning):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	85 pass
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	86
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	87 class path(_base):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	88 """ Represents a filesystem path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	89
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	90 For documentation on individual methods, consult their
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	91 counterparts in os.path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	92 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	93
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	94 # --- Special Python methods.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	95
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	96 def __repr__(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	97 return 'path(%s)' % _base.__repr__(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	98
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	99 # Adding a path and a string yields a path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	100 def __add__(self, more):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	101 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	102 resultStr = _base.__add__(self, more)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	103 except TypeError: #Python bug
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	104 resultStr = NotImplemented
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	105 if resultStr is NotImplemented:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	106 return resultStr
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	107 return self.__class__(resultStr)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	108
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	109 def __radd__(self, other):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	110 if isinstance(other, basestring):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	111 return self.__class__(other.__add__(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	112 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	113 return NotImplemented
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	114
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	115 # The / operator joins paths.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	116 def __div__(self, rel):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	117 """ fp.__div__(rel) == fp / rel == fp.joinpath(rel)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	118
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	119 Join two path components, adding a separator character if
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	120 needed.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	121 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	122 return self.__class__(os.path.join(self, rel))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	123
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	124 # Make the / operator work even when true division is enabled.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	125 __truediv__ = __div__
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	126
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	127 def getcwd(cls):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	128 """ Return the current working directory as a path object. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	129 return cls(_getcwd())
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	130 getcwd = classmethod(getcwd)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	131
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	132 def chdir(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	133 """Change current directory."""
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	134 os.chdir(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	135
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	136
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	137 # --- Operations on path strings.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	138
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	139 isabs = os.path.isabs
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	140 def abspath(self): return self.__class__(os.path.abspath(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	141 def normcase(self): return self.__class__(os.path.normcase(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	142 def normpath(self): return self.__class__(os.path.normpath(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	143 def realpath(self): return self.__class__(os.path.realpath(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	144 def expanduser(self): return self.__class__(os.path.expanduser(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	145 def expandvars(self): return self.__class__(os.path.expandvars(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	146 def dirname(self): return self.__class__(os.path.dirname(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	147 basename = os.path.basename
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	148
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	149 def expand(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	150 """ Clean up a filename by calling expandvars(),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	151 expanduser(), and normpath() on it.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	152
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	153 This is commonly everything needed to clean up a filename
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	154 read from a configuration file, for example.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	155 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	156 return self.expandvars().expanduser().normpath()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	157
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	158 def _get_namebase(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	159 base, ext = os.path.splitext(self.name)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	160 return base
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	161
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	162 def _get_ext(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	163 f, ext = os.path.splitext(_base(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	164 return ext
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	165
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	166 def _get_drive(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	167 drive, r = os.path.splitdrive(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	168 return self.__class__(drive)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	169
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	170 parent = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	171 dirname, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	172 """ This path's parent directory, as a new path object.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	173
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	174 For example, path('/usr/local/lib/libpython.so').parent == path('/usr/local/lib')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	175 """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	176
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	177 name = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	178 basename, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	179 """ The name of this file or directory without the full path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	180
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	181 For example, path('/usr/local/lib/libpython.so').name == 'libpython.so'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	182 """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	183
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	184 namebase = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	185 _get_namebase, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	186 """ The same as path.name, but with one file extension stripped off.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	187
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	188 For example, path('/home/guido/python.tar.gz').name == 'python.tar.gz',
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	189 but path('/home/guido/python.tar.gz').namebase == 'python.tar'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	190 """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	191
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	192 ext = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	193 _get_ext, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	194 """ The file extension, for example '.py'. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	195
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	196 drive = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	197 _get_drive, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	198 """ The drive specifier, for example 'C:'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	199 This is always empty on systems that don't use drive specifiers.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	200 """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	201
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	202 def splitpath(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	203 """ p.splitpath() -> Return (p.parent, p.name). """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	204 parent, child = os.path.split(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	205 return self.__class__(parent), child
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	206
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	207 def splitdrive(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	208 """ p.splitdrive() -> Return (p.drive, <the rest of p>).
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	209
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	210 Split the drive specifier from this path. If there is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	211 no drive specifier, p.drive is empty, so the return value
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	212 is simply (path(''), p). This is always the case on Unix.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	213 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	214 drive, rel = os.path.splitdrive(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	215 return self.__class__(drive), rel
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	216
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	217 def splitext(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	218 """ p.splitext() -> Return (p.stripext(), p.ext).
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	219
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	220 Split the filename extension from this path and return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	221 the two parts. Either part may be empty.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	222
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	223 The extension is everything from '.' to the end of the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	224 last path segment. This has the property that if
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	225 (a, b) == p.splitext(), then a + b == p.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	226 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	227 filename, ext = os.path.splitext(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	228 return self.__class__(filename), ext
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	229
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	230 def stripext(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	231 """ p.stripext() -> Remove one file extension from the path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	232
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	233 For example, path('/home/guido/python.tar.gz').stripext()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	234 returns path('/home/guido/python.tar').
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	235 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	236 return self.splitext()[0]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	237
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	238 if hasattr(os.path, 'splitunc'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	239 def splitunc(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	240 unc, rest = os.path.splitunc(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	241 return self.__class__(unc), rest
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	242
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	243 def _get_uncshare(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	244 unc, r = os.path.splitunc(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	245 return self.__class__(unc)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	246
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	247 uncshare = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	248 _get_uncshare, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	249 """ The UNC mount point for this path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	250 This is empty for paths on local drives. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	251
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	252 def joinpath(self, *args):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	253 """ Join two or more path components, adding a separator
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	254 character (os.sep) if needed. Returns a new path
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	255 object.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	256 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	257 return self.__class__(os.path.join(self, *args))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	258
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	259 def splitall(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	260 r""" Return a list of the path components in this path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	261
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	262 The first item in the list will be a path. Its value will be
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	263 either os.curdir, os.pardir, empty, or the root directory of
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	264 this path (for example, '/' or 'C:\\'). The other items in
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	265 the list will be strings.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	266
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	267 ``path.path.joinpath(*result)`` will yield the original path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	268 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	269 parts = []
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	270 loc = self
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	271 while loc != os.curdir and loc != os.pardir:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	272 prev = loc
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	273 loc, child = prev.splitpath()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	274 if loc == prev:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	275 break
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	276 parts.append(child)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	277 parts.append(loc)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	278 parts.reverse()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	279 return parts
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	280
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	281 def relpath(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	282 """ Return this path as a relative path,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	283 based from the current working directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	284 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	285 cwd = self.__class__(os.getcwd())
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	286 return cwd.relpathto(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	287
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	288 def relpathto(self, dest):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	289 """ Return a relative path from self to dest.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	290
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	291 If there is no relative path from self to dest, for example if
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	292 they reside on different drives in Windows, then this returns
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	293 dest.abspath().
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	294 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	295 origin = self.abspath()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	296 dest = self.__class__(dest).abspath()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	297
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	298 orig_list = origin.normcase().splitall()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	299 # Don't normcase dest! We want to preserve the case.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	300 dest_list = dest.splitall()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	301
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	302 if orig_list[0] != os.path.normcase(dest_list[0]):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	303 # Can't get here from there.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	304 return dest
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	305
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	306 # Find the location where the two paths start to differ.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	307 i = 0
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	308 for start_seg, dest_seg in zip(orig_list, dest_list):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	309 if start_seg != os.path.normcase(dest_seg):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	310 break
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	311 i += 1
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	312
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	313 # Now i is the point where the two paths diverge.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	314 # Need a certain number of "os.pardir"s to work up
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	315 # from the origin to the point of divergence.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	316 segments = [os.pardir] * (len(orig_list) - i)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	317 # Need to add the diverging part of dest_list.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	318 segments += dest_list[i:]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	319 if len(segments) == 0:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	320 # If they happen to be identical, use os.curdir.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	321 relpath = os.curdir
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	322 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	323 relpath = os.path.join(*segments)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	324 return self.__class__(relpath)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	325
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	326 # --- Listing, searching, walking, and matching
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	327
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	328 def listdir(self, pattern=None):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	329 """ D.listdir() -> List of items in this directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	330
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	331 Use D.files() or D.dirs() instead if you want a listing
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	332 of just files or just subdirectories.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	333
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	334 The elements of the list are path objects.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	335
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	336 With the optional 'pattern' argument, this only lists
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	337 items whose names match the given pattern.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	338 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	339 names = os.listdir(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	340 if pattern is not None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	341 names = fnmatch.filter(names, pattern)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	342 return [self / child for child in names]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	343
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	344 def dirs(self, pattern=None):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	345 """ D.dirs() -> List of this directory's subdirectories.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	346
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	347 The elements of the list are path objects.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	348 This does not walk recursively into subdirectories
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	349 (but see path.walkdirs).
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	350
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	351 With the optional 'pattern' argument, this only lists
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	352 directories whose names match the given pattern. For
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	353 example::
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	354 d.dirs('build-*')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	355 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	356 return [p for p in self.listdir(pattern) if p.isdir()]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	357
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	358 def files(self, pattern=None):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	359 """ D.files() -> List of the files in this directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	360
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	361 The elements of the list are path objects.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	362 This does not walk into subdirectories (see path.walkfiles).
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	363
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	364 With the optional 'pattern' argument, this only lists files
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	365 whose names match the given pattern. For example::
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	366 d.files('*.pyc')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	367 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	368
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	369 return [p for p in self.listdir(pattern) if p.isfile()]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	370
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	371 def walk(self, pattern=None, errors='strict'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	372 """ D.walk() -> iterator over files and subdirs, recursively.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	373
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	374 The iterator yields path objects naming each child item of
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	375 this directory and its descendants. This requires that
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	376 D.isdir().
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	377
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	378 This performs a depth-first traversal of the directory tree.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	379 Each directory is returned just before all its children.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	380
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	381 The errors= keyword argument controls behavior when an
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	382 error occurs. The default is 'strict', which causes an
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	383 exception. The other allowed values are 'warn', which
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	384 reports the error via warnings.warn(), and 'ignore'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	385 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	386 if errors not in ('strict', 'warn', 'ignore'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	387 raise ValueError("invalid errors parameter")
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	388
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	389 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	390 childList = self.listdir()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	391 except Exception:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	392 if errors == 'ignore':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	393 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	394 elif errors == 'warn':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	395 warnings.warn(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	396 "Unable to list directory '%s': %s"
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	397 % (self, sys.exc_info()[1]),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	398 TreeWalkWarning)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	399 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	400 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	401 raise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	402
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	403 for child in childList:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	404 if pattern is None or child.fnmatch(pattern):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	405 yield child
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	406 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	407 isdir = child.isdir()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	408 except Exception:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	409 if errors == 'ignore':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	410 isdir = False
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	411 elif errors == 'warn':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	412 warnings.warn(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	413 "Unable to access '%s': %s"
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	414 % (child, sys.exc_info()[1]),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	415 TreeWalkWarning)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	416 isdir = False
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	417 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	418 raise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	419
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	420 if isdir:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	421 for item in child.walk(pattern, errors):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	422 yield item
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	423
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	424 def walkdirs(self, pattern=None, errors='strict'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	425 """ D.walkdirs() -> iterator over subdirs, recursively.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	426
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	427 With the optional 'pattern' argument, this yields only
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	428 directories whose names match the given pattern. For
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	429 example, ``mydir.walkdirs('*test')`` yields only directories
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	430 with names ending in 'test'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	431
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	432 The errors= keyword argument controls behavior when an
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	433 error occurs. The default is 'strict', which causes an
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	434 exception. The other allowed values are 'warn', which
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	435 reports the error via warnings.warn(), and 'ignore'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	436 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	437 if errors not in ('strict', 'warn', 'ignore'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	438 raise ValueError("invalid errors parameter")
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	439
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	440 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	441 dirs = self.dirs()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	442 except Exception:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	443 if errors == 'ignore':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	444 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	445 elif errors == 'warn':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	446 warnings.warn(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	447 "Unable to list directory '%s': %s"
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	448 % (self, sys.exc_info()[1]),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	449 TreeWalkWarning)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	450 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	451 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	452 raise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	453
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	454 for child in dirs:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	455 if pattern is None or child.fnmatch(pattern):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	456 yield child
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	457 for subsubdir in child.walkdirs(pattern, errors):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	458 yield subsubdir
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	459
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	460 def walkfiles(self, pattern=None, errors='strict'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	461 """ D.walkfiles() -> iterator over files in D, recursively.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	462
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	463 The optional argument, pattern, limits the results to files
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	464 with names that match the pattern. For example,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	465 ``mydir.walkfiles('*.tmp')`` yields only files with the .tmp
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	466 extension.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	467 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	468 if errors not in ('strict', 'warn', 'ignore'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	469 raise ValueError("invalid errors parameter")
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	470
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	471 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	472 childList = self.listdir()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	473 except Exception:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	474 if errors == 'ignore':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	475 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	476 elif errors == 'warn':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	477 warnings.warn(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	478 "Unable to list directory '%s': %s"
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	479 % (self, sys.exc_info()[1]),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	480 TreeWalkWarning)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	481 return
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	482 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	483 raise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	484
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	485 for child in childList:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	486 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	487 isfile = child.isfile()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	488 isdir = not isfile and child.isdir()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	489 except:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	490 if errors == 'ignore':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	491 continue
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	492 elif errors == 'warn':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	493 warnings.warn(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	494 "Unable to access '%s': %s"
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	495 % (self, sys.exc_info()[1]),
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	496 TreeWalkWarning)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	497 continue
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	498 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	499 raise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	500
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	501 if isfile:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	502 if pattern is None or child.fnmatch(pattern):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	503 yield child
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	504 elif isdir:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	505 for f in child.walkfiles(pattern, errors):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	506 yield f
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	507
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	508 def fnmatch(self, pattern):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	509 """ Return True if self.name matches the given pattern.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	510
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	511 pattern - A filename pattern with wildcards,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	512 for example ``'*.py'``.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	513 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	514 return fnmatch.fnmatch(self.name, pattern)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	515
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	516 def glob(self, pattern):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	517 """ Return a list of path objects that match the pattern.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	518
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	519 pattern - a path relative to this directory, with wildcards.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	520
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	521 For example, path('/users').glob('/bin/') returns a list
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	522 of all the files users have in their bin directories.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	523 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	524 cls = self.__class__
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	525 return [cls(s) for s in glob.glob(_base(self / pattern))]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	526
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	527
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	528 # --- Reading or writing an entire file at once.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	529
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	530 # TODO: file writing should not occur during dry runs XXX
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	531 def open(self, mode='r'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	532 """ Open this file. Return a file object. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	533 return file(self, mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	534
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	535 def bytes(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	536 """ Open this file, read all bytes, return them as a string. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	537 f = self.open('rb')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	538 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	539 return f.read()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	540 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	541 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	542
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	543 def write_bytes(self, bytes, append=False):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	544 """ Open this file and write the given bytes to it.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	545
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	546 Default behavior is to overwrite any existing file.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	547 Call p.write_bytes(bytes, append=True) to append instead.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	548 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	549 if append:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	550 mode = 'ab'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	551 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	552 mode = 'wb'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	553 f = self.open(mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	554 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	555 f.write(bytes)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	556 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	557 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	558
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	559 def text(self, encoding=None, errors='strict'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	560 r""" Open this file, read it in, return the content as a string.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	561
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	562 This uses 'U' mode in Python 2.3 and later, so '\r\n' and '\r'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	563 are automatically translated to '\n'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	564
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	565 Optional arguments:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	566
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	567 encoding - The Unicode encoding (or character set) of
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	568 the file. If present, the content of the file is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	569 decoded and returned as a unicode object; otherwise
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	570 it is returned as an 8-bit str.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	571 errors - How to handle Unicode errors; see help(str.decode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	572 for the options. Default is 'strict'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	573 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	574 if encoding is None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	575 # 8-bit
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	576 f = self.open(_textmode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	577 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	578 return f.read()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	579 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	580 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	581 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	582 # Unicode
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	583 f = codecs.open(self, 'r', encoding, errors)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	584 # (Note - Can't use 'U' mode here, since codecs.open
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	585 # doesn't support 'U' mode, even in Python 2.3.)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	586 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	587 t = f.read()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	588 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	589 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	590 return (t.replace(u'\r\n', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	591 .replace(u'\r\x85', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	592 .replace(u'\r', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	593 .replace(u'\x85', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	594 .replace(u'\u2028', u'\n'))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	595
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	596 def write_text(self, text, encoding=None, errors='strict', linesep=os.linesep, append=False):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	597 r""" Write the given text to this file.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	598
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	599 The default behavior is to overwrite any existing file;
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	600 to append instead, use the 'append=True' keyword argument.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	601
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	602 There are two differences between path.write_text() and
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	603 path.write_bytes(): newline handling and Unicode handling.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	604 See below.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	605
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	606 Parameters:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	607
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	608 - text - str/unicode - The text to be written.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	609
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	610 - encoding - str - The Unicode encoding that will be used.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	611 This is ignored if 'text' isn't a Unicode string.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	612
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	613 - errors - str - How to handle Unicode encoding errors.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	614 Default is 'strict'. See help(unicode.encode) for the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	615 options. This is ignored if 'text' isn't a Unicode
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	616 string.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	617
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	618 - linesep - keyword argument - str/unicode - The sequence of
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	619 characters to be used to mark end-of-line. The default is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	620 os.linesep. You can also specify None; this means to
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	621 leave all newlines as they are in 'text'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	622
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	623 - append - keyword argument - bool - Specifies what to do if
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	624 the file already exists (True: append to the end of it;
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	625 False: overwrite it.) The default is False.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	626
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	627
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	628 --- Newline handling.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	629
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	630 write_text() converts all standard end-of-line sequences
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	631 ('\n', '\r', and '\r\n') to your platform's default end-of-line
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	632 sequence (see os.linesep; on Windows, for example, the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	633 end-of-line marker is '\r\n').
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	634
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	635 If you don't like your platform's default, you can override it
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	636 using the 'linesep=' keyword argument. If you specifically want
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	637 write_text() to preserve the newlines as-is, use 'linesep=None'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	638
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	639 This applies to Unicode text the same as to 8-bit text, except
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	640 there are three additional standard Unicode end-of-line sequences:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	641 u'\x85', u'\r\x85', and u'\u2028'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	642
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	643 (This is slightly different from when you open a file for
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	644 writing with fopen(filename, "w") in C or file(filename, 'w')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	645 in Python.)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	646
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	647
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	648 --- Unicode
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	649
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	650 If 'text' isn't Unicode, then apart from newline handling, the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	651 bytes are written verbatim to the file. The 'encoding' and
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	652 'errors' arguments are not used and must be omitted.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	653
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	654 If 'text' is Unicode, it is first converted to bytes using the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	655 specified 'encoding' (or the default encoding if 'encoding'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	656 isn't specified). The 'errors' argument applies only to this
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	657 conversion.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	658
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	659 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	660 if isinstance(text, unicode):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	661 if linesep is not None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	662 # Convert all standard end-of-line sequences to
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	663 # ordinary newline characters.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	664 text = (text.replace(u'\r\n', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	665 .replace(u'\r\x85', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	666 .replace(u'\r', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	667 .replace(u'\x85', u'\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	668 .replace(u'\u2028', u'\n'))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	669 text = text.replace(u'\n', linesep)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	670 if encoding is None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	671 encoding = sys.getdefaultencoding()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	672 bytes = text.encode(encoding, errors)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	673 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	674 # It is an error to specify an encoding if 'text' is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	675 # an 8-bit string.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	676 assert encoding is None
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	677
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	678 if linesep is not None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	679 text = (text.replace('\r\n', '\n')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	680 .replace('\r', '\n'))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	681 bytes = text.replace('\n', linesep)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	682
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	683 self.write_bytes(bytes, append)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	684
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	685 def lines(self, encoding=None, errors='strict', retain=True):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	686 r""" Open this file, read all lines, return them in a list.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	687
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	688 Optional arguments:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	689 encoding - The Unicode encoding (or character set) of
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	690 the file. The default is None, meaning the content
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	691 of the file is read as 8-bit characters and returned
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	692 as a list of (non-Unicode) str objects.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	693 errors - How to handle Unicode errors; see help(str.decode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	694 for the options. Default is 'strict'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	695 retain - If true, retain newline characters; but all newline
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	696 character combinations ('\r', '\n', '\r\n') are
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	697 translated to '\n'. If false, newline characters are
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	698 stripped off. Default is True.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	699
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	700 This uses 'U' mode in Python 2.3 and later.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	701 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	702 if encoding is None and retain:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	703 f = self.open(_textmode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	704 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	705 return f.readlines()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	706 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	707 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	708 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	709 return self.text(encoding, errors).splitlines(retain)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	710
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	711 def write_lines(self, lines, encoding=None, errors='strict',
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	712 linesep=os.linesep, append=False):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	713 r""" Write the given lines of text to this file.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	714
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	715 By default this overwrites any existing file at this path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	716
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	717 This puts a platform-specific newline sequence on every line.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	718 See 'linesep' below.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	719
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	720 lines - A list of strings.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	721
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	722 encoding - A Unicode encoding to use. This applies only if
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	723 'lines' contains any Unicode strings.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	724
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	725 errors - How to handle errors in Unicode encoding. This
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	726 also applies only to Unicode strings.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	727
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	728 linesep - The desired line-ending. This line-ending is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	729 applied to every line. If a line already has any
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	730 standard line ending ('\r', '\n', '\r\n', u'\x85',
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	731 u'\r\x85', u'\u2028'), that will be stripped off and
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	732 this will be used instead. The default is os.linesep,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	733 which is platform-dependent ('\r\n' on Windows, '\n' on
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	734 Unix, etc.) Specify None to write the lines as-is,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	735 like file.writelines().
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	736
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	737 Use the keyword argument append=True to append lines to the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	738 file. The default is to overwrite the file. Warning:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	739 When you use this with Unicode data, if the encoding of the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	740 existing data in the file is different from the encoding
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	741 you specify with the encoding= parameter, the result is
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	742 mixed-encoding data, which can really confuse someone trying
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	743 to read the file later.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	744 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	745 if append:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	746 mode = 'ab'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	747 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	748 mode = 'wb'
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	749 f = self.open(mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	750 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	751 for line in lines:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	752 isUnicode = isinstance(line, unicode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	753 if linesep is not None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	754 # Strip off any existing line-end and add the
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	755 # specified linesep string.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	756 if isUnicode:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	757 if line[-2:] in (u'\r\n', u'\x0d\x85'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	758 line = line[:-2]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	759 elif line[-1:] in (u'\r', u'\n',
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	760 u'\x85', u'\u2028'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	761 line = line[:-1]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	762 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	763 if line[-2:] == '\r\n':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	764 line = line[:-2]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	765 elif line[-1:] in ('\r', '\n'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	766 line = line[:-1]
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	767 line += linesep
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	768 if isUnicode:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	769 if encoding is None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	770 encoding = sys.getdefaultencoding()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	771 line = line.encode(encoding, errors)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	772 f.write(line)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	773 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	774 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	775
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	776 def read_md5(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	777 """ Calculate the md5 hash for this file.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	778
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	779 This reads through the entire file.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	780 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	781 f = self.open('rb')
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	782 try:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	783 m = md5()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	784 while True:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	785 d = f.read(8192)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	786 if not d:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	787 break
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	788 m.update(d)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	789 finally:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	790 f.close()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	791 return m.digest()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	792
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	793 # --- Methods for querying the filesystem.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	794
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	795 exists = os.path.exists
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	796 isdir = os.path.isdir
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	797 isfile = os.path.isfile
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	798 islink = os.path.islink
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	799 ismount = os.path.ismount
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	800
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	801 if hasattr(os.path, 'samefile'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	802 samefile = os.path.samefile
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	803
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	804 getatime = os.path.getatime
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	805 atime = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	806 getatime, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	807 """ Last access time of the file. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	808
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	809 getmtime = os.path.getmtime
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	810 mtime = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	811 getmtime, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	812 """ Last-modified time of the file. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	813
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	814 if hasattr(os.path, 'getctime'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	815 getctime = os.path.getctime
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	816 ctime = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	817 getctime, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	818 """ Creation time of the file. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	819
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	820 getsize = os.path.getsize
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	821 size = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	822 getsize, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	823 """ Size of the file, in bytes. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	824
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	825 if hasattr(os, 'access'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	826 def access(self, mode):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	827 """ Return true if current user has access to this path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	828
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	829 mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	830 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	831 return os.access(self, mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	832
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	833 def stat(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	834 """ Perform a stat() system call on this path. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	835 return os.stat(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	836
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	837 def lstat(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	838 """ Like path.stat(), but do not follow symbolic links. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	839 return os.lstat(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	840
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	841 def get_owner(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	842 r""" Return the name of the owner of this file or directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	843
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	844 This follows symbolic links.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	845
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	846 On Windows, this returns a name of the form ur'DOMAIN\User Name'.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	847 On Windows, a group can own a file or directory.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	848 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	849 if os.name == 'nt':
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	850 if win32security is None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	851 raise Exception("path.owner requires win32all to be installed")
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	852 desc = win32security.GetFileSecurity(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	853 self, win32security.OWNER_SECURITY_INFORMATION)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	854 sid = desc.GetSecurityDescriptorOwner()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	855 account, domain, typecode = win32security.LookupAccountSid(None, sid)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	856 return domain + u'\\' + account
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	857 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	858 if pwd is None:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	859 raise NotImplementedError("path.owner is not implemented on this platform.")
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	860 st = self.stat()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	861 return pwd.getpwuid(st.st_uid).pw_name
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	862
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	863 owner = property(
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	864 get_owner, None, None,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	865 """ Name of the owner of this file or directory. """)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	866
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	867 if hasattr(os, 'statvfs'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	868 def statvfs(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	869 """ Perform a statvfs() system call on this path. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	870 return os.statvfs(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	871
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	872 if hasattr(os, 'pathconf'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	873 def pathconf(self, name):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	874 return os.pathconf(self, name)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	875
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	876
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	877 # --- Modifying operations on files and directories
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	878
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	879 def utime(self, times):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	880 """ Set the access and modified times of this file. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	881 os.utime(self, times)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	882
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	883 def chmod(self, mode):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	884 os.chmod(self, mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	885
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	886 if hasattr(os, 'chown'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	887 def chown(self, uid, gid):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	888 os.chown(self, uid, gid)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	889
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	890 def rename(self, new):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	891 dry("rename %s to %s" % (self, new), os.rename, self, new)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	892
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	893 def renames(self, new):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	894 dry("renames %s to %s" % (self, new), os.renames, self, new)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	895
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	896
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	897 # --- Create/delete operations on directories
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	898
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	899 def mkdir(self, mode=0777):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	900 if not self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	901 dry("mkdir %s (mode %s)" % (self, mode), os.mkdir, self, mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	902
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	903 def makedirs(self, mode=0777):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	904 if not self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	905 dry("makedirs %s (mode %s)" % (self, mode), os.makedirs, self, mode)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	906
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	907 def rmdir(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	908 if self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	909 dry("rmdir %s" % (self), os.rmdir, self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	910
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	911 def removedirs(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	912 if self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	913 dry("removedirs %s" % (self), os.removedirs, self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	914
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	915
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	916 # --- Modifying operations on files
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	917
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	918 def touch(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	919 """ Set the access/modified times of this file to the current time.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	920 Create the file if it does not exist.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	921 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	922 def do_touch():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	923 fd = os.open(self, os.O_WRONLY \| os.O_CREAT, 0666)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	924 os.close(fd)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	925 os.utime(self, None)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	926 dry("touch %s" % (self), do_touch)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	927
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	928 def remove(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	929 if self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	930 dry("remove %s" % (self), os.remove, self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	931
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	932 def unlink(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	933 if self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	934 dry("unlink %s" % (self), os.unlink, self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	935
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	936
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	937 # --- Links
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	938 # TODO: mark these up for dry run XXX
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	939
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	940 if hasattr(os, 'link'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	941 def link(self, newpath):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	942 """ Create a hard link at 'newpath', pointing to this file. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	943 os.link(self, newpath)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	944
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	945 if hasattr(os, 'symlink'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	946 def symlink(self, newlink):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	947 """ Create a symbolic link at 'newlink', pointing here. """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	948 os.symlink(self, newlink)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	949
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	950 if hasattr(os, 'readlink'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	951 def readlink(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	952 """ Return the path to which this symbolic link points.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	953
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	954 The result may be an absolute or a relative path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	955 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	956 return self.__class__(os.readlink(self))
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	957
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	958 def readlinkabs(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	959 """ Return the path to which this symbolic link points.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	960
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	961 The result is always an absolute path.
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	962 """
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	963 p = self.readlink()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	964 if p.isabs():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	965 return p
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	966 else:
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	967 return (self.parent / p).abspath()
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	968
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	969
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	970 # --- High-level functions from shutil
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	971
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	972 def copy(self, dst):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	973 dry("copy %s %s" % (self, dst), shutil.copy, self, dst)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	974
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	975 def copytree(self, dst, args, *kw):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	976 dry("copytree %s %s" % (self, dst), shutil.copytree,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	977 self, dst, args, *kw)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	978
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	979 if hasattr(shutil, 'move'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	980 def move(self, dst):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	981 dry("move %s %s" % (self, dst), shutil.move, self, dst)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	982
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	983 def rmtree(self, args, *kw):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	984 if self.exists():
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	985 dry("rmtree %s %s %s" % (self, args, kw), shutil.rmtree,
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	986 self, args, *kw)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	987
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	988
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	989 # --- Special stuff from os
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	990
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	991 if hasattr(os, 'chroot'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	992 def chroot(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	993 os.chroot(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	994
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	995 if hasattr(os, 'startfile'):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	996 def startfile(self):
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	997 os.startfile(self)
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	998
3c2151124cee Converted pavement.py to manage.py and added a README. Atul Varma <varmaa@toolness.com> parents: diff changeset	999 from paver.easy import dry

Mercurial > pymonkey

annotate python-modules/paver/path.py @ 173:5cfb47c9e916 default tip