7178c7b1e1
Samuel Cassiba's IRC 'sc`' contains a ` which has special meaning in RST Escape the URL and strings as passed to sphinx to render correctly. Note: if we discover similarly problematic characters we'll need to create a more comprehensive escape function. Change-Id: I4634457b7251ca96fde91b48a09538fccb721374
86 lines
2.9 KiB
Python
86 lines
2.9 KiB
Python
# 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.
|
|
|
|
"""Build candidates list
|
|
"""
|
|
|
|
import os
|
|
import urllib
|
|
|
|
from jinja2 import FileSystemLoader
|
|
from jinja2.environment import Environment
|
|
|
|
from openstack_election import utils
|
|
|
|
|
|
def render_template(template, data, **kwargs):
|
|
template_dir = kwargs.get('template_dir', os.getcwd())
|
|
loader = FileSystemLoader(template_dir)
|
|
env = Environment(trim_blocks=True, loader=loader)
|
|
template = env.get_template(template)
|
|
return template.render(data)
|
|
|
|
|
|
def build_candidates_list(election=utils.SERIES_NAME):
|
|
project_list = os.listdir(os.path.join(utils.CANDIDATE_PATH, election))
|
|
project_list.sort()
|
|
candidates_lists = {}
|
|
for project in project_list:
|
|
project_prefix = os.path.join(utils.CANDIDATE_PATH, election, project)
|
|
file_list = filter(
|
|
lambda x: x.endswith(".txt"),
|
|
os.listdir(unicode(project_prefix)),
|
|
)
|
|
candidates_list = []
|
|
for candidate_file in file_list:
|
|
filepath = os.path.join(project_prefix, candidate_file)
|
|
candidates_list.append(
|
|
{
|
|
'url': ('%s/%s/plain/%s' %
|
|
(utils.CGIT_URL, utils.ELECTION_REPO,
|
|
urllib.quote_plus(filepath, safe='/'))),
|
|
'ircname': candidate_file[:-4].replace('`', r'\`'),
|
|
'fullname': utils.get_fullname(filepath)
|
|
})
|
|
|
|
candidates_list.sort(key=lambda x: x['fullname'])
|
|
candidates_lists[project] = candidates_list
|
|
|
|
return {'election': election,
|
|
'projects': project_list,
|
|
'candidates': candidates_lists}
|
|
|
|
|
|
def render_list(list_type, candidates_list):
|
|
output_file = os.path.join(utils.CANDIDATE_PATH, "%s.rst" % list_type)
|
|
template_name = "%s.jinja" % list_type
|
|
template_dir = os.path.join(".", "doc", "source", "_exts")
|
|
with open(output_file, "w") as out:
|
|
out.write(
|
|
render_template(
|
|
template_name,
|
|
candidates_list,
|
|
template_dir=template_dir
|
|
).encode('utf-8')
|
|
)
|
|
|
|
|
|
def build_lists(app):
|
|
candidates_list = build_candidates_list()
|
|
render_list("ptl", candidates_list)
|
|
render_list("tc", candidates_list)
|
|
|
|
|
|
def setup(app):
|
|
app.info('loading candidates extension')
|
|
app.connect('builder-inited', build_lists)
|