1 # The MIT License (MIT)
3 # Copyright (c) 2015-2020 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining
6 # a copy of this software and associated documentation files (the
7 # "Software"), to deal in the Software without restriction, including
8 # without limitation the rights to use, copy, modify, merge, publish,
9 # distribute, sublicense, and/or sell copies of the Software, and to
10 # permit persons to whom the Software is furnished to do so, subject to
11 # the following conditions:
13 # The above copyright notice and this permission notice shall be
14 # included in all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 import barectf
.config_parse_common
as barectf_config_parse_common
25 from barectf
.config_parse_common
import _ConfigurationParseError
26 import barectf
.config_parse_v2
as barectf_config_parse_v2
27 import barectf
.config_parse_v3
as barectf_config_parse_v3
31 # Creates and returns a barectf 3 YAML configuration file parser to
32 # parse the file-like object `file`.
34 # `file` can be a barectf 2 or 3 configuration file.
35 def _create_v3_parser(file, include_dirs
, ignore_include_not_found
):
37 root_node
= barectf_config_parse_common
._yaml
_load
(file)
39 if type(root_node
) is barectf_config_parse_common
._ConfigNodeV
3:
40 # barectf 3 configuration file
41 return barectf_config_parse_v3
._Parser(file, root_node
, include_dirs
,
42 ignore_include_not_found
)
43 elif type(root_node
) is collections
.OrderedDict
:
44 # barectf 2 configuration file
45 v2_parser
= barectf_config_parse_v2
._Parser(file, root_node
, include_dirs
,
46 ignore_include_not_found
)
47 return barectf_config_parse_v3
._Parser(file, v2_parser
.config_node
, include_dirs
,
48 ignore_include_not_found
)
50 raise _ConfigurationParseError('Configuration',
51 f
'Root (configuration) node is not an object (it\'s a `{type(root_node)}`)')
52 except _ConfigurationParseError
as exc
:
53 barectf_config_parse_common
._append
_error
_ctx
(exc
, 'Configuration',
54 'Cannot create configuration from YAML file')
57 def _from_file(file, include_dirs
, ignore_include_not_found
):
58 return _create_v3_parser(file, include_dirs
, ignore_include_not_found
).config
61 def _effective_config_file(file, include_dirs
, ignore_include_not_found
, indent_space_count
=2):
62 config_node
= _create_v3_parser(file, include_dirs
, ignore_include_not_found
).config_node
63 return barectf_config_parse_common
._yaml
_dump
(config_node
, indent
=indent_space_count
,
64 default_flow_style
=False, explicit_start
=True,
68 def _config_file_major_version(file):
70 root_node
= barectf_config_parse_common
._yaml
_load
(file)
72 if type(root_node
) is barectf_config_parse_common
._ConfigNodeV
3:
73 # barectf 3 configuration file
75 elif type(root_node
) is collections
.OrderedDict
:
76 # barectf 2 configuration file
78 except _ConfigurationParseError
as exc
:
79 barectf_config_parse_common
._append
_error
_ctx
(exc
, 'Configuration', 'Cannot load YAML file')