kallithea Changeset - 6b01e99bdb2b

Changeset - 6b01e99bdb2b

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Mads Kiilerich (mads) - 6 years ago 2020-04-23 11:05:09
mads@kiilerich.com

Grafted from: 325f9879452c

inifile: make it possible for expand() to comment out settings without assigning new value

For completeness, when we already can create and update values, also make it
possible to delete. This fits nicely into the implementation. Potentiallly
"nice to have" but not used yet.

The ini file is a text file and it only really makes sense to set string
values. Intuitively, it makes sense that setting something to None means that
the old value should be commented out but no new value should be set. If we
want to set a value of "None", then specify "None" - not None.

1 file changed with 7 insertions and 6 deletions:

kallithea/lib/inifile.py

0 comments (0 inline, 0 general)

kallithea/lib/inifile.py

➞

Show inline comments

@@ @@ -98,51 +98,48 @@ def expand(template, mako_variable_value @@
     variable2 = VAL2
     <BLANKLINE>
     first_extra = EXTRA
     spacey =
     <BLANKLINE>
     <BLANKLINE>
     # FUNCTION RESULT
     [second-section]
     # option a was chosen
     <BLANKLINE>
     [comment-section]
     variable3 = 3.0
     #variable4 = 4.0
     variable4 = 4.1
     #variable5 = 5.0
     #variable5 = 5.1
     variable5 = 5.2
     #variable6 = 6.0
     #variable6 = 6.1
     variable6 = 6.2
     variable7 = 7.0
     #variable7 = 7.1
     #variable8 = 8.0
     <BLANKLINE>
     variable8 = None
     variable9 = None
     <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
     for key, value in mako_variables.items():
         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:
@@ @@ -159,59 +156,63 @@ def expand(template, mako_variable_value @@
                 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)
             # 2nd pass:
             # find the best comment line and un-comment or add after
             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:
+                elif new_value is not None:
                     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)
             # 3rd pass:
             # settings that haven't been consumed yet at is appended to section
             if section_settings:
                 lines += '\n' + ''.join('%s = %s\n' % (key, value) for key, value in sorted(section_settings.items()))
             append_lines = ''.join(
                 '%s = %s\n' % (key, value)
                 for key, value in sorted(section_settings.items())
                 if value is not None)
             if append_lines:
                 lines += '\n' + append_lines
         return sectionname + '\n' + re.sub('[ \t]+\n', '\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:
+        (
             (?:
                 # a number of comments or empty lines
                 (?:[#].*\n|\n)*
                 # one or more non-empty non-comments non-section-start lines
                 (?:[^\n#[].*\n)+
                 # a number of comments - not empty lines
                 (?:[#].*\n)*
             )*
+        )
         ''',
         process_section, ini_lines, flags=re.MULTILINE | re.VERBOSE) \
         + \
         ''.join(
             '\n' + sectionname + '\n' + ''.join('%s = %s\n' % (key, value) for key, value in sorted(section_settings.items()))
             for sectionname, section_settings in sorted(settings.items())
             if section_settings)

0 comments (0 inline, 0 general)