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
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import collections
from datetime import datetime
import logging
import os.path
import yaml
from reno import scanner
LOG = logging.getLogger(__name__)
def get_cache_filename(conf):
return os.path.normpath(os.path.join(
conf.reporoot, conf.notespath, 'reno.cache'))
class Loader(object):
"Load the release notes for a given repository."
def __init__(self, conf, ignore_cache=False):
"""Initialize a Loader.
The versions are presented in reverse chronological order.
Notes files are associated with the earliest version for which
they were available, regardless of whether they changed later.
:param conf: Parsed configuration from file
:type conf: reno.config.Config
:param ignore_cache: Do not load a cache file if it is present.
:type ignore_cache: bool
"""
self._config = conf
self._ignore_cache = ignore_cache
self._reporoot = conf.reporoot
self._notespath = conf.notespath
self._branch = conf.branch
self._collapse_pre_releases = conf.collapse_pre_releases
self._earliest_version = conf.earliest_version
self._cache = None
self._scanner = None
self._scanner_output = None
self._tags_to_dates = None
self._cache_filename = get_cache_filename(conf)
self._encoding = conf.options['encoding']
self._load_data()
def _load_data(self):
cache_file_exists = os.path.exists(self._cache_filename)
if self._ignore_cache and cache_file_exists:
LOG.debug('ignoring cache file %s', self._cache_filename)
if (not self._ignore_cache) and cache_file_exists:
LOG.debug('loading cache file %s', self._cache_filename)
with open(self._cache_filename, 'r', encoding=self._encoding) as f:
self._cache = yaml.safe_load(f.read())
if self._cache:
# Save the cached scanner output to the same attribute
# it would be in if we had loaded it "live". This
# simplifies some of the logic in the other methods.
self._scanner_output = collections.OrderedDict(
(n['version'], n['files'])
for n in self._cache['notes']
)
self._tags_to_dates = collections.OrderedDict(
(n['version'], n['date'])
for n in self._cache['dates']
)
else:
self._scanner = scanner.Scanner(self._config)
self._scanner_output = self._scanner.get_notes_by_version()
self._tags_to_dates = self._scanner.get_version_dates()
def close(self):
"""Close any files opened by this loader."""
if self._scanner is not None:
self._scanner.close()
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.close()
@property
def versions(self):
"A list of all of the versions found."
return list(self._scanner_output.keys())
def __getitem__(self, version):
"Return data about the files that should go into a given version."
return self._scanner_output[version]
def get_version_date(self, version):
"Return release data for a version."
if version in self._tags_to_dates.keys():
date = datetime.fromtimestamp(self._tags_to_dates[version])
return date.strftime("%Y-%m-%d")
return "Unknown"
def parse_note_file(self, filename, sha):
"""Return the data structure encoded in the note file.
Emit warnings for content that does not look valid in some
way, but return it anyway for backwards-compatibility.
"""
if self._cache:
content = self._cache['file-contents'][filename]
else:
body = self._scanner.get_file_at_commit(filename, sha)
content = yaml.safe_load(body)
cleaned_content = {}
if not isinstance(content, dict):
LOG.warning(
'%s does not appear to be structured as a YAML mapping. '
'Did you forget a top-level key?',
filename,
)
raise ValueError(
f'{filename} does not appear to be structured as a YAML '
f'mapping. Did you forget a top-level key?'
)
valid_section_names = {
section.name for section in self._config.sections
}
for section_name, section_content in content.items():
if section_name == self._config.prelude_section_name:
if not isinstance(section_content, str):
LOG.warning(
'The %s section of %s does not parse as a single '
'string. Is the YAML input escaped properly?',
section_name, filename,
)
else:
if section_name not in valid_section_names:
# TODO(stephenfin): Make this an error in a future release
LOG.warning(
'The %s section of %s is not a recognized section. '
'It should be one of: %s. '
'This will be an error in a future release.',
section_name, filename,
', '.join(valid_section_names),
)
if isinstance(section_content, str):
# A single string is OK, but wrap it with a list
# so the rest of the code can treat the data model
# consistently.
section_content = [section_content]
elif not isinstance(section_content, list):
LOG.warning(
'The %s section of %s does not parse as a string or '
'list of strings. Is the YAML input escaped properly?',
section_name, filename,
)
else:
for item in section_content:
if not isinstance(item, str):
LOG.warning(
'The item %r in the %s section of %s parses '
'as a %s instead of a string. '
'Is the YAML input escaped properly?',
item, section_name, filename, type(item),
)
cleaned_content[section_name] = section_content
return cleaned_content
|
