Mercurial > treepkg > treepkg
annotate treepkg/util.py @ 439:8e0c81870e5e treepkg-status
cleanup modules
fix test_info testcases
added testcases for remove_trailingslashes and expand_filename
| author | Bjoern Ricks <bricks@intevation.de> |
|---|---|
| date | Fri, 06 Aug 2010 11:06:08 +0000 |
| parents | acb8dbd506f6 |
| children | e7e0ace683c6 |
| rev | line source |
|---|---|
|
110
ba677506e95e
Remove StatusFile. It has been superseded by the treepkg.util module
Bernhard Herzog <bh@intevation.de>
parents:
88
diff
changeset
|
1 # Copyright (C) 2007, 2008 by Intevation GmbH |
| 0 | 2 # Authors: |
| 3 # Bernhard Herzog <bh@intevation.de> | |
| 4 # | |
| 5 # This program is free software under the GPL (>=v2) | |
| 6 # Read the file COPYING coming with the software for details. | |
| 7 | |
| 8 """Collection of functions that didn't fit elsewhere""" | |
| 9 | |
| 10 import os | |
|
111
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
11 import re |
| 0 | 12 import tempfile |
|
4
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
13 import shutil |
|
169
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
14 import fnmatch |
|
344
f06f707d9fda
merged branches/scratchbox into trunk
Bjoern Ricks <bricks@intevation.de>
parents:
172
diff
changeset
|
15 import pwd |
| 394 | 16 import os.path |
|
418
acb8dbd506f6
use md5 instead of hashlib module
Bjoern Ricks <bricks@intevation.de>
parents:
394
diff
changeset
|
17 import md5 |
| 0 | 18 |
| 19 import run | |
| 20 | |
| 21 | |
|
4
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
22 def import_dotted_name(dotted_name): |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
23 module = __import__(dotted_name) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
24 for name in dotted_name.split(".")[1:]: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
25 module = getattr(module, name) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
26 return module |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
27 |
| 0 | 28 def extract_value_for_key(lines, key): |
| 29 """Parses a sequence of strings for a key and returns the associated value | |
| 30 | |
| 31 The function determines the first string in lines that starts with | |
| 32 key. It returns the rest of the lines stripped of leading and | |
| 33 trailing whitespace. | |
|
83
83e48a76f759
Document what extract_value_for_key returns when the key is not found
Bernhard Herzog <bh@intevation.de>
parents:
57
diff
changeset
|
34 |
|
83e48a76f759
Document what extract_value_for_key returns when the key is not found
Bernhard Herzog <bh@intevation.de>
parents:
57
diff
changeset
|
35 If the key is not found in lines, the function returns None. |
| 0 | 36 """ |
| 37 for line in lines: | |
| 38 if line.startswith(key): | |
| 39 return line[len(key):].strip() | |
| 40 | |
| 41 def extract_lsm_version(lsm_file): | |
| 42 return extract_value_for_key(open(lsm_file), "Version:") | |
| 43 | |
| 44 def debian_changelog_version(changelog): | |
| 45 """Returns the newest version in a debian changelog.""" | |
| 46 output = run.capture_output(["dpkg-parsechangelog", "-l" + changelog]) | |
| 47 return extract_value_for_key(output.splitlines(), "Version:") | |
| 48 | |
| 49 | |
| 50 def ensure_directory(directory): | |
| 51 """Creates directory and all its parents. | |
| 52 | |
| 53 Unlike os.makedirs, this function doesn't throw an exception | |
| 54 """ | |
| 55 if not os.path.isdir(directory): | |
| 56 os.makedirs(directory) | |
| 57 | |
|
169
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
58 def listdir_abs(directory, pattern=None): |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
59 """Like os.listdir, but returns a list of absolute pathnames. |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
60 Optionally, a glob pattern can be given to restrict the names |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
61 returned by the function. |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
62 """ |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
63 filenames = os.listdir(directory) |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
64 if pattern is not None: |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
65 filenames = fnmatch.filter(filenames, pattern) |
|
261b75d7b972
Extend listdir_abs with an optional glob pattern
Bernhard Herzog <bh@intevation.de>
parents:
160
diff
changeset
|
66 return [os.path.join(directory, filename) for filename in filenames] |
| 0 | 67 |
|
4
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
68 def copytree(src, dst, symlinks=False): |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
69 """Recursively copy a directory tree using copy2(). |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
70 |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
71 This version is basically the same as the one in the shutil module |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
72 in the python standard library, however, it's OK if the destination |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
73 directory already exists. |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
74 |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
75 If the optional symlinks flag is true, symbolic links in the |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
76 source tree result in symbolic links in the destination tree; if |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
77 it is false, the contents of the files pointed to by symbolic |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
78 links are copied. |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
79 """ |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
80 names = os.listdir(src) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
81 ensure_directory(dst) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
82 errors = [] |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
83 for name in names: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
84 srcname = os.path.join(src, name) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
85 dstname = os.path.join(dst, name) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
86 try: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
87 if symlinks and os.path.islink(srcname): |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
88 linkto = os.readlink(srcname) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
89 os.symlink(linkto, dstname) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
90 elif os.path.isdir(srcname): |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
91 copytree(srcname, dstname, symlinks) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
92 else: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
93 shutil.copy2(srcname, dstname) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
94 # XXX What about devices, sockets etc.? |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
95 except (IOError, os.error), why: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
96 errors.append((srcname, dstname, why)) |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
97 if errors: |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
98 raise Error, errors |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
99 |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
100 |
|
fee641fec94e
Separate the kolab specific parts.
Bernhard Herzog <bh@intevation.de>
parents:
0
diff
changeset
|
101 |
|
57
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
102 def writefile(filename, contents, permissions=None): |
| 0 | 103 """Write contents to filename in an atomic way. |
| 104 | |
| 105 The contents are first written to a temporary file in the same | |
| 106 directory as filename. Once the contents are written, the temporary | |
| 107 file is closed and renamed to filename. | |
|
57
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
108 |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
109 The optional parameter permissions, if given, are the permissions |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
110 for the new file. By default, or if the parameter is None, the |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
111 default permissions set by the tempfile.mkstemp are used which means |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
112 that the file is only readable for the user that created the file. |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
113 The permissions value is used as the second parameter to os.chmod. |
| 0 | 114 """ |
| 115 dirname, basename = os.path.split(filename) | |
| 116 fileno, tempname = tempfile.mkstemp("", basename, dirname) | |
| 117 try: | |
| 118 os.write(fileno, contents) | |
| 119 if not contents.endswith("\n"): | |
| 120 os.write(fileno, "\n") | |
| 121 os.close(fileno) | |
|
57
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
122 if permissions is not None: |
|
d0d08c7e7d37
allow optionally set the file permissions in writefile
Bernhard Herzog <bh@intevation.de>
parents:
14
diff
changeset
|
123 os.chmod(tempname, permissions) |
| 0 | 124 os.rename(tempname, filename) |
| 125 finally: | |
| 126 if os.path.exists(tempname): | |
| 127 os.remove(tempname) | |
|
111
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
128 |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
129 |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
130 def replace_in_file(filename, pattern, replacement): |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
131 """Replace all occurrences of pattern in a file with replacement. |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
132 The file is modified in place. The search and replace is done with |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
133 the re.sub function. The pattern and replacement parameter are passed |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
134 through to re.sub unmodified, so their semantics are determined by |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
135 re.sub. |
|
160
017179427c7f
Make treepkg/utilreplace_in_file return whether any substitutions were made.
Bernhard Herzog <bh@intevation.de>
parents:
111
diff
changeset
|
136 |
|
017179427c7f
Make treepkg/utilreplace_in_file return whether any substitutions were made.
Bernhard Herzog <bh@intevation.de>
parents:
111
diff
changeset
|
137 The return value is True if the contents of the file have been |
|
017179427c7f
Make treepkg/utilreplace_in_file return whether any substitutions were made.
Bernhard Herzog <bh@intevation.de>
parents:
111
diff
changeset
|
138 changed, False otherwise. |
|
111
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
139 """ |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
140 contents = open(filename).read() |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
141 modified = re.sub(pattern, replacement, contents) |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
142 f = open(filename, "w") |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
143 f.write(modified) |
|
7f6fb8103db0
Move the sed-like replacement code from enterprise/kdepim.py to treepkg/util.py
Bernhard Herzog <bh@intevation.de>
parents:
110
diff
changeset
|
144 f.close() |
|
160
017179427c7f
Make treepkg/utilreplace_in_file return whether any substitutions were made.
Bernhard Herzog <bh@intevation.de>
parents:
111
diff
changeset
|
145 return modified != contents |
|
172
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
146 |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
147 |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
148 def filenameproperty(filename, dir_attr="base_dir"): |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
149 """Create a property for a directory or filename. |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
150 If the filename is relative it is interpreted as relative to the |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
151 value of the attribute of self named by dir_attr which defaults to |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
152 'base_dir'. |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
153 """ |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
154 def get(self): |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
155 return os.path.join(getattr(self, dir_attr), filename) |
|
06af36f915f2
Move the filenameproperty factory from treepkg/packager.py to
Bernhard Herzog <bh@intevation.de>
parents:
169
diff
changeset
|
156 return property(get) |
|
344
f06f707d9fda
merged branches/scratchbox into trunk
Bjoern Ricks <bricks@intevation.de>
parents:
172
diff
changeset
|
157 |
|
f06f707d9fda
merged branches/scratchbox into trunk
Bjoern Ricks <bricks@intevation.de>
parents:
172
diff
changeset
|
158 def getuser(): |
|
f06f707d9fda
merged branches/scratchbox into trunk
Bjoern Ricks <bricks@intevation.de>
parents:
172
diff
changeset
|
159 """Returns the login name of the current user owning the proccess""" |
|
f06f707d9fda
merged branches/scratchbox into trunk
Bjoern Ricks <bricks@intevation.de>
parents:
172
diff
changeset
|
160 return pwd.getpwuid(os.getuid())[0] |
| 394 | 161 |
| 162 def md5sum(filename): | |
| 163 """ calculates the md5sum of a file """ | |
| 164 if not os.path.isfile(filename): | |
| 165 raise RuntimeError("Could not create md5sum. File not found: %s" | |
| 166 % filename) | |
| 167 f = file(filename, 'rb') | |
|
418
acb8dbd506f6
use md5 instead of hashlib module
Bjoern Ricks <bricks@intevation.de>
parents:
394
diff
changeset
|
168 m = md5.new() |
| 394 | 169 while True: |
| 170 d = f.read(8096) | |
| 171 if not d: | |
| 172 break | |
| 173 m.update(d) | |
| 174 f.close() | |
| 175 return m.hexdigest() | |
| 176 | |
| 439 | 177 def remove_trailing_slashes(s): |
| 178 return s.rstrip("/") | |
| 179 | |
| 180 def expand_filename(filename): | |
| 181 """ | |
| 182 Applies os.path.expanduser and os.path.expandvars to filename | |
| 183 """ | |
| 184 return os.path.expandvars(os.path.expanduser(filename)) | |
| 185 | |
| 186 |