Skip to content
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.

Sign up for GitHub

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

Jump to bottom

REQ: Support ruamel.yaml's RoundTripLoader/Dumper for retaining comments #184

Open
philipsd6 opened this issue Jan 4, 2021 · 2 comments
Open

REQ: Support ruamel.yaml's RoundTripLoader/Dumper for retaining comments #184

philipsd6 opened this issue Jan 4, 2021 · 2 comments
Labels
enhancement help wanted

Comments

@philipsd6
Copy link

Now that the default YAML library is ruamel.yaml, and its notable feature is round trip comment preservation, my expectation is that this should work:

In [1]: from box import Box      
In [2]: yaml_doc = """--- 
   ...: # This is my YAML doc 
   ...: zlast: 1   # This is a line comment on zlast 
   ...: afirst: 2  # This should be shown second, not first!"""    
In [3]: mybox = Box.from_yaml(yaml_doc)                            
In [4]: print(mybox.to_yaml())   
afirst: 2
zlast: 1

Unordered, and no comments! However ruamel.yaml has RoundTripLoader and RoundTripDumper available!

In [8]: import ruamel.yaml as yaml                                 
In [9]: data = yaml.load(yaml_doc, Loader=yaml.RoundTripLoader)         
In [10]: print(yaml.dump(data, Dumper=yaml.RoundTripDumper))            
# This is my YAML doc
zlast: 1   # This is a line comment on zlast
afirst: 2  # This should be shown second, not first!

But using them with Box only helps resolve the creation order issue -- the comments are gone:

In [11]: mybox = Box.from_yaml(yaml_doc, Loader=yaml.RoundTripLoader)    
In [11]: print(mybox.to_yaml(Dumper=yaml.RoundTripDumper))               
zlast: 1
afirst: 2

Naturally -- as the incoming data is unrolled into a Box in the constructor:

Box/box/box.py

Line 223 in 4a50512

for k, v in kwargs.items():

I'm not sure if there's reasonable way for Box to coexist with the ruamel.yaml.CommentedMap, but it would be VERY convenient to work with my YAML files in box dot notation, while leaving the human readable comments intact.
@michaelaye
Copy link

This would be great! In the mean time, is there a work-around I could do? Is it somehow possible to use Box's ingenious dotted nested access to update something in a YAML object without losing the comments?

@cdgriffith
Copy link
Owner

I am not opposed to this feature, and would be really cool, but is also something I sadly do not have time to work on myself.

A fun hurdle about it would be that PyYAML still has to be supported as well (not looking to have the same comment saving feature, just that it can't break PyYAML users).

Looking at the ruamel.yaml code quickly some it seems that the comments are stored under .ca of the object, but looks like just doing a copy of that into a new class isn't enough for the loader. Someone would have to go through and see what parts of the CommentedMap need to be replicated for the round trip loader to work as expected. https://sourceforge.net/p/ruamel-yaml/code/ci/default/tree/comments.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@michaelaye @philipsd6 @cdgriffith