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")

複数行の文字列を後処理して不要な部分をtextwrap削除する場合は、PEP 257で提示されているdocstringを後処理するためのモジュールまたは手法を検討する必要があります。

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関数を使用すると、sourceの正しいインデントで開始し、使用する前にテキストからそれを取り除くことができます。

他の人が指摘しているように、これはリテラルに対する追加の関数呼び出しであることのトレードオフです。これらのリテラルをコードのどこに配置するかを決定するときは、これを考慮に入れてください。

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)

\ログメッセージリテラルの末尾は、改行がリテラルに含まれないようにするためです。このように、リテラルは空白行ではなく、次の完全な行で始まります。

からの戻り値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。

他の回答から欠落しているように見える1つのオプション（naxaによるコメントでのみ詳細に言及）は次のとおりです。

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

これにより、適切な配置が可能になり、行を暗黙的に結合し、行シフトを維持します。これは、私にとって、とにかく複数行の文字列を使用したい理由の1つです。

後処理は必要ありませんが\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
"""

これら3つの例でmatplotlib dedentを使用すると、同じ実用的な結果が得られます。textwrap dedent関数には、最初の例のように先行する空白行があります。

明らかな欠点は、matwrapplibが外部モジュールであるのに対して、textwrapが標準ライブラリにあることです。

ここにいくつかのトレードオフがあります... dedent関数は、文字列が定義される場所でコードを読みやすくしますが、使用可能な形式で文字列を取得するには後で処理する必要があります。docstringでは、ほとんどの使用で必要な処理が行われるため、正しいインデントを使用する必要があることは明らかです。

コードに長い文字列が必要な場合、次の明らかに醜いコードを見つけます。長い文字列を囲んでいるインデントから削除します。「Beautifulは醜いよりも優れている」という点で間違いなく失敗しますが、それは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\
"""

私の2セントは、インデントを取得するために行末をエスケープします。

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

たとえば、スクリプト内で「関数の外側にぶら下がる」など、乱雑に見せることなく、印刷用のdocstringの識別レベルを削除/修正するための簡単な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）でインデントしている場合は、代わりに次のようなものを使用します。

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

また、docstringを次のようにしたい場合は、最初の文字を削除する必要はありません。

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

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

最初のオプションは良いものです-インデントが含まれています。Pythonスタイルです-コードを読みやすくします。

正しく表示するには：

print string.lstrip()

テキストの表示方法によって異なります。すべてを左揃えにする場合は、最初のスニペットのようにフォーマットするか、すべてのスペースを左トリミングする行を繰り返します。

文字列の場合、文字列を処理した直後にできます。docstringの場合は、代わりに関数を後処理する必要があります。以下は、両方とも解決できる、両方の解決策です。

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
"""