0
|
1 |
#
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
# This component and the accompanying materials are made available
|
|
5 |
# under the terms of "Eclipse Public License v1.0"
|
|
6 |
# which accompanies this distribution, and is available
|
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
#
|
|
9 |
# Initial Contributors:
|
|
10 |
# Nokia Corporation - initial contribution.
|
|
11 |
#
|
|
12 |
# Contributors:
|
|
13 |
#
|
|
14 |
# Description:
|
|
15 |
#
|
|
16 |
|
|
17 |
|
|
18 |
import os
|
|
19 |
import re
|
3
|
20 |
import posixpath
|
0
|
21 |
import StringIO
|
|
22 |
import tokenize
|
|
23 |
import inspect
|
|
24 |
import traceback
|
|
25 |
import logging
|
3
|
26 |
import shlex
|
|
27 |
from xml.parsers import expat
|
0
|
28 |
import imghdr
|
|
29 |
from token import ENDMARKER, NAME, NUMBER, STRING
|
3
|
30 |
from cone.public import exceptions
|
0
|
31 |
|
|
32 |
import _etree_wrapper
|
|
33 |
etree = _etree_wrapper.ElementTreeWrapper()
|
|
34 |
|
|
35 |
class resourceref(object):
|
|
36 |
"""
|
|
37 |
Class container for set of resource reference related functions
|
|
38 |
"""
|
|
39 |
@classmethod
|
|
40 |
def filter_resources(cls, resources, regexp):
|
|
41 |
"""
|
|
42 |
Filter out all resources that do not match the given regexp
|
|
43 |
@return a array of resources that match the given resource
|
|
44 |
"""
|
|
45 |
test = re.compile(regexp, re.IGNORECASE)
|
|
46 |
return [r for r in resources if test.search(r)]
|
|
47 |
|
|
48 |
@classmethod
|
|
49 |
def neg_filter_resources(cls, resources, regexp):
|
|
50 |
"""
|
|
51 |
Filter out all resources that do match the given regexp
|
|
52 |
@return a array of resources that dont match the given resource
|
|
53 |
"""
|
|
54 |
test = re.compile(regexp, re.IGNORECASE)
|
|
55 |
return [r for r in resources if not test.search(r)]
|
|
56 |
|
|
57 |
@classmethod
|
|
58 |
def insert_begin_slash(cls, ref):
|
|
59 |
if not ref.startswith('/'):
|
|
60 |
return '/' + ref
|
|
61 |
return ref
|
|
62 |
|
|
63 |
@classmethod
|
|
64 |
def remove_begin_slash(cls, ref):
|
3
|
65 |
while ref.startswith('/'):
|
|
66 |
ref = ref.replace('/', '', 1)
|
0
|
67 |
return ref
|
3
|
68 |
|
0
|
69 |
@classmethod
|
|
70 |
def remove_end(self, path, str):
|
|
71 |
try:
|
|
72 |
(ret, sep, rest) = path.partition(str)
|
|
73 |
return ret
|
|
74 |
except ValueError:
|
|
75 |
return path
|
|
76 |
|
|
77 |
@classmethod
|
|
78 |
def add_end_slash(cls, ref):
|
|
79 |
if not ref.endswith('/'):
|
|
80 |
return ref+'/'
|
|
81 |
return ref
|
|
82 |
|
|
83 |
@classmethod
|
|
84 |
def remove_end_slash(cls, ref):
|
|
85 |
if ref.endswith('/'):
|
|
86 |
return ref[:-1]
|
|
87 |
return ref
|
|
88 |
|
|
89 |
@classmethod
|
|
90 |
def norm(cls, ref):
|
|
91 |
"""
|
|
92 |
Normalize the reference to common cone form.
|
|
93 |
1. Always with forward slashes
|
|
94 |
2. no beginning slash
|
|
95 |
3. no end slash
|
|
96 |
@return: A normalized reference string
|
|
97 |
"""
|
|
98 |
|
|
99 |
# Do not modify emtpy string at all
|
|
100 |
if not ref == '':
|
|
101 |
normref = os.path.normpath(ref)
|
3
|
102 |
normref = normref.replace('\\','/').replace('"','')
|
|
103 |
normref = posixpath.normpath(normref)
|
|
104 |
normref = normref.rstrip('\\/')
|
0
|
105 |
else:
|
|
106 |
normref = ref
|
|
107 |
return normref
|
|
108 |
|
|
109 |
@classmethod
|
|
110 |
def replace_dir(cls, ref, frompart, topart):
|
|
111 |
"""
|
|
112 |
Replace a part of directory beginning from ref.
|
|
113 |
@param ref: the resource reference
|
|
114 |
@param frompart: the part of directory name to be replaced
|
|
115 |
@param topart: the partial name which replaces the frompart
|
|
116 |
@return: a refenence with forward slashes
|
|
117 |
"""
|
|
118 |
# Normalize all paths and replace the name with string replace
|
|
119 |
#
|
|
120 |
normref = cls.norm(ref)
|
|
121 |
normfrom = cls.norm(frompart)
|
|
122 |
normto = cls.norm(topart)
|
|
123 |
# Add the end slash to from and to as it should be a dir (if not empty)
|
|
124 |
if normto != "": normto = cls.add_end_slash(normto)
|
|
125 |
if normfrom != "": normfrom = cls.add_end_slash(normfrom)
|
|
126 |
if normref != "": normref = cls.add_end_slash(normref)
|
|
127 |
retref = cls.norm(normref.replace(normfrom, normto, 1))
|
|
128 |
if retref != "": retref = cls.remove_end_slash(retref)
|
|
129 |
return retref
|
|
130 |
|
|
131 |
@classmethod
|
|
132 |
def join_refs(cls, refs):
|
|
133 |
"""
|
|
134 |
join a list of dotted references together with dots
|
|
135 |
1. ignore empty refs
|
|
136 |
2. no dot include begin dot
|
|
137 |
3. no dot include end dot
|
|
138 |
@param refs: a list of references
|
|
139 |
@return: A normalized dotted reference
|
|
140 |
"""
|
|
141 |
# Create a copy of references without any empty strings
|
|
142 |
import posixpath
|
|
143 |
paramdict = {}
|
|
144 |
retref = posixpath.join(*refs)
|
|
145 |
#retref = "/".join([ref for ref in refs if ref != ''])
|
|
146 |
#subs = re.sub('/+', '/', retref)
|
|
147 |
return retref
|
|
148 |
|
|
149 |
@classmethod
|
|
150 |
def split_ref(cls, ref):
|
|
151 |
"""
|
|
152 |
Replace a part of directory beginning from ref.
|
|
153 |
@param ref: the resource reference
|
|
154 |
@return: a list of path elems
|
|
155 |
"""
|
|
156 |
return [r for r in ref.split('/') if r]
|
|
157 |
|
|
158 |
@classmethod
|
|
159 |
def psplit_ref(cls, ref):
|
|
160 |
"""
|
|
161 |
pop split that splits the last element of the array
|
|
162 |
1. empty ref returns an empty list
|
|
163 |
@param ref: a resource references string (e.g. aaa/bbb/ccc.txt)
|
|
164 |
@return: A tuple of references (with given param ('aaa/bbb','ccc.txt')
|
|
165 |
"""
|
|
166 |
refs = ref.rsplit('/', 1)
|
|
167 |
return ("".join(refs[0:-1]), refs[-1])
|
|
168 |
|
|
169 |
@classmethod
|
|
170 |
def remove_ext(cls, ref):
|
|
171 |
"""
|
|
172 |
Remove file extension from ref
|
|
173 |
1. remove file extension
|
|
174 |
@return: a reference. E.g. (foo/test.confml) => foo/test
|
|
175 |
"""
|
|
176 |
filenameparts = cls.get_filename(ref).rsplit('.', 1)
|
|
177 |
path = cls.get_path(ref)
|
|
178 |
if len(filenameparts)==2 and filenameparts[0] != "":
|
|
179 |
return cls.join_refs([path, filenameparts[0]])
|
|
180 |
else:
|
|
181 |
return ref
|
|
182 |
|
|
183 |
@classmethod
|
|
184 |
def get_ext(cls, ref):
|
|
185 |
"""
|
|
186 |
get file extension from ref
|
|
187 |
1. get file extension
|
|
188 |
@return: a reference. E.g. (foo/test.confml) => confml
|
|
189 |
"""
|
|
190 |
if len(ref.rsplit('.', 1)) == 2:
|
|
191 |
return ref.rsplit('.', 1)[1]
|
|
192 |
else:
|
|
193 |
return ""
|
|
194 |
|
|
195 |
@classmethod
|
|
196 |
def get_filename(cls, ref):
|
|
197 |
"""
|
|
198 |
get file name part from ref
|
3
|
199 |
1. get file name
|
|
200 |
@return: a reference. E.g. (foo/test.confml) => test.confml
|
0
|
201 |
"""
|
|
202 |
return ref.rsplit('/', 1)[-1]
|
|
203 |
|
|
204 |
@classmethod
|
|
205 |
def get_path(cls, ref):
|
|
206 |
"""
|
3
|
207 |
get path part from ref
|
|
208 |
1. get path from ref
|
|
209 |
@return: a reference. E.g. (foo/test.confml) => foo
|
0
|
210 |
"""
|
|
211 |
if len(ref.rsplit('/', 1)) == 2:
|
|
212 |
return ref.rsplit('/', 1)[0]
|
|
213 |
else:
|
|
214 |
return ""
|
|
215 |
|
|
216 |
@classmethod
|
|
217 |
def to_dottedref(cls, ref):
|
|
218 |
"""
|
|
219 |
Convert a resource ref to dotted ref
|
|
220 |
1. remove file extension
|
|
221 |
2. convert path delims to dots
|
|
222 |
@return: a dotted reference. E.g. (foo/test.confml) => foo_test
|
|
223 |
"""
|
|
224 |
newref = cls.remove_ext(ref).replace('/', '_').replace(' ', '_')
|
|
225 |
return dottedref.remove_begin_dot(newref)
|
|
226 |
|
|
227 |
|
|
228 |
@classmethod
|
|
229 |
def to_objref(cls, ref):
|
|
230 |
"""
|
|
231 |
Convert a resource ref to dotted ref
|
|
232 |
1. remove file extension
|
|
233 |
2. convert path delims to dots
|
|
234 |
3. using double underscores for directory separation
|
|
235 |
@return: a dotted reference. E.g. (foo/test.confml) => foo_test
|
|
236 |
"""
|
|
237 |
ref = ref.replace('/', '__')
|
3
|
238 |
# Change the python comment character also as underscore so that the tokenizer
|
|
239 |
# does not leave anything out
|
|
240 |
ref = ref.replace('#', '_')
|
0
|
241 |
newref = ''
|
|
242 |
first_token = True
|
|
243 |
try:
|
|
244 |
for toknum, tokval, spos, epos, _ in tokenize.generate_tokens(StringIO.StringIO(unicode(ref)).readline):
|
|
245 |
if toknum == ENDMARKER:
|
|
246 |
break
|
|
247 |
elif toknum == NAME:
|
|
248 |
newref += str(tokval)
|
|
249 |
elif toknum == NUMBER:
|
|
250 |
# Add a character before the number token if the first token is a number
|
|
251 |
if first_token:
|
|
252 |
newref += '_'
|
|
253 |
# replace a possible dot in number .123
|
|
254 |
newref += str(tokval.replace('.','_'))
|
|
255 |
elif toknum == STRING:
|
|
256 |
newref += str(tokval.replace('"', ''))
|
|
257 |
else:
|
|
258 |
newref += '_'
|
|
259 |
# After first round set the first token to false
|
|
260 |
first_token = False
|
|
261 |
except tokenize.TokenError:
|
|
262 |
pass
|
|
263 |
return newref
|
|
264 |
|
|
265 |
@classmethod
|
|
266 |
def to_dref(cls, ref):
|
|
267 |
"""
|
|
268 |
Convert a resource ref to dotted ref
|
|
269 |
1. remove file extension
|
|
270 |
2. convert path delims to dots
|
|
271 |
@return: a dotted reference. E.g. (foo/test.confml) => foo.test
|
|
272 |
"""
|
|
273 |
return dottedref.remove_begin_dot(cls.remove_ext(ref).replace('/','.'))
|
|
274 |
|
|
275 |
@classmethod
|
|
276 |
def to_hash(cls, ref):
|
|
277 |
"""
|
|
278 |
Convert a resource ref to to hash 32 bit integer
|
|
279 |
@return:
|
|
280 |
"""
|
|
281 |
return "%s" % hex(hash(ref))
|
|
282 |
|
3
|
283 |
@classmethod
|
|
284 |
def is_path(cls, ref):
|
|
285 |
"""
|
|
286 |
returns true if the ref seems like a path
|
|
287 |
@return: Boolean value [True|False]
|
|
288 |
"""
|
|
289 |
if cls.get_ext(ref) or cls.get_path(ref):
|
|
290 |
return True
|
|
291 |
return False
|
|
292 |
|
0
|
293 |
class dottedref(object):
|
|
294 |
"""
|
|
295 |
Class container for set of dotted reference related functions
|
|
296 |
"""
|
|
297 |
@classmethod
|
|
298 |
def join_refs(cls, refs):
|
|
299 |
"""
|
|
300 |
join a list of dotted references together with dots
|
|
301 |
1. ignore empty refs
|
|
302 |
2. no dot include begin dot
|
|
303 |
3. no dot include end dot
|
|
304 |
@param refs: a list of references
|
|
305 |
@return: A normalized dotted reference
|
|
306 |
"""
|
|
307 |
# Create a dotted reference without any empty strings
|
|
308 |
return '.'.join([ref for ref in refs if ref.strip()])
|
|
309 |
|
|
310 |
@classmethod
|
|
311 |
def split_ref(cls, ref):
|
|
312 |
"""
|
|
313 |
split a dotted references string to a list of ref elements
|
|
314 |
1. empty ref returns an empty list
|
|
315 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
316 |
@return: A list of references (with given param ['aaa','bbb','ccc']
|
|
317 |
"""
|
|
318 |
# list of reference parts without any empty strings
|
|
319 |
return [r for r in ref.split('.') if r]
|
|
320 |
|
|
321 |
@classmethod
|
|
322 |
def psplit_ref(cls, ref):
|
|
323 |
"""
|
|
324 |
pop split that splits the last element of the array
|
|
325 |
1. empty ref returns an empty list
|
|
326 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
327 |
@return: A tuple of references (with given param ('aaa.bbb','ccc')
|
|
328 |
"""
|
|
329 |
refs = ref.rsplit('.', 1)
|
|
330 |
return ("".join(refs[0:-1]), refs[-1])
|
|
331 |
|
|
332 |
@classmethod
|
|
333 |
def remove_last(cls, ref):
|
|
334 |
"""
|
|
335 |
removes the last element of the ref
|
|
336 |
1. empty ref returns an empty list
|
|
337 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
338 |
@return: A reference (with given param ('aaa.bbb')
|
|
339 |
"""
|
|
340 |
return ref.rsplit('.', 1)[0]
|
|
341 |
|
|
342 |
@classmethod
|
|
343 |
def get_last(cls, ref):
|
|
344 |
"""
|
|
345 |
returns the last element of the ref
|
|
346 |
1. empty ref returns an empty string
|
|
347 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
348 |
@return: A reference (with given param ('ccc')
|
|
349 |
"""
|
|
350 |
return ref.rsplit('.', 1)[-1]
|
|
351 |
|
|
352 |
@classmethod
|
|
353 |
def get_name(cls, ref):
|
|
354 |
"""
|
|
355 |
returns the last element of the ref
|
|
356 |
1. empty ref returns an empty string
|
|
357 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
358 |
@return: A reference (with given param ('ccc')
|
|
359 |
"""
|
|
360 |
if re.match('^(.*)\[.*\]$', ref):
|
|
361 |
return re.match('^(.*)\[.*\]$', ref).group(1)
|
|
362 |
else:
|
|
363 |
return ref
|
|
364 |
|
|
365 |
@classmethod
|
|
366 |
def get_index(cls, ref):
|
|
367 |
"""
|
|
368 |
returns the last element of the ref
|
|
369 |
1. empty ref returns an empty string
|
|
370 |
@param ref: a dotted references string (e.g. aaa.bbb.ccc)
|
|
371 |
@return: A reference (with given param ('ccc')
|
|
372 |
"""
|
|
373 |
if re.match('^.*\[(\d+)\]$', ref):
|
|
374 |
return int( re.match('^.*\[(\d+)\]$', ref).group(1) )
|
|
375 |
else:
|
|
376 |
return None
|
|
377 |
|
|
378 |
@classmethod
|
|
379 |
def remove_begin_dot(cls, ref):
|
|
380 |
"""
|
|
381 |
removes all the dots from the begin of the ref
|
|
382 |
@param ref: a dotted references string (e.g. .aaa.bbb.ccc)
|
|
383 |
@return: A reference (with given param ('aaa.bbb.ccc')
|
|
384 |
"""
|
|
385 |
return ref.lstrip('.')
|
|
386 |
|
|
387 |
@classmethod
|
|
388 |
def ref2filter(cls, ref):
|
|
389 |
elems = []
|
|
390 |
for refelem in dottedref.split_ref(ref):
|
|
391 |
if refelem == "**":
|
|
392 |
elems.append(".*")
|
|
393 |
else:
|
|
394 |
elems.append(refelem.replace("*","[^\.]*"))
|
|
395 |
return "\\.".join(elems)+"$"
|
|
396 |
|
3
|
397 |
@classmethod
|
|
398 |
def has_wildcard(cls, ref):
|
|
399 |
"""
|
|
400 |
Tests if the ref has any wildcards '*' in it.
|
|
401 |
@return: Boolean value. True when wildcards are found.
|
|
402 |
"""
|
|
403 |
return ref.find('*') != -1
|
|
404 |
|
|
405 |
@classmethod
|
|
406 |
def get_static_ref(cls, ref):
|
|
407 |
"""
|
|
408 |
Checks if the ref has any wildcards and return the non wildcard part of ref.
|
|
409 |
@return: string.
|
|
410 |
"""
|
|
411 |
retparts = []
|
|
412 |
for part in cls.split_ref(ref):
|
|
413 |
if cls.has_wildcard(part):
|
|
414 |
break
|
|
415 |
else:
|
|
416 |
retparts.append(part)
|
|
417 |
return ".".join(retparts)
|
|
418 |
|
0
|
419 |
def extract_delimited_tokens(string, delimiters=('${', '}')):
|
|
420 |
"""
|
|
421 |
Return a list of all tokens delimited by the given strings in the given string.
|
|
422 |
This function returns basically the first row of the result of
|
|
423 |
extract_delimited_token_tuples(), with duplicates removed.
|
|
424 |
|
|
425 |
>>> dottedref.extract_refs("test1 ${my.ref1} test2 ${ my.ref1 } ${my.ref2}")
|
|
426 |
['my.ref1', 'my.ref2']
|
|
427 |
"""
|
|
428 |
ref_tuples = extract_delimited_token_tuples(string, delimiters)
|
3
|
429 |
return distinct_array([u'%s' % ref for ref, raw_ref in ref_tuples])
|
0
|
430 |
|
|
431 |
def extract_delimited_token_tuples(string, delimiters=('${', '}')):
|
|
432 |
"""
|
|
433 |
Extract a list of (token, raw_token) tuples from the given string.
|
|
434 |
'token' is the the token extracted from the string and trimmed (surrounding
|
|
435 |
whitespace removed), and raw_token is the unmodified match from the
|
|
436 |
string, which can be used for replacing.
|
|
437 |
|
|
438 |
>>> dottedref.extract_ref_tuples("test1 ${my.ref1} test2 ${ my.ref1 } ${my.ref2}")
|
|
439 |
[('my.ref1', '${my.ref1}'), ('my.ref1', '${ my.ref1 }'), ('my.ref2', '${my.ref2}')]
|
|
440 |
"""
|
|
441 |
pattern = '%s.*?%s' % (re.escape(delimiters[0]), re.escape(delimiters[1]))
|
|
442 |
matches = distinct_array(re.findall(pattern, string, re.DOTALL))
|
|
443 |
|
|
444 |
result = []
|
|
445 |
for match in matches:
|
|
446 |
ref = match[len(delimiters[0]):-len(delimiters[1])].strip()
|
|
447 |
result.append((ref, match))
|
|
448 |
return result
|
|
449 |
|
|
450 |
def expand_delimited_tokens(string, expander_func, delimiters=('${', '}')):
|
|
451 |
"""
|
|
452 |
Expand all tokens in the given string using the given expander function.
|
|
453 |
|
|
454 |
@param string: The string to expand.
|
|
455 |
@param expander_func: The function used for expanding. Should take two parameters:
|
|
456 |
1 - The token to expand.
|
|
457 |
2 - The index of the token in the string.
|
|
458 |
@param delimiters: Tuple specifying the delimiters for tokens.
|
|
459 |
@return: The expanded string.
|
|
460 |
"""
|
|
461 |
# Collect a dictionary of token-entry pairs
|
|
462 |
class Entry(object):
|
|
463 |
pass
|
|
464 |
tokens = {}
|
|
465 |
for index, (token, raw_token) in enumerate(extract_delimited_token_tuples(string, delimiters)):
|
|
466 |
if token not in tokens:
|
|
467 |
entry = Entry()
|
|
468 |
entry.index = index
|
|
469 |
entry.raw_tokens = []
|
|
470 |
entry.value = unicode(expander_func(token, index))
|
|
471 |
tokens[token] = entry
|
|
472 |
else:
|
|
473 |
entry = tokens[token]
|
|
474 |
|
|
475 |
entry.raw_tokens.append(raw_token)
|
|
476 |
|
|
477 |
# Replace all tokens with the expanded values
|
|
478 |
result = string
|
|
479 |
for entry in tokens.itervalues():
|
|
480 |
for raw_token in entry.raw_tokens:
|
|
481 |
result = result.replace(raw_token, entry.value)
|
|
482 |
return result
|
|
483 |
|
3
|
484 |
def expand_refs_by_default_view(string, default_view, delimiters=('${', '}'), default_value_for_missing='',
|
|
485 |
catch_not_found=True):
|
0
|
486 |
"""
|
|
487 |
Convenience function for expanding the refs in a string using setting values.
|
|
488 |
@param default_value_for_missing: The default value used if a setting for
|
3
|
489 |
a reference cannot be found. Has no effect if catch_not_found is False.
|
|
490 |
@param catch_not_found: If True, the NotFound exception raised when a setting
|
|
491 |
is not found is caught and the value of default_value_for_missing is inserted
|
|
492 |
in its place.
|
0
|
493 |
@return: The expanded string.
|
|
494 |
"""
|
|
495 |
def expand(ref, index):
|
3
|
496 |
if catch_not_found:
|
|
497 |
try:
|
|
498 |
return default_view.get_feature(ref).get_original_value()
|
|
499 |
except exceptions.NotFound:
|
|
500 |
logging.getLogger('cone').error("Feature '%s' not found" % ref)
|
|
501 |
return default_value_for_missing
|
|
502 |
else:
|
0
|
503 |
return default_view.get_feature(ref).get_original_value()
|
|
504 |
return expand_delimited_tokens(string, expand, delimiters)
|
|
505 |
|
|
506 |
def distinct_array(arr):
|
|
507 |
newarray = []
|
|
508 |
for val in arr:
|
|
509 |
try:
|
|
510 |
# test to see whether the value already is in thearray
|
|
511 |
newarray.index(val)
|
|
512 |
except ValueError:
|
|
513 |
newarray.append(val)
|
|
514 |
return newarray
|
|
515 |
|
|
516 |
|
|
517 |
def list_files(path):
|
|
518 |
"""
|
|
519 |
Get an array of files in a folder
|
|
520 |
"""
|
|
521 |
retarray = []
|
|
522 |
# Walk through all files in the layer
|
|
523 |
path = os.path.abspath(path)
|
|
524 |
for root, dirs, files in os.walk(path):
|
|
525 |
for name in files:
|
|
526 |
entry = os.path.join(root, name)
|
|
527 |
entry = os.path.normpath(os.path.abspath(entry))
|
|
528 |
if os.path.isfile(entry):
|
|
529 |
retarray.append(entry)
|
|
530 |
return retarray
|
|
531 |
|
|
532 |
def all_subclasses(classname):
|
|
533 |
"""
|
|
534 |
@return: A list of all subclasses of classname
|
|
535 |
"""
|
|
536 |
subclasses = classname.__subclasses__()
|
|
537 |
# Create copy of the subclasses list for the iteration,
|
|
538 |
# so that added items are not recursed again
|
|
539 |
for subclass in classname.__subclasses__():
|
|
540 |
subclasses += all_subclasses(subclass)
|
|
541 |
return subclasses
|
|
542 |
|
|
543 |
def pathmatch(pattern, refpath):
|
|
544 |
"""
|
|
545 |
Check for matching pattern for a ref path
|
|
546 |
"""
|
|
547 |
filter = dottedref.ref2filter(pattern)
|
|
548 |
return re.match(filter, refpath) != None
|
|
549 |
|
|
550 |
def filter(obj, filters):
|
|
551 |
for filter in filters:
|
|
552 |
if not filter(obj):
|
|
553 |
return False
|
|
554 |
return True
|
|
555 |
|
|
556 |
def get_list(elem):
|
|
557 |
if not isinstance(elem, list):
|
|
558 |
return [elem]
|
|
559 |
else:
|
|
560 |
return elem
|
|
561 |
|
|
562 |
def add_list(elem, add):
|
|
563 |
retlist = get_list(elem)
|
|
564 |
retlist.append(add)
|
|
565 |
return retlist
|
|
566 |
|
|
567 |
def prepend_list(elem, prepend):
|
|
568 |
retlist = get_list(elem)
|
|
569 |
retlist.insert(0, prepend)
|
|
570 |
return retlist
|
|
571 |
|
5
|
572 |
def iter_flatten(iterable):
|
|
573 |
for item in iterable:
|
|
574 |
if isinstance(item, (list, tuple)):
|
|
575 |
for subitem in flatten_list(item):
|
|
576 |
yield subitem
|
|
577 |
else:
|
|
578 |
yield item
|
|
579 |
|
|
580 |
def flatten_list(lst):
|
|
581 |
"""
|
|
582 |
Flatten a list or tuple.
|
|
583 |
@param lst: The list of tuple to flatten.
|
|
584 |
@return: The flattened list.
|
|
585 |
|
|
586 |
>>> flatten_list([1, 2, [3, [4, 5]], [6]])
|
|
587 |
[1, 2, 3, 4, 5, 6]
|
|
588 |
"""
|
|
589 |
return [item for item in iter_flatten(lst)]
|
|
590 |
|
0
|
591 |
def is_list(elem):
|
|
592 |
return isinstance(elem, list)
|
|
593 |
|
3
|
594 |
def is_float(value):
|
|
595 |
"""
|
|
596 |
Test if the fiven value (which can be a string) is a floating point value.
|
|
597 |
"""
|
|
598 |
fvalue = float(value)
|
|
599 |
ivalue = int(fvalue)
|
|
600 |
|
|
601 |
return (fvalue - ivalue) != 0
|
|
602 |
|
0
|
603 |
def get_class(modelinstance, classinstance):
|
|
604 |
"""
|
|
605 |
Get the actual model specific implementation class for a classinstance
|
|
606 |
"""
|
|
607 |
for attr in dir(modelinstance):
|
|
608 |
modelclass = getattr(modelinstance, attr)
|
|
609 |
if inspect.isclass(modelclass):
|
|
610 |
if issubclass(modelclass, classinstance):
|
|
611 |
return modelclass
|
|
612 |
return classinstance
|
|
613 |
|
3
|
614 |
class OProperty(object):
|
|
615 |
"""Based on the emulation of PyProperty_Type() in Objects/descrobject.c
|
|
616 |
from http://infinitesque.net/articles/2005/enhancing%20Python%27s%20property.xhtml"""
|
|
617 |
def __init__(self, fget=None, fset=None, fdel=None, doc=None):
|
|
618 |
self.fget = fget
|
|
619 |
self.fset = fset
|
|
620 |
self.fdel = fdel
|
|
621 |
self.__doc__ = doc
|
|
622 |
|
|
623 |
def __get__(self, obj, objtype=None):
|
|
624 |
if obj is None:
|
|
625 |
return self
|
|
626 |
if self.fget is None:
|
|
627 |
raise AttributeError, "unreadable attribute"
|
|
628 |
if self.fget.__name__ == '<lambda>' or not self.fget.__name__:
|
|
629 |
return self.fget(obj)
|
0
|
630 |
else:
|
3
|
631 |
return getattr(obj, self.fget.__name__)()
|
|
632 |
|
|
633 |
def __set__(self, obj, value):
|
|
634 |
if self.fset is None:
|
|
635 |
raise AttributeError, "can't set attribute"
|
|
636 |
if self.fset.__name__ == '<lambda>' or not self.fset.__name__:
|
|
637 |
self.fset(obj, value)
|
0
|
638 |
else:
|
3
|
639 |
getattr(obj, self.fset.__name__)(value)
|
|
640 |
|
|
641 |
def __delete__(self, obj):
|
|
642 |
if self.fdel is None:
|
|
643 |
raise AttributeError, "can't delete attribute"
|
|
644 |
if self.fdel.__name__ == '<lambda>' or not self.fdel.__name__:
|
|
645 |
self.fdel(obj)
|
|
646 |
else:
|
|
647 |
getattr(obj, self.fdel.__name__)()
|
0
|
648 |
|
|
649 |
class xml(object):
|
|
650 |
"""
|
|
651 |
Class container for set of XML-related helper functions.
|
|
652 |
"""
|
|
653 |
|
|
654 |
@classmethod
|
|
655 |
def split_tag_namespace(cls, xml_tag):
|
|
656 |
"""
|
|
657 |
Split the given XML tag into a (namespace, tag) tuple.
|
|
658 |
|
|
659 |
>>> ReaderBase._split_tag_namespace("test")
|
|
660 |
(None, 'test')
|
|
661 |
>>> ReaderBase._split_tag_namespace("{http://www.test.com/xml/1}test")
|
|
662 |
('http://www.test.com/xml/1', 'test')
|
|
663 |
"""
|
|
664 |
if xml_tag.startswith('{'):
|
|
665 |
parts = xml_tag[1:].split('}')
|
|
666 |
return (parts[0], parts[1])
|
|
667 |
else:
|
|
668 |
return (None, xml_tag)
|
|
669 |
|
3
|
670 |
@classmethod
|
|
671 |
def get_xml_root(cls, resource):
|
|
672 |
"""
|
|
673 |
Get a (namespace, tag) tuple of the root element in the XML data
|
|
674 |
read from the given resource.
|
|
675 |
|
|
676 |
@param resource: The resource from which to read data. Should be a
|
|
677 |
file-like object (i.e. should have a read() method).
|
|
678 |
@return: A (namespace, tag) tuple. Note that the namespace may
|
|
679 |
be None.
|
|
680 |
|
|
681 |
@raise exceptions.XmlParseError: The resource contains invalid XML data.
|
|
682 |
"""
|
|
683 |
class RootElementFound(RuntimeError):
|
|
684 |
def __init__(self, root_name):
|
|
685 |
self.root_name = root_name
|
|
686 |
|
|
687 |
def handle_start(name, attrs):
|
|
688 |
raise RootElementFound(name)
|
|
689 |
|
|
690 |
p = expat.ParserCreate(namespace_separator=':')
|
|
691 |
p.StartElementHandler = handle_start
|
|
692 |
|
|
693 |
BUFSIZE = 128
|
|
694 |
while True:
|
|
695 |
data = resource.read(BUFSIZE)
|
|
696 |
try:
|
|
697 |
p.Parse(data, len(data) < BUFSIZE)
|
|
698 |
except RootElementFound, e:
|
|
699 |
parts = e.root_name.rsplit(':', 1)
|
|
700 |
if len(parts) > 1:
|
|
701 |
return parts[0], parts[1]
|
|
702 |
else:
|
|
703 |
return None, parts[0]
|
|
704 |
except expat.ExpatError, e:
|
|
705 |
raise exceptions.XmlParseError(
|
|
706 |
"XML parse error on line %d: %s" % (e.lineno, e),
|
|
707 |
e.lineno, str(e))
|
|
708 |
|
|
709 |
def update_dict(todict, fromdict):
|
|
710 |
"""
|
|
711 |
Merges the elements of two dictionaries together.
|
|
712 |
@param todict: the target dictionary where data is merged.
|
|
713 |
@param fromdict: the source dict where data is read
|
|
714 |
@return: the modified todict.
|
|
715 |
"""
|
|
716 |
for key in fromdict:
|
|
717 |
todict.setdefault(key, []).extend(fromdict[key])
|
|
718 |
return todict
|
|
719 |
|
0
|
720 |
def log_exception(logger, msg, msg_level=logging.ERROR, traceback_level=logging.DEBUG):
|
|
721 |
"""
|
|
722 |
Log an exception so that the given message and the exception's
|
|
723 |
traceback are logged separately with the given log levels.
|
|
724 |
|
|
725 |
The purpose is to print minimal information to the user when running
|
|
726 |
the CLI (default level for STDOUT logging is WARNING), but the traceback
|
|
727 |
should still be available in the log file (which uses the level DEBUG
|
|
728 |
by default).
|
|
729 |
|
|
730 |
Note that this function should be only used in an exception handler.
|
|
731 |
"""
|
|
732 |
logger.log(msg_level, msg)
|
|
733 |
logger.log(traceback_level, traceback.format_exc())
|
|
734 |
|
3
|
735 |
|
|
736 |
def grep(string,list):
|
|
737 |
"""
|
|
738 |
Grep throught the items in the given list to find matching entries.
|
|
739 |
"""
|
|
740 |
expr = re.compile(string)
|
|
741 |
return filter(expr.search,list)
|
|
742 |
|
|
743 |
def grep_tuple(string,list):
|
|
744 |
"""
|
|
745 |
Grep throught the items in the given list to find matching entries.
|
|
746 |
@return: a list of tuples (index,text)
|
0
|
747 |
"""
|
3
|
748 |
results = []
|
|
749 |
expr = re.compile(string)
|
|
750 |
for (index,text) in enumerate(list):
|
|
751 |
match = expr.search(text)
|
|
752 |
if match != None:
|
|
753 |
results.append((index,match.string))
|
|
754 |
return results
|
|
755 |
|
|
756 |
def grep_dict(string,list):
|
0
|
757 |
"""
|
3
|
758 |
Grep throught the items in the given list to find matching entries.
|
|
759 |
@return: a dictionary with list index as key and matching text as value.
|
|
760 |
"""
|
|
761 |
results = {}
|
|
762 |
expr = re.compile(string)
|
|
763 |
for (index,text) in enumerate(list):
|
|
764 |
match = expr.search(text)
|
|
765 |
if match != None:
|
|
766 |
results[index] = match.string
|
|
767 |
return results
|
|
768 |
|
|
769 |
def cmdsplit(s, comments=False, os_name='nt'):
|
|
770 |
"""
|
|
771 |
Copy of shlex split method to allow parsing of command line parameters in operating system specific mode.
|
0
|
772 |
|
3
|
773 |
"""
|
|
774 |
posix = True
|
|
775 |
lex = shlex.shlex(s, posix=posix)
|
|
776 |
lex.whitespace_split = True
|
|
777 |
if not comments:
|
|
778 |
lex.commenters = ''
|
|
779 |
if os_name == 'nt':
|
|
780 |
lex.escape = '^'
|
|
781 |
return list(lex)
|
|
782 |
|
|
783 |
|
|
784 |
import sys
|
|
785 |
sys_version = "%d.%d" % (sys.version_info[0],sys.version_info[1])
|
|
786 |
if sys_version >= "2.6":
|
|
787 |
def relpath(path, start=os.curdir):
|
|
788 |
return os.path.relpath(path, start)
|
|
789 |
else:
|
|
790 |
def relpath(path, start=os.curdir):
|
|
791 |
"""Return a relative version of a path"""
|
|
792 |
|
|
793 |
if not path:
|
|
794 |
raise ValueError("no path specified")
|
|
795 |
start_list = os.path.abspath(start).split(os.sep)
|
|
796 |
path_list = os.path.abspath(path).split(os.sep)
|
|
797 |
if start_list[0].lower() != path_list[0].lower():
|
|
798 |
unc_path, rest = os.path.splitunc(path)
|
|
799 |
unc_start, rest = os.path.splitunc(start)
|
|
800 |
if bool(unc_path) ^ bool(unc_start):
|
|
801 |
raise ValueError("Cannot mix UNC and non-UNC paths (%s and %s)"
|
|
802 |
% (path, start))
|
|
803 |
else:
|
|
804 |
raise ValueError("path is on drive %s, start on drive %s"
|
|
805 |
% (path_list[0], start_list[0]))
|
|
806 |
# Work out how much of the filepath is shared by start and path.
|
|
807 |
for i in range(min(len(start_list), len(path_list))):
|
|
808 |
if start_list[i].lower() != path_list[i].lower():
|
|
809 |
break
|
0
|
810 |
else:
|
3
|
811 |
i += 1
|
|
812 |
|
|
813 |
rel_list = [os.pardir] * (len(start_list)-i) + path_list[i:]
|
|
814 |
if not rel_list:
|
|
815 |
return os.curdir
|
|
816 |
return os.path.join(*rel_list) |