Come potrei stampare una docstring python?

Question

Ho un file python con stringhe non elaborate come docstring.

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

come faccio a riscrivere la docstring per assomigliare

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

Answer 1

Ecco un esempio utilizzando il inspect.getsoucelines e alcuni 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) 

uscita:

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

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

P.S: Non ho ancora testato a fondo, ma questo dovrebbe iniziare.

Answer 2

Pyment consente di creare, armonizzare e convertire docstring.

Attualmente non è possibile proporre l'espansione della descrizione come \n, ma potrebbe essere facile aggiungere questa funzionalità. È possibile aprire un problema per richiederlo.