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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.
import io
import os
import sys
__all__ = ["read_ini", "combine_fields"]
class IniParseError(Exception):
def __init__(self, fp, linenum, msg):
if isinstance(fp, str):
path = fp
elif hasattr(fp, "name"):
path = fp.name
else:
path = getattr(fp, "path", "unknown")
msg = "Error parsing manifest file '{}', line {}: {}".format(path, linenum, msg)
super(IniParseError, self).__init__(msg)
def read_ini(
fp,
defaults=None,
default="DEFAULT",
comments=None,
separators=None,
strict=True,
handle_defaults=True,
document=False,
add_line_no=False,
):
"""
read an .ini file and return a list of [(section, values)]
- fp : file pointer or path to read
- defaults : default set of variables
- default : name of the section for the default section
- comments : characters that if they start a line denote a comment
- separators : strings that denote key, value separation in order
- strict : whether to be strict about parsing
- handle_defaults : whether to incorporate defaults into each section
- add_line_no: whether to include the line number that points to the test in the generated ini file.
"""
# variables
defaults = defaults or {}
default_section = {}
comments = comments or ("#",)
separators = separators or ("=", ":")
sections = []
key = value = None
section_names = set()
if isinstance(fp, str):
fp = io.open(fp, encoding="utf-8")
# read the lines
section = default
current_section = {}
current_section_name = ""
key_indent = 0
for linenum, line in enumerate(fp.read().splitlines(), start=1):
stripped = line.strip()
# ignore blank lines
if not stripped:
# reset key and value to avoid continuation lines
key = value = None
continue
# ignore comment lines
if any(stripped.startswith(c) for c in comments):
continue
# strip inline comments (borrowed from configparser)
comment_start = sys.maxsize
inline_prefixes = {p: -1 for p in comments}
while comment_start == sys.maxsize and inline_prefixes:
next_prefixes = {}
for prefix, i in inline_prefixes.items():
index = stripped.find(prefix, i + 1)
if index == -1:
continue
next_prefixes[prefix] = index
if index == 0 or (index > 0 and stripped[index - 1].isspace()):
comment_start = min(comment_start, index)
inline_prefixes = next_prefixes
if comment_start != sys.maxsize:
stripped = stripped[:comment_start].rstrip()
# check for a new section
if len(stripped) > 2 and stripped[0] == "[" and stripped[-1] == "]":
section = stripped[1:-1].strip()
key = value = None
key_indent = 0
# deal with DEFAULT section
if section.lower() == default.lower():
if strict:
assert default not in section_names
section_names.add(default)
current_section = default_section
current_section_name = "DEFAULT"
continue
if strict:
# make sure this section doesn't already exist
assert (
section not in section_names
), "Section '%s' already found in '%s'" % (section, section_names)
section_names.add(section)
current_section = {}
current_section_name = section
sections.append((section, current_section))
continue
# if there aren't any sections yet, something bad happen
if not section_names:
raise IniParseError(
fp,
linenum,
"Expected a comment or section, " "instead found '{}'".format(stripped),
)
# continuation line ?
line_indent = len(line) - len(line.lstrip(" "))
if key and line_indent > key_indent:
value = "%s%s%s" % (value, os.linesep, stripped)
if strict:
# make sure the value doesn't contain assignments
if " = " in value:
raise IniParseError(
fp,
linenum,
"Should not assign in {} condition for {}".format(
key, current_section_name
),
)
current_section[key] = value
continue
# (key, value) pair
for separator in separators:
if separator in stripped:
key, value = stripped.split(separator, 1)
key = key.strip()
value = value.strip()
key_indent = line_indent
# make sure this key isn't already in the section
if key:
assert (
key not in current_section
), f"Found duplicate key {key} in section {section}"
if strict:
# make sure this key isn't empty
assert key
# make sure the value doesn't contain assignments
if " = " in value:
raise IniParseError(
fp,
linenum,
"Should not assign in {} condition for {}".format(
key, current_section_name
),
)
current_section[key] = value
break
else:
# something bad happened!
raise IniParseError(fp, linenum, "Unexpected line '{}'".format(stripped))
# merge global defaults with the DEFAULT section
defaults = combine_fields(defaults, default_section)
if handle_defaults:
# merge combined defaults into each section
sections = [(i, combine_fields(defaults, j)) for i, j in sections]
return sections, defaults, None
def combine_fields(global_vars, local_vars):
"""
Combine the given manifest entries according to the semantics of specific fields.
This is used to combine manifest level defaults with a per-test definition.
"""
if not global_vars:
return local_vars
if not local_vars:
return global_vars.copy()
field_patterns = {
"args": "%s %s",
"prefs": "%s %s",
"skip-if": "%s\n%s", # consider implicit logical OR: "%s ||\n%s"
"support-files": "%s %s",
}
final_mapping = global_vars.copy()
for field_name, value in local_vars.items():
if field_name not in field_patterns or field_name not in global_vars:
final_mapping[field_name] = value
continue
global_value = global_vars[field_name]
pattern = field_patterns[field_name]
final_mapping[field_name] = pattern % (global_value, value)
return final_mapping
|
