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
|
#
# Copyright (C) 2019 Bloomberg Finance LP
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Angelos Evripiotis <jevripiotis@bloomberg.net>
from buildstream import _yaml
# yaml_file_get_provenance()
#
# Load a yaml file and return it's _yaml.Provenance object.
#
# This is useful for checking the provenance in BuildStream output is as
# expected.
#
# Args:
# path (str): The path to the file to be loaded
# shortname (str): How the path should appear in the error
# key (str): Optional key to look up in the loaded file
# indices (list of indexes): Optional index path, in the case of list values
#
# Returns:
# The Provenance of the dict, member or list element
#
def yaml_file_get_provenance(path, shortname, key=None, indices=None):
with open(path) as data:
element_yaml = _yaml.load_data(
data,
_yaml.ProvenanceFile(path, shortname, project=None),
)
provenance = _yaml.node_get_provenance(element_yaml, key, indices)
assert provenance is not None
return provenance
|
