有時(shí)候，我們需要使用多行字符串配合format格式化函數(shù)來生成Markdown文本。例如，我現(xiàn)在開發(fā)了一個(gè)AI對話機(jī)器人，我發(fā)送一個(gè)txt文件過去，他首先幫我總結(jié)整個(gè)文件的內(nèi)容，然后以問答的形式列出10個(gè)要點(diǎn)。

你的代碼可能是這樣寫的：

def bot(text):
    summary = summary_text_by_gpt(text)
    qa = get_qa_by_gpt(text)

    output = '''
    ## 文本總結(jié)

    {summary}

    ## 核心問答

    {qa}
    '''
    return output

返回Markdown以后，通過前端渲染出正常的文本。

但如果你直接這樣寫，你會(huì)發(fā)現(xiàn)Markdown的渲染好像出問題了。如下圖所示：

圖片

為什么會(huì)出現(xiàn)這個(gè)問題呢？其實(shí)很簡單，因?yàn)槟愕腗arkdown文本有問題。我們來看一下正常的Markdown長什么樣：

圖片

你上下對比看看，會(huì)不會(huì)覺得非常疑惑，這明明就是一樣的，為什么下面可以上面不行？實(shí)際上，他們關(guān)鍵的差異，就在于你看不到的空格：

圖片

在Python里面，三引號(hào)表示多行字符串。在一對三引號(hào)之間的所有字符都是這個(gè)多行字符串的一部分。包括你在Python里面習(xí)以為常的縮進(jìn)。

我們使用repr命令來看看這個(gè)有縮進(jìn)的output實(shí)際上長什么樣：

圖片

注意到了嗎，在函數(shù)里面定義多行字符串時(shí)，很容易把縮進(jìn)帶進(jìn)來，導(dǎo)致##前面有空格，于是這就變成了不合法的Markdown。

要解決這個(gè)問題其實(shí)也非常簡單，在多行字符串定義的時(shí)候，不要縮進(jìn)：

圖片

但這樣你有沒有覺得代碼變得非常丑？參差不齊。如果你定義多行字符串時(shí)還是在更深的縮進(jìn)里面，代碼會(huì)更難看，如下圖所示：

圖片

這可太丑了，要是被那些不喜歡Python縮進(jìn)的人看到，又要被調(diào)侃了。

其實(shí)要解決這個(gè)問題非常簡單，使用Python自帶的textwrap模塊中的dedent就可以了。它可以自動(dòng)移除多行字符串每一行的前導(dǎo)空格。如下圖所示：

圖片

這樣一來，既兼顧了多行字符串的美觀，又不會(huì)因?yàn)榭s進(jìn)導(dǎo)致Markdown渲染失敗。