kallithea Changeset - d06039dc4ca2

Changeset - d06039dc4ca2

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

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

ini: drop insertion of header comments in generated ini files

The header comments were kind of redundant and could easily get out of sync.
Also, we are moving towards just generating files and don't need this and don't
want to maintain it.

4 files changed with 8 insertions and 35 deletions:

development.ini

kallithea/lib/inifile.py

kallithea/tests/test.ini

scripts/generate-ini.py

0 comments (0 inline, 0 general)

development.ini

➞

Show inline comments

 ################################################################################
 ################################################################################
 # Kallithea - Development config:                                              #
 # listening on *:5000                                                          #
 # sqlite and kallithea.db                                                      #
 # initial_repo_scan = true                                                     #
 # debug = true                                                                 #
 # verbose and colorful logging                                                 #
 # Kallithea - config file generated with kallithea-config                      #
 #                                                                              #
 # The %(here)s variable will be replaced with the parent directory of this file#
 ################################################################################
 ################################################################################
 [DEFAULT]
 ################################################################################
 ## Email settings                                                             ##
 ##                                                                            ##
 ## Refer to the documentation ("Email settings") for more details.            ##
 ##                                                                            ##

kallithea/lib/inifile.py

➞

Show inline comments

@@ @@ -20,87 +20,80 @@ Handling of .ini files, mainly creating @@
 other custom values.
 """
 import logging
 import re
 import mako.template
 log = logging.getLogger(__name__)
-def expand(template, desc, mako_variable_values, settings):
 def expand(template, 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                      #
+    ... # option a was chosen
     ... %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 = []
     >>> 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, mako_variable_values, settings)
     >>> print expand(template, mako_variable_values, settings)
     <BLANKLINE>
     [first-section]
     <BLANKLINE>
     variable=VALUE
     #variable2  =    value after tab
     variable2 = VAL2
     <BLANKLINE>
     first_extra = EXTRA
     <BLANKLINE>
     <BLANKLINE>
     # FUNCTION RESULT
     [second-section]
     # Description                                                                  #
     # of this config file                                                          #
     # option a was chosen
     <BLANKLINE>
     [fourth-section]
     fourth = "four"
     fourth_extra = 4
     <BLANKLINE>
     [third-section]
     third_extra =  3
     <BLANKLINE>
     """
     settings = dict((k, dict(v)) for k, v in settings.items()) # deep copy before mutating
     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.pop(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:
                     # keep old entry as example - comments might refer to it

kallithea/tests/test.ini

➞

Show inline comments

 ################################################################################
 ################################################################################
 # Kallithea - config for tests:                                                #
 # sqlalchemy and kallithea_test.sqlite                                         #
 # custom logging                                                               #
 # Kallithea - config file generated with kallithea-config                      #
 #                                                                              #
 # The %(here)s variable will be replaced with the parent directory of this file#
 ################################################################################
 ################################################################################
 [DEFAULT]
 ################################################################################
 ## Email settings                                                             ##
 ##                                                                            ##
 ## Refer to the documentation ("Email settings") for more details.            ##
 ##                                                                            ##

scripts/generate-ini.py

➞

Show inline comments

@@ @@ -14,60 +14,47 @@ makofile = 'kallithea/lib/paster_command @@
 # 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': lambda: 'VERY-SECRET',
+}
 # 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
             # 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
         debug = true
         verbose and colorful logging
         ''',
+        {
             '[server:main]': {
                 'host': '0.0.0.0',
             },
             '[app:main]': {
                 'initial_repo_scan': 'true',
                 'debug': 'true',
                 'app_instance_uuid': 'development-not-secret',
                 'beaker.session.secret': 'development-not-secret',
             },
             '[handler_console]': {
                 'formatter': 'color_formatter',
@@ @@ -82,19 +69,19 @@ ini_files = [ @@
 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:
     for fn, settings in ini_files:
         print 'updating:', fn
-        ini_lines = inifile.expand(mako_marked_up, desc, mako_variable_values, settings)
         ini_lines = inifile.expand(mako_marked_up, mako_variable_values, settings)
         open(fn, 'w').write(ini_lines)
 if __name__ == '__main__':
     main()

0 comments (0 inline, 0 general)