kallithea Changeset - 238885eaead4

Changeset - 238885eaead4

Parent rev.

Child rev.

[Not reviewed]

default

0 2 0

Mads Kiilerich - 6 years ago 2020-04-22 20:53:22
mads@kiilerich.com

inifile: new implementation of setting updates to optimize reuse of comments and append location

Code comments should explain the algorithm, and test coverage suggest it works
correctly.

2 files changed with 40 insertions and 20 deletions:

development.ini

kallithea/lib/inifile.py

0 comments (0 inline, 0 general)

development.ini

➞

Show inline comments

@@ @@ -377,27 +377,26 @@ keys = root, routes, kallithea, sqlalche @@
 keys = console, console_color, console_color_sql, null
 [formatters]
 keys = generic, color_formatter, color_formatter_sql
 #############
 ## LOGGERS ##
 #############
 [logger_root]
 level = NOTSET
 #handlers = console
 ## For coloring based on log level:
 handlers = console_color
 ## For coloring based on log level:
 #handlers = console_color
 [logger_routes]
 #level = WARN
 level = DEBUG
 handlers =
 qualname = routes.middleware
 ## "level = DEBUG" logs the route matched and routing variables.
 [logger_beaker]
 #level = WARN
 level = DEBUG
 handlers =

kallithea/lib/inifile.py

➞

Show inline comments

@@ @@ -94,38 +94,35 @@ def expand(template, mako_variable_value @@
     variable=VALUE
     #variable2  =    value after tab
     variable2 = VAL2
     <BLANKLINE>
     first_extra = EXTRA
     <BLANKLINE>
     <BLANKLINE>
     # FUNCTION RESULT
     [second-section]
     # option a was chosen
     <BLANKLINE>
     [comment-section]
-    #variable3 = 3.0
     variable3 = 3.0
     #variable4 = 4.0
     variable4 = 4.1
     #variable5 = 5.0
     #variable5 = 5.1
     variable5 = 5.2
     #variable6 = 6.0
     #variable6 = 6.1
     #variable7 = 7.0
     #variable7 = 7.1
     variable6 = 6.2
     variable7 = 7.0
     <BLANKLINE>
     variable3 = 3.0
     variable4 = 4.1
     variable6 = 6.2
     #variable7 = 7.1
     <BLANKLINE>
     [fourth-section]
     fourth = "four"
     fourth_extra = 4
     <BLANKLINE>
     [third-section]
     third_extra =  3
     <BLANKLINE>
     """
     mako_variables = dict(default_variables)
     mako_variables.update(mako_variable_values or {})
     settings = dict((k, dict(v)) for k, v in settings.items()) # deep copy before mutating
@@ @@ -134,38 +131,62 @@ def expand(template, mako_variable_value @@
         if key in variable_options:
             if value not in variable_options[key]:
                 print('ERROR: %s is %r - it should be one of %s' %
                       (key, value, ', '.join(repr(x) for x in variable_options[key])))
     ini_lines = mako.template.Template(template).render(**mako_variables)
     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)
             add_after_key_value = {}  # map key to value it should be added after
             def process_line(m):
                 """process a section line and update value if necessary"""
                 key, value = m.groups()
             # 1st pass:
             # comment out lines with keys that have new values
             # find best line for keeping or un-commenting (because it has the right value) or adding after (because it is the last with other value)
             def comment_out(m):
                 """process a section line if in section_settings and comment out and track in add_after_key_value"""
                 line = m.group(0)
                 if key in section_settings:
                     new_line = '%s = %s' % (key, section_settings.pop(key))
                     if new_line != line:
                         # keep old entry as example - comments might refer to it
                         line = '#%s\n%s' % (line, new_line)
                 return line.rstrip()
                 comment, key, line_value = m.groups()
                 if key not in section_settings:
                     return line
                 new_value = section_settings[key]
                 if line_value == new_value or add_after_key_value.get(key) != new_value:
                     add_after_key_value[key] = line_value
                 if comment:
                     return line
                 return '#' + line
             lines = re.sub(r'^(#)?([^#\n\s]*)[ \t]*=[ \t]*(.*)$', comment_out, lines, flags=re.MULTILINE)
             # process lines that not are comments or empty and look like name=value
             lines = re.sub(r'^([^#\n\s]*)[ \t]*=[ \t]*(.*)$', process_line, lines, flags=re.MULTILINE)
             def add_after_comment(m):
                 """process a section comment line and add new value"""
                 line = m.group(0)
                 key, line_value = m.groups()
                 if key not in section_settings:
                     return line
                 if line_value != add_after_key_value.get(key):
                     return line
                 new_value = section_settings[key]
                 if new_value == line_value:
                     line = line.lstrip('#')
                 else:
                     line += '\n%s = %s' % (key, new_value)
                 section_settings.pop(key)
                 return line
             lines = re.sub(r'^#([^#\n\s]*)[ \t]*=[ \t]*(.*)$', add_after_comment, lines, flags=re.MULTILINE)
             # add unused section settings
             if section_settings:
                 lines += '\n' + ''.join('%s = %s\n' % (key, value) for key, value in sorted(section_settings.items()))
         return sectionname + '\n' + lines
     # process sections until comments before next section or end
     ini_lines = re.sub(r'''^
         (\[.*\])\n
         # after the section name, a number of chunks with:
+        (
             (?:

0 comments (0 inline, 0 general)