正确缩进Python多行字符串

函数中Python多行字符串的正确缩进是什么？

    def method():
        string = """line one
line two
line three"""

要么

    def method():
        string = """line one
        line two
        line three"""

或者是其他东西？

在第一个示例中，将字符串挂在函数外部看起来有些奇怪。

您可能想与 """

def foo():
    string = """line one
             line two
             line three"""

由于换行符和空格包含在字符串本身中，因此您必须对其进行后处理。如果您不想这样做，并且文本很多，则可能需要将其分别存储在文本文件中。如果文本文件不能很好地适合您的应用程序，并且您不想进行后处理，那么我可能会选择

def foo():
    string = ("this is an "
              "implicitly joined "
              "string")

如果要对多行字符串进行后处理以修剪掉不需要的部分，则应考虑PEP 257中textwrap介绍的对文档字符串进行后处理的模块或技术：

def trim(docstring):
    if not docstring:
        return ''
    # Convert tabs to spaces (following the normal Python rules)
    # and split into a list of lines:
    lines = docstring.expandtabs().splitlines()
    # Determine minimum indentation (first line doesn't count):
    indent = sys.maxint
    for line in lines[1:]:
        stripped = line.lstrip()
        if stripped:
            indent = min(indent, len(line) - len(stripped))
    # Remove indentation (first line is special):
    trimmed = [lines[0].strip()]
    if indent < sys.maxint:
        for line in lines[1:]:
            trimmed.append(line[indent:].rstrip())
    # Strip off trailing and leading blank lines:
    while trimmed and not trimmed[-1]:
        trimmed.pop()
    while trimmed and not trimmed[0]:
        trimmed.pop(0)
    # Return a single string:
    return '\n'.join(trimmed)

该textwrap.dedent功能允许在源代码中以正确的缩进开始，然后在使用前从文本中删除它。

正如其他一些人所指出的那样，这是对文字的一个额外的函数调用。在决定将这些文字放在代码中的位置时，请考虑到这一点。

import textwrap

def frobnicate(param):
    """ Frobnicate the scrognate param.

        The Weebly-Ruckford algorithm is employed to frobnicate
        the scrognate to within an inch of its life.

        """
    prepare_the_comfy_chair(param)
    log_message = textwrap.dedent("""\
            Prepare to frobnicate:
            Here it comes...
                Any moment now.
            And: Frobnicate!""")
    weebly(param, log_message)
    ruckford(param)

\日志消息文字中的结尾是为了确保换行符不在文字中；这样，文字不以空白行开头，而是以下一个完整行开头。

from的返回值textwrap.dedent是输入字符串，在字符串的每一行上都删除了所有常见的前导空格。因此，上面的log_message值将是：

Prepare to frobnicate:
Here it comes...
    Any moment now.
And: Frobnicate!

inspect.cleandoc像这样使用：

def method():
    string = inspect.cleandoc("""
        line one
        line two
        line three""")

相对缩进将保持预期。正如评论下面，如果你想保持使用前空行，textwrap.dedent。但是，这样也可以保持第一行。

注意：优良作法是在代码的相关上下文下缩进逻辑代码块以阐明结构。例如，属于变量的多行字符串string。

以下似乎是其他答案（仅在naxa的评论的最下方提到）中缺少的一个选项：

def foo():
    string = ("line one\n"          # Add \n in the string
              "line two"  "\n"      # Add "\n" after the string
              "line three\n")

这将允许正确对齐，隐式连接行并仍保持行移位，这对我来说还是我仍然要使用多行字符串的原因之一。

它不需要任何后处理，但是您需要\n在要结束行的任何给定位置手动添加。内联或后接一个单独的字符串。后者更容易复制粘贴。

一些更多的选择。在启用pylab的Ipython中，dedent已经在名称空间中。我检查了，它来自matplotlib。或者可以将其导入：

from matplotlib.cbook import dedent

在文档中它指出它比等效的textwrap更快，在我的ipython测试中，它的确比我的快速测试平均快3倍。它还具有丢弃任何前导空白行的好处，这使您可以灵活地构造字符串：

"""
line 1 of string
line 2 of string
"""

"""\
line 1 of string
line 2 of string
"""

"""line 1 of string
line 2 of string
"""

在这三个示例上使用matplotlib dedent将产生相同的明智结果。textwrap dedent函数在第一个示例中将有一个前导空白行。

明显的缺点是textwrap在标准库中，而matplotlib是外部模块。

这里有一些折衷... dedent函数使您的代码在定义字符串的地方更具可读性，但是需要稍后进行处理才能以可用格式获取字符串。在文档字符串中，很明显应该使用正确的缩进，因为文档字符串的大多数用法都会进行所需的处理。

当我的代码中需要一个非长字符串时，我发现以下公认的丑陋代码，在其中让长字符串脱离了封闭的缩进。肯定在“美丽比丑陋更好”上失败了，但是有人会说它比坚决的选择更简单，更明确。

def example():
    long_string = '''\
Lorem ipsum dolor sit amet, consectetur adipisicing
elit, sed do eiusmod tempor incididunt ut labore et
dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquip.\
'''
    return long_string

print example()

如果您想要一个快速简便的解决方案并避免输入换行符，则可以选择一个列表，例如：

def func(*args, **kwargs):
    string = '\n'.join([
        'first line of very long string and',
        'second line of the same long thing and',
        'third line of ...',
        'and so on...',
        ])
    print(string)
    return

我更喜欢

    def method():
        string = \
"""\
line one
line two
line three\
"""

要么

    def method():
        string = """\
line one
line two
line three\
"""

我的两分钱，逃离行尾以获取缩进：

def foo():
    return "{}\n"\
           "freq: {}\n"\
           "temp: {}\n".format( time, freq, temp )

我来这里是为了寻找一种简单的1-衬板，以去除/校正打印时文档字符串的标识级别，而又不会使其看起来不整洁，例如，通过使其在脚本内“挂在函数外部”。

我最终要做的是：

import string
def myfunction():

    """
    line 1 of docstring
    line 2 of docstring
    line 3 of docstring"""

print str(string.replace(myfunction.__doc__,'\n\t','\n'))[1:] 

显然，如果要缩进空格（例如4）而不是Tab键，请改用如下代码：

print str(string.replace(myfunction.__doc__,'\n    ','\n'))[1:]

而且，如果您希望文档字符串看起来像这样，则无需删除第一个字符：

    """line 1 of docstring
    line 2 of docstring
    line 3 of docstring"""

print string.replace(myfunction.__doc__,'\n\t','\n') 

第一种选择是好的-包括缩进。它是python样式-提供代码的可读性。

要正确显示它：

print string.lstrip()

这取决于您希望文本如何显示。如果您希望所有内容都左对齐，则可以按照第一个代码段的格式对其进行格式化，也可以遍历所有空间的左行进行迭代。

对于字符串，您可以在处理字符串之后。对于文档字符串，您需要对函数进行后处理。这是一个仍然可读的解决方案。

class Lstrip(object):
    def __rsub__(self, other):
        import re
        return re.sub('^\n', '', re.sub('\n$', '', re.sub('\n\s+', '\n', other)))

msg = '''
      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
      velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
      cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
      est laborum.
      ''' - Lstrip()

print msg

def lstrip_docstring(func):
    func.__doc__ = func.__doc__ - Lstrip()
    return func

@lstrip_docstring
def foo():
    '''
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
    veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
    commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
    cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
    est laborum.
    '''
    pass


print foo.__doc__

我遇到类似的问题，使用多行代码使代码变得难以理解，我想到了类似

print("""aaaa
"""   """bbb
""")

是的，一开始看起来可能很糟糕，但是嵌入式语法非常复杂，并且在末尾添加一些内容（例如'\ n“'）不是解决方案

您可以使用此函数trim_indent。

import re


def trim_indent(s: str):
    s = re.sub(r'^\n+', '', s)
    s = re.sub(r'\n+$', '', s)
    spaces = re.findall(r'^ +', s, flags=re.MULTILINE)
    if len(spaces) > 0 and len(re.findall(r'^[^\s]', s, flags=re.MULTILINE)) == 0:
        s = re.sub(r'^%s' % (min(spaces)), '', s, flags=re.MULTILINE)
    return s


print(trim_indent("""


        line one
            line two
                line three
            line two
        line one


"""))

结果：

"""
line one
    line two
        line three
    line two
line one
"""