Doct coinvolge personaggi di escape

Question

Avere una funzione fix(), come funzione di supporto per una funzione di output che scrive stringhe su un file di testo.

def fix(line): 
    """ 
    returns the corrected line, with all apostrophes prefixed by an escape character 

    >>> fix('DOUG\'S') 
    'DOUG\\\'S' 

    """ 
    if '\'' in line: 
     return line.replace('\'', '\\\'') 
    return line 

Accensione doctests, ottengo il seguente errore:

Failed example: 
    fix('DOUG'S') 
Exception raised: 
    Traceback (most recent call last): 
     File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/doctest.py", line 1254, in __run 
     compileflags, 1) in test.globs 
     File "<doctest convert.fix[0]>", line 1 
     fix('DOUG'S') 
       ^

Non importa quale combinazione di \ e 's che uso, il doctest non sembra voler lavorare, anche se la funzione stessa funziona perfettamente. Avere il sospetto che sia il risultato del doctest in un commento di blocco, ma qualche consiglio per risolverlo.

Answer 1

E 'questo che vogliono ?:

def fix(line): 
    r""" 
    returns the corrected line, with all apostrophes prefixed by an escape character 

    >>> fix("DOUG\'S") 
    "DOUG\\'S" 
    >>> fix("DOUG'S") == r"DOUG\'S" 
    True 
    >>> fix("DOUG'S") 
    "DOUG\\'S" 

    """ 
    return line.replace("'", r"\'") 

import doctest 
doctest.testmod() 

stringhe prime sono tuo amico ...

Answer 2

In primo luogo, questo è quello che succede se si chiama in realtà la funzione nell'interprete interattivo:

>>> fix("Doug's") 
"Doug\\'s" 

Si noti che non è necessario per sfuggire virgolette singole in stringhe tra doppi apici, e che Python non fai questo nella rappresentazione della stringa risultante - solo la barra rovesciata viene sfuggita.

Questo significa che la docstring corretta dovrebbe essere

""" 
returns the corrected line, with all apostrophes prefixed by an escape character 

>>> fix("DOUG'S") 
"DOUG\\\\'S" 

""" 

userei una stringa letterale RAW per questa stringa di documentazione per renderlo più leggibile (non testata!):

r""" 
returns the corrected line, with all apostrophes prefixed by an escape character 

>>> fix("DOUG'S") 
"DOUG\\'S" 

"""