handle non-indented comment on list item via 'iterabove' in extract_comments

Author: boegel

easybuild/framework/easyconfig/format/one.py

@@ -231,10 +231,7 @@ def _get_item_comments(self, key, val):
         """Get per-item comments for specified parameter name/value."""
         item_comments = {}
 
-        cand_above_comments = list(self.comments['iterabove'].get(key, {}).items())
-        cand_above_comments.extend(list(self.comments['above'].items()))
-
-        for comment_key, comment_val in cand_above_comments:
+        for comment_key, comment_val in self.comments['iterabove'].get(key, {}).items():
             if str(val) in comment_key:
                 item_comments['above'] = comment_val
 
@@ -434,9 +431,10 @@ def grab_more_comment_lines(lines, param_key):
                         self.comments['above'][last_param_key] = comment
                     else:
                         # if the comment is not above a parameter definition,
-                        # just use the whole next line to determine where the comment belongs...
+                        # then it must be a comment for an item of an iterable parameter value
                         before_comment, _ = split_on_comment_hash(rawlines[0], last_param_key)
-                        self.comments['above'][before_comment.rstrip()] = comment
+                        comment_key = before_comment.rstrip()
+                        self.comments['iterabove'].setdefault(last_param_key, {})[comment_key] = comment
                 else:
                     # if there are no more lines, the comment (block) is at the tail
                     self.comments['tail'] = comment

test/framework/easyconfig.py

@@ -1964,7 +1964,6 @@ def test_dump_comments(self):
 
         # check internal structure to keep track of comments
         self.assertEqual(ec.parser._formatter.comments['above'], {
-           "    'https://anotherexample.com',": ['# annoying non-indented comment'],
            'dependencies': [
                '# this is a multiline comment above dependencies',
                '# I said multiline',
@@ -2004,6 +2003,7 @@ def test_dump_comments(self):
             },
             'source_urls': {
                 "    'https://example.com',": ['# first possible source URL'],
+                "    'https://anotherexample.com',": ['# annoying non-indented comment'],
             },
         })
         self.assertEqual(ec.parser._formatter.comments['iterinline'], {