Indentation correcte pour les chaînes de caractères multilignes ?

Question

Quelle est l'indentation appropriée pour les chaînes de caractères multilignes de Python à l'intérieur d'une fonction ?

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

ou

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

ou autre chose ?

Dans le premier exemple, il est un peu bizarre que la chaîne de caractères soit suspendue en dehors de la fonction.

Answer 1

Vous voudrez probablement vous aligner sur le """

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

Comme les nouvelles lignes et les espaces sont inclus dans la chaîne elle-même, vous devrez la post-traiter. Si vous ne voulez pas le faire et que vous avez beaucoup de texte, vous pouvez le stocker séparément dans un fichier texte. Si un fichier texte ne convient pas à votre application et que vous ne voulez pas faire de post-traitement, j'opterais probablement pour

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

Si vous souhaitez post-traiter une chaîne multiligne pour en éliminer les parties inutiles, vous pouvez utiliser l'option textwrap ou la technique de post-traitement des docstrings présentée dans le module PEP 257 :

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)

Answer 2

Les textwrap.dedent permet de commencer par indentation correcte dans la source Le texte est ensuite dépouillé avant d'être utilisé.

La contrepartie, comme l'ont fait remarquer d'autres personnes, est qu'il s'agit d'un appel de fonction supplémentaire sur le littéral ; tenez-en compte lorsque vous décidez de l'endroit où placer ces littéraux dans votre code.

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)

La fin de l'article \ dans le littéral du message de journal est de s'assurer que le saut de ligne n'est pas dans le littéral ; ainsi, le littéral ne commence pas par une ligne vierge, mais par la ligne complète suivante.

La valeur de retour de textwrap.dedent est la chaîne d'entrée avec toutes les indentations courantes des espaces blancs de tête sont supprimées sur chaque ligne de la chaîne. Ainsi, l'exemple ci-dessus log_message sera :

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

Answer 3

S

from matplotlib.cbook import dedent

I

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

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

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

U

O

S

W

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

Answer 4

Je suis venu ici à la recherche d'un simple 1-liner pour supprimer ou corriger l'identation niveau de la docstring pour l'impression, sans en faire désordre, par exemple en le rendant accrocher à l'extérieur de la fonction" dans le script.

Voici ce que j'ai fait:

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:] 

Évidemment, si vous êtes à la mise en retrait avec des espaces (par exemple, 4) plutôt que la touche de tabulation utiliser quelque chose comme ceci à la place:

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

Et vous n'avez pas besoin de supprimer le premier personnage si vous le souhaitez votre docstrings ressembler à ceci à la place:

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

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

Answer 5

Cela dépend de la manière dont vous souhaitez que le texte s'affiche. Si vous voulez qu'il soit aligné à gauche, vous pouvez soit le formater comme dans le premier extrait, soit itérer à travers les lignes en coupant tout l'espace à gauche.