爲*未通過RoundTripLoader加載的數據結構生成註釋？

Question

我有一個數據結構，我想添加評論，然後轉換成YAML。

我想避免輸出數據結構爲YAML並使用RoundTripLoader加載它。

有沒有辦法將我的數據結構轉換成支持ruamel.yaml註釋界面的數據結構？

Answer 1

有一種方法，雖然它的接口不能保證穩定。 由於這個原因以及缺少文檔，通常可以幫助您查看您的預期產出或其中的一小部分樣本的表示形式round_trip_loading()。

您必須認識到，結構化節點（映射和序列）的表示的特殊版本需要註釋。對於將safe_load()作爲Python dict的映射，這是一個CommentedMap()，對於序列，它將作爲Python list加載，這是一個CommentedSeq()。

這兩個類都可以擁有一個.ca屬性，該屬性持有結構節點之前可能發生的註釋，作爲鍵/值對之後的行尾註釋。項，在鍵值對或項之間的自己的行上，以及在節點的末尾。

這意味着你有任何dict或轉換list你有，需要評論（可通過常規comment_prep()來完成自動/遞歸例如），然後找到正確的點和方式附加的註釋。 由於評論操作例程尚未穩定，因此請確保包裝您的評論以添加例程以獲取更新的單個位置以備更新。

import sys 
from ruamel.yaml import round_trip_dump as rtd 
from ruamel.yaml.comments import CommentedMap, CommentedSeq 

# please note that because of the dict the order of the keys is undetermined 
data = dict(a=1, b=2, c=['x', 'y', dict(k='i', l=42, m='∞')]) 

rtd(data, sys.stdout) 
print('-' * 30) 


def comment_prep(base): 
    """replace all dict with CommentedMap and list with CommentedSeq""" 
    if isinstance(base, dict): 
     ret_val = CommentedMap() 
     for key in sorted(base): # here we force sorted order 
      ret_val[key] = comment_prep(base[key]) 
     return ret_val 
    if isinstance(base, list): 
     ret_val = CommentedSeq() 
     for item in base: 
      ret_val.append(comment_prep(item)) 
     return ret_val 
    return base 

data = comment_prep(data) 
data['c'][2].yaml_add_eol_comment('# this is the answer', key='l', column=15) 
rtd(data, sys.stdout) 

給出：

c: 
- x 
- y 
- k: i 
    m: ∞ 
    l: 42 
b: 2 
a: 1 
------------------------------ 
a: 1 
b: 2 
c: 
- x 
- y 
- k: i 
    l: 42  # this is the answer 
    m: ∞ 

文件test_comment_manipulation.py，有一些更多的例子，是一個很好的地方，留意（如界面發生變化，因此將在該文件中的測試）。