Files
@ 8ad40ef0ea80
Branch filter:
Location: kallithea/scripts/generate-ini.py
8ad40ef0ea80
6.7 KiB
text/x-python
db: add some PullRequest.query() shortcuts
This makes database query code more explicit and increases readability.
E.g. the function name get_pullrequest_cnt_for_user was bad, because the
concept of "pullrequest for user" is incredibly vague, and could refer
to any kind of association between PRs and users. (Quiz time! Does it
mean that the user is the PR owner, that the user is reviewing, or that
the user has commented on the PR and thus is receiving notifications?)
A descriptive name could be "get_open_pull_request_count_for_reviewer",
because the function is indeed only concerned with reviewers and only
with open pull requests. But at this point, we might as well say
PullRequest.query(reviewer_id=user, include_closed=False).count()
which is only slightly longer, and doesn't require us to write dozens
of little wrapper functions (including, any moment now, a separate
function for listing the PRs instead of counting them).
Note that we're not actually going down an abstraction level by doing
this. We're still operating on the concepts of "pull request", "open"
and "reviewer", and are not leaking database implementation details.
The query() shortcuts are designed so they default to not altering
the query. Any processing requires explicit opt-in by the caller.
This makes database query code more explicit and increases readability.
E.g. the function name get_pullrequest_cnt_for_user was bad, because the
concept of "pullrequest for user" is incredibly vague, and could refer
to any kind of association between PRs and users. (Quiz time! Does it
mean that the user is the PR owner, that the user is reviewing, or that
the user has commented on the PR and thus is receiving notifications?)
A descriptive name could be "get_open_pull_request_count_for_reviewer",
because the function is indeed only concerned with reviewers and only
with open pull requests. But at this point, we might as well say
PullRequest.query(reviewer_id=user, include_closed=False).count()
which is only slightly longer, and doesn't require us to write dozens
of little wrapper functions (including, any moment now, a separate
function for listing the PRs instead of counting them).
Note that we're not actually going down an abstraction level by doing
this. We're still operating on the concepts of "pull request", "open"
and "reviewer", and are not leaking database implementation details.
The query() shortcuts are designed so they default to not altering
the query. Any processing requires explicit opt-in by the caller.
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 | #!/usr/bin/env python2
"""
Based on kallithea/bin/template.ini.mako, generate
kallithea/config/deployment.ini_tmpl
development.ini
kallithea/tests/test.ini
"""
import re
makofile = 'kallithea/bin/template.ini.mako'
# the mako conditionals used in all other ini files and templates
selected_mako_conditionals = set([
"database_engine == 'sqlite'",
"http_server == 'waitress'",
"error_aggregation_service == 'errormator'",
"error_aggregation_service == 'sentry'",
])
# the mako variables used in all other ini files and templates
mako_variable_values = {
'host': '127.0.0.1',
'port': '5000',
'here': '%(here)s',
'uuid()': '${app_instance_uuid}',
}
# files to be generated from the mako template
ini_files = [
('kallithea/config/deployment.ini_tmpl',
'''
Kallithea - Example config
The %(here)s variable will be replaced with the parent directory of this file
''',
{}, # exactly the same settings as template.ini.mako
),
('kallithea/tests/test.ini',
'''
Kallithea - config for tests:
initial_repo_scan = true
sqlalchemy and kallithea_test.sqlite
custom logging
The %(here)s variable will be replaced with the parent directory of this file
''',
{
'[server:main]': {
'port': '4999',
},
'[app:main]': {
'initial_repo_scan': 'true',
'app_instance_uuid': 'test',
'show_revision_number': 'true',
'beaker.cache.sql_cache_short.expire': '1',
'beaker.session.secret': '{74e0cd75-b339-478b-b129-07dd221def1f}',
'cache_dir': '%(here)s/../../data/test/cache',
'index_dir': '%(here)s/../../data/test/index',
'archive_cache_dir': '%(here)s/../../data/test/tarballcache',
'beaker.cache.data_dir': '%(here)s/../../data/test/cache/data',
'beaker.cache.lock_dir': '%(here)s/../../data/test/cache/lock',
'sqlalchemy.url': 'sqlite:///%(here)s/kallithea_test.sqlite',
},
'[handler_console]': {
'level': 'DEBUG',
'formatter': 'color_formatter',
},
# The 'handler_console_sql' block is very similar to the one in
# development.ini, but without the explicit 'level=DEBUG' setting:
# it causes duplicate sqlalchemy debug logs, one through
# handler_console_sql and another through another path.
'[handler_console_sql]': {
'formatter': 'color_formatter_sql',
},
},
),
('development.ini',
'''
Kallithea - Development config:
listening on *:5000
sqlite and kallithea.db
initial_repo_scan = true
set debug = true
verbose and colorful logging
The %(here)s variable will be replaced with the parent directory of this file
''',
{
'[server:main]': {
'host': '0.0.0.0',
},
'[app:main]': {
'initial_repo_scan': 'true',
'set debug': 'true',
'app_instance_uuid': 'development-not-secret',
'beaker.session.secret': 'development-not-secret',
},
'[handler_console]': {
'level': 'DEBUG',
'formatter': 'color_formatter',
},
'[handler_console_sql]': {
'level': 'DEBUG',
'formatter': 'color_formatter_sql',
},
},
),
]
def main():
# make sure all mako lines starting with '#' (the '##' comments) are marked up as <text>
print 'reading:', makofile
mako_org = file(makofile).read()
mako_no_text_markup = re.sub(r'</?%text>', '', mako_org)
mako_marked_up = re.sub(r'\n(##.*)', r'\n<%text>\1</%text>', mako_no_text_markup, flags=re.MULTILINE)
if mako_marked_up != mako_org:
print 'writing:', makofile
file(makofile, 'w').write(mako_marked_up)
# select the right mako conditionals for the other less sophisticated formats
def sub_conditionals(m):
"""given a %if...%endif match, replace with just the selected
conditional sections enabled and the rest as comments
"""
conditional_lines = m.group(1)
def sub_conditional(m):
"""given a conditional and the corresponding lines, return them raw
or commented out, based on whether conditional is selected
"""
criteria, lines = m.groups()
if criteria not in selected_mako_conditionals:
lines = '\n'.join((l if not l or l.startswith('#') else '#' + l) for l in lines.split('\n'))
return lines
conditional_lines = re.sub(r'^%(?:el)?if (.*):\n((?:^[^%\n].*\n|\n)*)',
sub_conditional, conditional_lines, flags=re.MULTILINE)
return conditional_lines
mako_no_conditionals = re.sub(r'^(%if .*\n(?:[^%\n].*\n|%elif .*\n|\n)*)%endif\n',
sub_conditionals, mako_no_text_markup, flags=re.MULTILINE)
# expand mako variables
def pyrepl(m):
return mako_variable_values.get(m.group(1), m.group(0))
mako_no_variables = re.sub(r'\${([^}]*)}', pyrepl, mako_no_conditionals)
# remove utf-8 coding header
base_ini = re.sub(r'^## -\*- coding: utf-8 -\*-\n', '', mako_no_variables)
# create ini files
for fn, desc, settings in ini_files:
print 'updating:', fn
ini_lines = re.sub(
'# Kallithea - config file generated with kallithea-config *#\n',
''.join('# %-77s#\n' % l.strip() for l in desc.strip().split('\n')),
base_ini)
def process_section(m):
"""process a ini section, replacing values as necessary"""
sectionname, lines = m.groups()
if sectionname in settings:
section_settings = settings[sectionname]
def process_line(m):
"""process a section line and update value if necessary"""
setting, value = m.groups()
line = m.group(0)
if setting in section_settings:
line = '%s = %s' % (setting, section_settings[setting])
if '$' not in value:
line = '#%s = %s\n%s' % (setting, value, line)
return line.rstrip()
lines = re.sub(r'^([^#\n].*) = ?(.*)', process_line, lines, flags=re.MULTILINE)
return sectionname + '\n' + lines
ini_lines = re.sub(r'^(\[.*\])\n((?:(?:[^[\n].*)?\n)*)', process_section, ini_lines, flags=re.MULTILINE)
file(fn, 'w').write(ini_lines)
if __name__ == '__main__':
main()
|