Comments assigned to wrong sections #48
Comments
|
this is a great report in that it includes both a configuration and an If you're able to do that before I am, and can post the results, that can On Sat, Apr 5, 2014 at 6:29 PM, ntrrgc notifications@github.com wrote:
|
|
It happens the same in 4.7.2. |
|
Ah, great. Based on your description this does sound like a bug, and the fact it happens on 4.7.2 means that I don't need to track down what we changed when we made the python 3 changes. I'd like to take a look at this this afternoon On Sun, Apr 6, 2014 at 3:45 AM, ntrrgc notifications@github.com wrote:
|
|
@ntrrgc, I took a look at this, and I believe the confusion stems from configobj assumes that section comments are "above" the sections, and when all values within a section are commented out, that essentially makes all the comments "under" I feel like you're expecting that comments are associated with the section that they are "under" here's the original results you reported: >>> pprint.pprint(configobj.ConfigObj('zypper.cfg').comments)
{'color': ['',
'## Do not install soft dependencies (recommended packages)',
'# installRecommends = yes',
''],
'main': [],
'solver': ['',
'## Show repository alias instead of name.',
'# showAlias = false',
'',
'## Columns to show in repository list printed by repos (lr) command by default.',
'# repoListColumns = Anr',
'']}The file also yields these two things that you may not have known about (at least, you didn't post it) >>> commented_zypper.initial_comment
['## Configuration file for Zypper.', '']
>>> commented_zypper.final_comment
['', '## Whether to use colors', '# useColors = never']if I uncomment the things that you commented out: here's the new results: >>> pprint.pprint(configobj.ConfigObj('zypper_uncommented.cfg').comments)
{'color': [''], 'main': [], 'solver': ['']}Well, this is unexpected, but this is because none of these are considered section comments now. Here's how it breaks down: >>> uncommented_zypper.initial_comment
['## Configuration file for Zypper.', '']
>>> uncommented_zypper.final_comment
[]
>>> uncommented_zypper['color'].comments
{'useColors': ['', '## Whether to use colors']}
>>> uncommented_zypper['main'].comments
{'showAlias': ['', '## Show repository alias instead of name.'], 'repoListColumns': ['', '## Columns to show in repository list printed by repos (lr) command by default.']}
>>> uncommented_zypper['solver'].comments
{'installRecommends': ['', '## Do not install soft dependencies (recommended packages)']}As long as you have a key/value (possibly a subsection?) in a section, that will associate the comments "under" a section with the key, and not with the following section. You said that this was a simplified version of your config, is the "full-complexity" config worth posting with updated expected results? Or, with this clarification in mind, perhaps this is really a documentation ticket, and you'd either need to:
I don't think the "over" vs "under" for section comments is something that we can change up due to backwards compatibility concerns, so I'm hoping that the explanation here leads us to a good spot. |
|
removed bug and added documentation label, this ticket will be held open until @ntrrgc can weigh in on a doc change / tweaking the config based on this explanation works |
|
Well, indeed I knew about The full configuration file ( In case you're wondering, I use this module here. The purpose is to tweak settings in ini-style files programatically without messing with its format. Although deleting sections is not a commonly performed operation, I thought the behavior is strange enough to post it here. |
|
If I had to guess, it's this way because "key comments" make sense above the key and going above for everything was simpler than applying a heuristic to differentiate between section and key comments (e.g. Break on multiple new lines). I could see this being something that is revisited in the event we start entertaining backwards incompatible changes. I don't have a good sense of what a good comment breakdown looks like, so if you have any suggestions I'd love to hear it. On Mon, Apr 7, 2014 at 2:25 AM, ntrrgc notifications@github.com wrote:
|
|
Maybe stopping on lines than contain an equal sign? |
|
interesting thought. Something to consider in the future |
|
On the topic of comments in a config file. |
This is an over-simplified version of
zypper.conf:When read with configobj, comments are assigned to sections in an awkward fashion:
As a consequence, if I run
del config['solver']I am deleting comments ofmainand preserving comments ofsolver, leading to a very confusing configuration file:The text was updated successfully, but these errors were encountered: