Python 当使用ruamel.yaml加载和转储时,如何强制注释位置对Yamlint有效?
我希望能够“重新定位”yaml文档中的现有注释,以便在对生成的输出运行Python 当使用ruamel.yaml加载和转储时,如何强制注释位置对Yamlint有效?,python,ruamel.yaml,Python,Ruamel.yaml,我希望能够“重新定位”yaml文档中的现有注释,以便在对生成的输出运行yamlint时它们是有效的,默认配置为minspacesfromcontent=2(参考:) 据我所知,使用类似于yaml\u add\u eol\u comment('the comment','the key',column=None)的方法应该可以做到这一点,但到目前为止我还没有得到这样的结果 下面是我编写的一段代码(使用版本0.16.7中的ruamel.yaml),用于演示我当前的行为: """Play with c
yamlint
时它们是有效的,默认配置为minspacesfromcontent=2
(参考:)
据我所知,使用类似于yaml\u add\u eol\u comment('the comment','the key',column=None)
的方法应该可以做到这一点,但到目前为止我还没有得到这样的结果
下面是我编写的一段代码(使用版本0.16.7
中的ruamel.yaml
),用于演示我当前的行为:
"""Play with comments."""
from __future__ import print_function
import sys
import ruamel.yaml
yaml = ruamel.yaml.YAML()
yaml.indent(mapping=2, sequence=4, offset=2)
inp = """\
---
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
"""
data = yaml.load(inp)
def process_comments(data, column=None):
if isinstance(data, dict):
if data.ca:
if data.ca.items:
for key in data.ca.items.keys():
if data.ca.items[key][2]:
comment = data.ca.items[key][2].value.replace("\n", "")
data.yaml_add_eol_comment(comment, key, column=column)
for k, v in data.items():
process_comments(k, column=column)
process_comments(v, column=column)
elif isinstance(data, list):
if data.ca:
if data.ca.items:
for key in data.ca.items.keys():
if data.ca.items[key][0]:
comment = data.ca.items[key][0].value.replace("\n", "")
data.yaml_add_eol_comment(comment, key, column=column)
for elem in data:
process_comments(elem, column=column)
process_comments(data, column=None)
yaml.dump(data, sys.stdout)
预期产出为:
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
实际输出为:
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
看来:
- 对于CommentedMaps,第一个键的注释在#之前有两个空格,但与CommentedMap的其他键关联的其他注释没有空格
- 对于CommentedSeq,在#
"""Test comments on a very simple CommentedMap."""
import sys
import ruamel.yaml
comment_column = None
insert = ruamel.yaml.comments.CommentedMap()
insert["test"] = "asdf"
insert.yaml_add_eol_comment("Test Comment!", "test", column=comment_column)
insert["second-key"] = "yop"
insert.yaml_add_eol_comment("Another comment", "second-key", column=comment_column)
yaml = ruamel.yaml.YAML()
yaml.dump(insert, sys.stdout)
产出:
test: asdf # Test Comment!
second-key: yop # Another comment
免责声明:
- 非常感谢
的作者,这是一个很棒的库。。。谢谢大家关注关于自由党的问题ruamel.yaml
- 我根本不是假装是一个优秀的python开发人员,所以如果我的代码质量不好,请原谅我
yaml\u add\u eol\u注释
这总是会增加额外的空间:
import sys
import ruamel.yaml
yaml = ruamel.yaml.YAML()
yaml.indent(mapping=2, sequence=4, offset=2)
inp = """
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
"""
data = yaml.load(inp)
def my_add_eol_comment(self, comment, key=ruamel.yaml.comments.NoComment, column=None):
org_col = column
if column is None:
try:
column = self._yaml_get_column(key)
except AttributeError:
column = 0
if comment[0] != '#':
comment = '# ' + comment
if org_col != 0: # only do this if the specified colunn is not the beginning of the line
if comment[0] == '#':
comment = ' ' + comment
column = 0
start_mark = ruamel.yaml.error.CommentMark(column)
ct = [ruamel.yaml.tokens.CommentToken(comment, start_mark, None), None]
self._yaml_add_eol_comment(ct, key=key)
ruamel.yaml.comments.CommentedBase.yaml_add_eol_comment = my_add_eol_comment
def process_comments(data, column=None):
if isinstance(data, dict):
if data.ca:
if data.ca.items:
for key in data.ca.items.keys():
if data.ca.items[key][2]:
comment = data.ca.items[key][2].value.replace("\n", "")
data.yaml_add_eol_comment(comment, key, column=column)
for k, v in data.items():
process_comments(k, column=column)
process_comments(v, column=column)
elif isinstance(data, list):
if data.ca:
if data.ca.items:
for key in data.ca.items.keys():
if data.ca.items[key][0]:
comment = data.ca.items[key][0].value.replace("\n", "")
data.yaml_add_eol_comment(comment, key, column=column)
for elem in data:
process_comments(elem, column=column)
process_comments(data, column=None)
yaml.dump(data, sys.stdout)
其中:
list-of-maps:
- part_no: A4786 # comment 1
part_henon: mouhaha # you're not funny
- part_yes: A21 # also a comment here
part_iculier: partenaire # I don't always understand how it works
part_third: key # komment
list-only:
- first # comment 2
- third # I have a comment too
- second # what?
simple-map:
what-are-you-waiting-for: christmas? # duke nukem rulez
jingle: bels # not christmas yet
map-of-maps:
key:
another-sub-key: w00t # casimir
sub-key: sub-value # comment 3
my-sub-key-name-is-longuer-than-yours: 1 # sentinel vs superman
感谢您的快速反馈和回答!您想让我为第一个地图项目上添加的空间的nb上的问题提交一个bug吗?