Formatowanie dużego tekstu w Pythonie

Question

Jaki jest najlepszy sposób na sformatowanie dużej kropli tekstu w pythonie? Nie mam na myśli formatowania wyników, ale raczej czytelności. Próbowałem podążać za guidelines for python layout, ale nie widzę żadnych uwag, jak sformatować duży obszar tekstowy.

Na przykład:

class GenerateCalendar(object): 
def __init__(self): 
    super(GenerateCalendar, self).__init__() 

def getCalendarHeader(self): 
    print """ 
BEGIN:VCALENDAR 
PRODID:-//Atlassian Software Systems//Confluence Calendar Plugin//EN 
VERSION:2.0 
CALSCALE:GREGORIAN 
X-WR-CALNAME;VALUE=TEXT: 
X-WR-CALDESC;VALUE=TEXT: 
""" 

Duży blok tekstu, wygląda okropnie, a to nie jest wcięte przez 4 spacji, więc jest to trudne do odczytania.

I co chciałbym zobaczyć, to:

def getCalendarHeader(self): 
    print """ 
    BEGIN:VCALENDAR 
    PRODID:-//Atlassian Software Systems//Confluence Calendar Plugin//EN 
    VERSION:2.0 
    CALSCALE:GREGORIAN 
    X-WR-CALNAME;VALUE=TEXT: 
    X-WR-CALDESC;VALUE=TEXT: 
    """ 

ale wprowadza to spacje na początku produkcji.

Jakieś pomysły na to, jak mogę to zrobić, stosując zalecany układ dla Pythona? Chciałbym, żeby to było schludne i łatwe do odczytania.

Czy można to zrobić bez wykonywania nadruku dla każdej linii? na przykład

def getCalendarHeader(self): 
    print "BEGIN:VCALENDAR\n" 
    print "PRODID:-//Atlassian Software Systems//Confluence Calendar Plugin//EN\n" 
    print "VERSION:2.0\n" 
    print "CALSCALE:GREGORIAN\n" 
    print "X-WR-CALNAME;VALUE=TEXT:\n" 
    print "X-WR-CALDESC;VALUE=TEXT:\n" 

Powyższy sposób polega na tym, że chciałbym, aby kod pojawił się bez konieczności drukowania w każdej linii.

Answer 1

Standardowa biblioteka ma narzędzia do tego:

import textwrap 

#... 

    def getCalendarHeader(self): 
     print textwrap.dedent("""\ 
      BEGIN:VCALENDAR 
      PRODID:-//Atlassian Software Systems//Confluence Calendar Plugin//EN 
      VERSION:2.0 
      CALSCALE:GREGORIAN 
      X-WR-CALNAME;VALUE=TEXT: 
      X-WR-CALDESC;VALUE=TEXT: 
      """) 

Answer 2

Sąsiednie ciągi literałów są łączone automatycznie.

>>> 'x' 'y' 
'xy' 

Answer 3

print("first line\n" 
     "second line\n" 
     "first part of third line" 
     "rest of third line\n") 

zrobić to często bardzo długich ciągów.

Answer 4

Można użyć ulubionego indentantion i wyjąć zaczepy potem:

def getCalendar(): 
    return ''' 
    Text here 
    Text here 
    Text here 
    Text here 
    '''.replace('\t', '') 

Answer 5

I zazwyczaj coś takiego:

print '\n'.join([ 
    'BEGIN:VCALENDAR', 
    'PRODID:-//Atlassian Software Systems//Confluence Calendar Plugin//EN', 
    'VERSION:2.0', 
    'CALSCALE:GREGORIAN', 
    'X-WR-CALNAME;VALUE=TEXT:', 
    'X-WR-CALDESC;VALUE=TEXT:', 
    ]) 

Umożliwia to (względnie) łatwe przegrupowanie i dodanie nowych linii.