Skip to content

Conversation

@BdT141
Copy link

@BdT141 BdT141 commented Jan 29, 2022

This allows for comments to be kept and dumped back into file.

Currently supports:
/* Block comments over multiple lines */
// Single line comments
# Single line hash comments

Does not support in line comments such as:
{
pi: 3.1415 // This is pi
}

Usage:
fp = open("testFile.hjson")
configObject, commentPositions = loadWithComments(fp=fp)
fp.close()

fp = open('newFile.hjson', 'w')
dumpWithComments(fp, configObject, commentPositions)
fp.close()

OR:
fp = open("testFile.hjson")
configObject, commentPositions = loadsWithComments(s=fp.read())
fp.close()

dumpedString = dumpsWithComments(configObject, commentPositions)
fp = open('newFile.hjson', 'w')
fp.write(dumpedString)
fp.close()

Note:
As long as the key names of the loaded dictionary object isn't changed by the program or the order of the items isn't changed, everything should be fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant