Python Formatting Large Text

Question

Qual è il modo migliore per formattare un grande blob di testo in python? Non intendo la formattazione dell'output, ma piuttosto la leggibilità. Ho cercato di seguire lo guidelines for python layout, ma non vedo alcuna osservazione su come formattare un grande blob di testo.

Ad esempio:

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

Il grande blocco di testo appare terribile e non è rientrato da 4 spazi, quindi è difficile da leggere.

Cosa ho piacerebbe vedere è:

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

ma questo introduce uno spazio bianco per l'inizio della produzione.

Qualche idea su come posso farlo seguire il layout consigliato per python? Mi piacerebbe tenerlo pulito e facile da leggere.

È possibile farlo senza stampare per ciascuna riga? per esempio.

Quanto sopra è il modo in cui mi piacerebbe che il codice venga visualizzato, senza ricorrere a una stampa su ciascuna riga.

Answer 1

La libreria standard dispone di strumenti per questo:

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

I valori letterali di stringa adiacenti vengono concatenati automaticamente.

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

Answer 3

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

Lo faccio spesso per stringhe molto lunghe.

Answer 4

Si potrebbe utilizzare il vostro indentantion preferito, e rimuovere le schede in seguito:

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

Answer 5

Io di solito faccio qualcosa di simile:

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:', 
    ]) 

Come consente il riarrangiamento (relativamente) facile e l'aggiunta di nuove linee.