hjson-py icon indicating copy to clipboard operation
hjson-py copied to clipboard

Keep comments

Open BdT141 opened this issue 4 years ago • 0 comments

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.

BdT141 avatar Jan 29 '22 11:01 BdT141