1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
# Copyright (c) 2014 Intel Corporation
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Module providing utility functions to work with piglit groups.
Instead of using posixpath (or the generic os.path) for working with tests this
module should be prefered.
Piglit groups look much like posix paths, they are '/' delimited with each
element representing a group, and the final element being the test name. Unlike
posix paths they may not start with a leading '/'.
"""
import posixpath
import os.path
__all__ = [
'join',
'commonprefix',
'relgroup',
'split',
'groupname',
'testname',
'splitname',
'from_path'
]
def _normalize(group):
"""Helper to normalize group paths on Windows.
Although grouptools' heart is in the right place, the fact is that it fails
to spot when developers mistakedly use os.path.join for groups on Posix
systems.
So until this is improved somehow, make grouptools behavior on Windows
match Linux, ie, just silently ignore mixed use of grouptools and os.path.
"""
if os.path.sep != '/':
group = group.replace(os.path.sep, '/')
return group
def _assert_illegal(group):
"""Helper that checks for illegal characters in input."""
assert isinstance(group, (str, unicode)), 'Type must be string or unicode'
assert '\\' not in group, \
'Groups are not paths and cannot contain \\. ({})'.format(group)
assert not group.startswith('/'), \
'Groups cannot start with /. ({})' .format(group)
def testname(group):
"""Return the last element of a group name.
Provided the value 'group1/group2/test1' will provide 'test1', this
does not enforce any rules that the final element is a test name, and can
be used to shaved down groups.
Analogous to os.path.basename
"""
group = _normalize(group)
_assert_illegal(group)
return posixpath.basename(group)
def groupname(group):
"""Return all groups except the last.
Provided the value 'group1/group2/test1' will provide 'group1/group2', this
does not enforce any rules that the final element is a test name, and can
be used to shaved down groups.
Analogous to os.path.dirname
"""
group = _normalize(group)
_assert_illegal(group)
return posixpath.dirname(group)
def splitname(group):
"""Split a group name, Returns tuple "(group, test)"."""
group = _normalize(group)
_assert_illegal(group)
return posixpath.split(group)
def commonprefix(args):
"""Given a list of groups, returns the longest common leading component."""
args = [_normalize(group) for group in args]
for group in args:
_assert_illegal(group)
return posixpath.commonprefix(args)
def join(*args):
"""Join multiple groups together with some sanity checking.
Prevents groups from having '/' as the leading character or from having
'\\' in them, as these are groups not paths.
"""
args = [_normalize(group) for group in args]
for group in args:
assert isinstance(group, (str, unicode)), \
'Type must be string or unicode'
assert '\\' not in group, \
'Groups are not paths and cannot contain \\. ({})'.format(group)
assert not args[0].startswith('/'), \
'Groups cannot start with /. ({})' .format(args[0])
return posixpath.join(*args)
def relgroup(large, small):
"""Find the relationship between two groups.
This allows the comparison of two groups, and returns a string. If start
start is longer than the group then '' is returned.
"""
large = _normalize(large)
small = _normalize(small)
for element in {large, small}:
_assert_illegal(element)
if len(small) > len(large):
return ''
elif small == '' and large == '':
return ''
else:
return posixpath.relpath(large, small)
def split(group):
"""Split the group into a list of elements.
If input is '' return an empty list
"""
group = _normalize(group)
_assert_illegal(group)
if group == '':
return []
return group.split('/')
def from_path(path):
"""Create a group from a path.
This function takes a path, and creates a group out of it.
This safely handles both Windows and Unix style paths.
"""
assert isinstance(path, (str, unicode)), 'Type must be string or unicode'
assert not path.startswith('/'), \
'Groups cannot start with /. ({})' .format(path)
if '\\' in path:
return path.replace('\\', '/')
if '.' == path:
return ''
return path
|
