如何使用多行字符串参数来处理嵌套函数调用的重新格式化

时间:2018-08-15 07:50:32

标签: python formatting multiline oitnb

我们使用oitnb,并在配置文件中使用multi-line-unwrap选项,设置了python代码库的自动格式设置。在此之前,我们对所有带有--meld的文件进行了初始传递,并插入了适当的fmt: no注释。

尽管我们使用unwrap选项,但这些注释通常是使用.format()函数在多行字符串中插入的。重新格式化无需更改:

print('first:  {a}\nsecond: {b}\nthird:  {c}'.format(a=1, b=2, c=3))

,但我们无法真正看到打印的元素是否对齐。我们倾向于使用:

print("""\
first:  {a}
second: {b}
third:  {c}
""".format(a=1, b=2, c=3))

但是使用oitnb可以解决此问题:

print("""\
first:  {a}
second: {b}
third:  {c}
""".format(
        a=1, b=2, c=3
    )
)

当这种打印在函数或类方法中时,甚至更糟,因为我们然后用dedent包装:

def main():
    print(dedent("""\
        first:  {a}
        second: {b}
        third:  {c}
    """.format(a=1, b=2, c=3)))

我们还可以解开format参数吗?还是其他一些针对新代码的解决方案,因此我们不需要使用fmt注释?

1 个答案:

答案 0 :(得分:1)

没有选择解开附加到多行字符串的方法的选项,但是我将考虑解开该方法(或添加一个新选项)。展开嵌套例程,使内部例程具有多行字符串会更加困难。

当前IMO最好的方法是将字符串分配给变量,其名称应足够短以至于不会在函数调用行中引起换行:

def main():
    fmt_s = """\
        first:  {a}
        second: {b}
        third:  {c}
    """
    print(dedent(fmt_s.format(a=1, b=2, c=3)), end="")

重新设置相同格式(假设您未将行长设置为非常低的值,那么也是如此:

def main():
    fmt_s = dedent("""\
        first:  {a}
        second: {b}
        third:  {c}
    """)
    print(fmt_s.format(a=1, b=2, c=3), end="")

请注意,在应用dedent之前,这两个版本.format()都是如此。我发现他几乎总是您想要的,因为它使您不必包含太多空格因为您的多行字符串在format参数中的所有换行符之后都有前导空格。您的示例会在format-ting之后出现。