kallithea Changeset - 73934760f601

Changeset - 73934760f601

Parent rev.

Child rev.

[Not reviewed]

default

0 2 0

Mads Kiilerich - 8 years ago 2017-09-14 02:08:06
mads@kiilerich.com

ini: use proper Mako for generating shipped ini files

Get rid of some regexp hacking ... but we still need some hacking to substitute
plain template variables that haven't been marked up.

2 files changed with 12 insertions and 40 deletions:

kallithea/lib/inifile.py

scripts/generate-ini.py

0 comments (0 inline, 0 general)

kallithea/lib/inifile.py

➞

Show inline comments

@@ @@ -2,124 +2,100 @@ @@
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program 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 General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 kallithea.lib.inifile
 ~~~~~~~~~~~~~~~~~~~~~
 Handling of .ini files, mainly creating them from Mako templates and adding
 other custom values.
 """
 import logging
 import re
 import mako.template
 log = logging.getLogger(__name__)
-def expand(template, desc, selected_mako_conditionals, mako_variable_values, settings):
 def expand(template, desc, mako_variable_values, settings):
     """Expand mako template and tweak it.
     Not entirely stable for random templates as input, but good enough for our
     single template.
     >>> template = '''
     ... [first-section]
     ...
     ... variable=${mako_variable}
     ... variable2  =\tvalue after tab
     ... ## This section had some whitespace and stuff
     ...
     ...
     ... # ${mako_function()}
     ... [second-section]
     ... %if conditional_options == 'option-a':
     ... # Kallithea - config file generated with kallithea-config                      #
     ... %elif conditional_options == 'option-b':
     ... some_variable = "never mind - option-b will not be used anyway ..."
     ... %endif
     ... '''
     >>> desc = 'Description\\nof this config file'
     >>> selected_mako_conditionals = ["conditional_options == 'option-a'"]
     >>> mako_variable_values = {'mako_variable': 'VALUE', 'mako_function()': 'FUNCTION RESULT'}
     >>> selected_mako_conditionals = []
     >>> mako_variable_values = {'mako_variable': 'VALUE', 'mako_function': (lambda: 'FUNCTION RESULT'),
     ...                         'conditional_options': 'option-a'}
     >>> settings = { # only partially used
     ...     '[first-section]': {'variable2': 'VAL2', 'first_extra': 'EXTRA'},
     ...     '[third-section]': {'third_extra': ' 3'},
     ...     '[fourth-section]': {'fourth_extra': '4', 'fourth': '"four"'},
     ... }
-    >>> print expand(template, desc, selected_mako_conditionals, mako_variable_values, settings)
     >>> print expand(template, desc, mako_variable_values, settings)
     <BLANKLINE>
     [first-section]
     <BLANKLINE>
     variable=VALUE
     #variable2 = value after tab
     variable2 = VAL2
     ## This section had some whitespace and stuff
     <BLANKLINE>
     <BLANKLINE>
     # FUNCTION RESULT
     [second-section]
     # Description                                                                  #
     # of this config file                                                          #
     <BLANKLINE>
     """
     # 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 = ''
             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, template, 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
     ini_lines = re.sub(r'^## -\*- coding: utf-8 -\*-\n', '', mako_no_variables)
     ini_lines = mako.template.Template(template).render(**mako_variable_values)
     ini_lines = re.sub(
         '# Kallithea - config file generated with kallithea-config *#\n',
         ''.join('# %-77s#\n' % l.strip() for l in desc.strip().split('\n')),
         ini_lines)
     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"""
                 key, value = m.groups()
                 line = m.group(0)
                 if key in section_settings:
                     line = '%s = %s' % (key, section_settings[key])
                     if '$' not in value:
                         line = '#%s = %s\n%s' % (key, value, line)
                 return line.rstrip()
             lines = re.sub(r'^([^#\n\s]*)[ \t]*=[ \t]*(.*)$', 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)
     return ini_lines

scripts/generate-ini.py

➞

Show inline comments

 #!/usr/bin/env python2
 """
 Based on kallithea/lib/paster_commands/template.ini.mako, generate
   development.ini
   kallithea/tests/test.ini
 """
 import re
 from kallithea.lib import inifile
 makofile = 'kallithea/lib/paster_commands/template.ini.mako'
 # the mako conditionals used in all other ini files and templates
 selected_mako_conditionals = set([
     "database_engine == 'sqlite'",
     "http_server == 'waitress'",
 ])
 # the mako variables used in all other ini files and templates
 mako_variable_values = {
     'database_engine': 'sqlite',
     'http_server': 'waitress',
     'host': '127.0.0.1',
     'port': '5000',
-    'uuid()': '${app_instance_uuid}',
+    'uuid': lambda: '${app_instance_uuid}',
+}
 # files to be generated from the mako template
 ini_files = [
     ('kallithea/tests/test.ini',
         '''
         Kallithea - config for tests:
         sqlalchemy and kallithea_test.sqlite
         custom logging
         ''',
+        {
             '[server:main]': {
                 'port': '4999',
             },
             '[app:main]': {
                 'app_instance_uuid': 'test',
                 'show_revision_number': 'true',
                 'beaker.cache.sql_cache_short.expire': '1',
                 'beaker.session.secret': '{74e0cd75-b339-478b-b129-07dd221def1f}',
             },
             '[handler_console]': {
                 'formatter': 'color_formatter',
             },
             # The 'handler_console_sql' block is very similar to the one in
@@ @@ -76,29 +72,29 @@ ini_files = [ @@
             '[handler_console]': {
                 'formatter': 'color_formatter',
             },
             '[handler_console_sql]': {
                 '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 = open(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
         open(makofile, 'w').write(mako_marked_up)
     # create ini files
     for fn, desc, settings in ini_files:
         print 'updating:', fn
-        ini_lines = inifile.expand(mako_no_text_markup, desc, selected_mako_conditionals, mako_variable_values, settings)
+        ini_lines = inifile.expand(mako_marked_up, desc, mako_variable_values, settings)
         open(fn, 'w').write(ini_lines)
 if __name__ == '__main__':
     main()

0 comments (0 inline, 0 general)