Wie würde ich einen Python Docstring hübsch drucken?

Question

Ich habe eine Python-Datei mit rohen Strings als Docstrings.

def a(): 
    '\n\tthis\n\tis\n\tthe docstring.\n\t' 
    print 'hello world' 

wie würde ich schreiben die docstring aussehen

def a(): 
    """ 
    this 
    is 
    the docstring. 
    """ 
    print 'hello world' 

Answer 1

Hier ein Beispiel ist die inspect.getsoucelines und einige regex:

import inspect 
import re 

def update_doc(func, indent=' '): 
    sourcelines = inspect.getsourcelines(func)[0] 
    doc = func.__doc__ 
    if doc is not None: 
     ind = [line.decode('string_escape').strip()[1:-1] 
               for line in sourcelines].index(doc) 
     sourcelines[ind] = '{}"""{}"""\n'.format(indent, 
              re.sub(r'\n([ \t]+)', r'\n'+indent, doc)) 
    return ''.join(sourcelines) 

Demo:

def a(): 
    '\n\tthis\n\tis\n\tthe docstring.\n\t' 
    print 'hello world' 
print update_doc(a) 

def b(): 
    '\n This is\n not so lengthy\n docstring\n ' 
    print 'hmm...' 
print update_doc(b) 

Output

:

def a(): 
    """ 
    this 
    is 
    the docstring. 
    """ 
    print 'hello world' 

def b(): 
    """ 
    This is 
    not so lengthy 
    docstring 
    """ 
    print 'hmm...' 

P. S: Ich habe es nicht gründlich noch nicht getestet, aber das sollte Ihnen den Einstieg.

Answer 2

Pyment ermöglicht das Erstellen, Harmonisieren und Konvertieren von Docstrings.

Es kann derzeit nicht vorgeschlagen werden, rohe Beschreibung als \n zu erweitern, aber es könnte leicht sein, diese Funktionalität hinzuzufügen. Sie können ein Problem öffnen, um es anzufordern.