-
Notifications
You must be signed in to change notification settings - Fork 52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ruamel yaml #145
base: main
Are you sure you want to change the base?
Ruamel yaml #145
Conversation
Awesome; thanks for getting this started! One other thing that #52 mentions is the OrderedDict extension. You can see where we preserve dictionary order here: Line 31 in c328e81
It might be nice to check whether the new library correctly does the same thing in an out-of-the-box way. Have you been able to test yet whether this switch is effective at preserving comments, even without our hack? |
I checked and ruamel uses OrderedDict .
It seems that more work is needed. But I have read the documentation and managed to get a working example. from ruamel.yaml import YAML
from pathlib import Path
input = Path('./input.yaml')
output = Path('./output.yaml')
yml = YAML()
data = yml.load(input)
data["import"]["write"] = False
yml.dump(data, output) To handle round tripping ruamel has special Dumper and Loader. With an empty type in YAML constructor, ruamel take automatically the round tripping classes. I tried to inherit RoundTripDumper to confuse Dumper and same for Loader but I couldn't get it to work |
I found the problem when the yaml file loaded with Lines 79 to 86 in c328e81
I also found an example closer to pyyaml api and this the old API of ruamel. input = Path('./input.yaml')
with input.open() as ifile:
doc = yaml.load(ifile, Loader=yaml.RoundTripLoader)
print(yaml.dump(doc, Dumper=yaml.RoundTripDumper)) |
I also notice that round tripping doest't keep all comments but it appear only with old API of ruamel (example code from my previous message). The first and second comment are dumped correctly but not the third one. Used the new API solves this but I don't see anything to custom the Dumper with the new API. The new API is like the first example I send, #First comment
firstkey:
# Second comment
test:
name: test
# Third comment
arrive: yes
According to the description on pypi, it confirm that ruamel keeps key order. |
Hello ! I replaced pyyaml by Ruamel. This is needed by beetbox/beets#4188
and fixes #52
I removed the hack to keep comments but is there another hack elsewhere ?