Support comments as part of multiline values in configparser
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Feature or enhancement
Proposal:
Today's configparser module does not consider lines being properly indented and starting with a comment_prefixes to be part of a multiline value. This can lead to unintended data loss during reading an INI file as:
config.ini
# I am a comment
# I am also a comment
[dummy]
# I am a comment
key = I am a multiline
# I am a comment
# multiline part which is not considered but should be
being again part
# I am a comment
test.py
import configparser
config = configparser.ConfigParser(comment_prefixes='#', interpolation=None, inline_comment_prefixes=None)
config.read('config.ini')
print(config['dummy']['key'])
# output: 'I am a multiline\nbeing again part'
# expected output: 'I am a multiline\n# multiline part which is not considered but should be\nbeing again part''
Therefore, I would propose to add a new parameter allow_comment_in_value (default False) in the ConfigParser class to support such scenarios. Please note that in this scenario the comment_prefixes is set to '#' and any interpolation is disabled!
Thanks and best regards!
Has this already been discussed elsewhere?
No response given
Links to previous discussion of this feature:
No response
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit dem ConfigParser-Einstiegspunkt und reproduzieren Sie das Verhalten anhand des Beispiels mit config.ini und test.py im Issue. Verfolgen Sie, wie comment_prefixes und mehrzeilige Werte behandelt werden, und fügen Sie anschließend Tests für die vorgeschlagene Option hinzu. Fertig ist es, wenn der eingerückte Kommentar im mehrzeiligen Wert erhalten bleibt, während das bestehende Verhalten standardmäßig unverändert bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100