Save/đổ một file YAML với ý kiến ​​trong PyYAML

Question

Tôi có một tập tin yaml trông như thế này:

# The following key opens a door 
key: value 

Có cách nào tôi có thể load và dump dữ liệu này trong khi duy trì bình luận?

Answer 1

PyYAML ném nhận xét ở mức rất thấp (trong Scanner.scan_to_next_token).

Mặc dù bạn có thể điều chỉnh hoặc mở rộng để xử lý các nhận xét trong toàn bộ ngăn xếp, đây sẽ là một sửa đổi lớn. Dump ing (= phát ra) ý kiến ​​có vẻ dễ dàng hơn và đã được thảo luận trong ticket 114 trên trình theo dõi lỗi PyYAML cũ. Rất tiếc, các vé cũ chưa được lưu trữ (và archive.org search hiện bị hỏng).

Answer 2

Nếu bạn đang sử dụng khối cấu trúc YAML, bạn có thể sử dụng python package¹ ruamel.yaml đó là một dẫn xuất của PyYAML và hỗ trợ bảo quản khứ hồi ý kiến ​​:

import sys 
import ruamel.yaml 

yaml_str = """\ 
# example 
name: 
    # details 
    family: Smith # very common 
    given: Alice # one of the siblings 
""" 

code = ruamel.yaml.round_trip_load(yaml_str) 
code['name']['given'] = 'Bob' 

ruamel.yaml.round_trip_dump(code, sys.stdout) 

với kết quả:

# example 
name: 
    # details 
    family: Smith # very common 
    given: Bob  # one of the siblings 

Lưu ý rằng các nhận xét cuối dòng vẫn được căn chỉnh.

Thay vì bình thường list và dict các đối tượng code bao gồm các phiên bản được bao gói² mà các nhận xét được đính kèm.

¹ _{Cài đặt với pip install ruamel.yaml. Hoạt động trên Python 2,6/2,7/3,3 +}
² _{ordereddict được sử dụng trong trường hợp của một ánh xạ, để bảo tồn đặt hàng}

Answer 3

Tôi đã một chi nhánh của pyyaml ​​thực hiện chính xác này. https://github.com/pflarr/pyyaml

Để tạo tệp yaml có nhận xét, bạn phải tạo luồng sự kiện bao gồm các sự kiện nhận xét. Nhận xét hiện chỉ được phép trước các mục trình tự và các phím ánh xạ.

Điều này hiện chỉ hoạt động cho python3, tôi chưa chuyển nó sang phiên bản python2 của thư viện, nhưng có thể dễ dàng thực hiện theo yêu cầu. Ngoài ra, điều này cũng nên được khá dễ dàng để cổng đến libyaml C là tốt, như mã python là một cổng đơn giản của anyway.