一日一技:如何正确处理多行字符串的缩进问题

开发 前端
在Python里面,三引号表示多行字符串。在一对三引号之间的所有字符都是这个多行字符串的一部分。包括你在Python里面习以为常的缩进。

有时候,我们需要使用多行字符串配合format格式化函数来生成Markdown文本。例如,我现在开发了一个AI对话机器人,我发送一个txt文件过去,他首先帮我总结整个文件的内容,然后以问答的形式列出10个要点。

你的代码可能是这样写的:

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

    output = '''
    ## 文本总结

    {summary}

    ## 核心问答

    {qa}
    '''
    return output

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

但如果你直接这样写,你会发现Markdown的渲染好像出问题了。如下图所示:

图片图片

为什么会出现这个问题呢?其实很简单,因为你的Markdown文本有问题。我们来看一下正常的Markdown长什么样:

图片图片

你上下对比看看,会不会觉得非常疑惑,这明明就是一样的,为什么下面可以上面不行?实际上,他们关键的差异,就在于你看不到的空格:

图片图片

在Python里面,三引号表示多行字符串。在一对三引号之间的所有字符都是这个多行字符串的一部分。包括你在Python里面习以为常的缩进。

我们使用repr命令来看看这个有缩进的output实际上长什么样:

图片图片

注意到了吗,在函数里面定义多行字符串时,很容易把缩进带进来,导致##前面有空格,于是这就变成了不合法的Markdown。

要解决这个问题其实也非常简单,在多行字符串定义的时候,不要缩进:

图片图片

但这样你有没有觉得代码变得非常丑?参差不齐。如果你定义多行字符串时还是在更深的缩进里面,代码会更难看,如下图所示:

图片图片

这可太丑了,要是被那些不喜欢Python缩进的人看到,又要被调侃了。

其实要解决这个问题非常简单,使用Python自带的textwrap模块中的dedent就可以了。它可以自动移除多行字符串每一行的前导空格。如下图所示:

图片图片

这样一来,既兼顾了多行字符串的美观,又不会因为缩进导致Markdown渲染失败。

责任编辑:武晓燕 来源: 未闻Code
相关推荐

2024-01-29 00:45:36

跨域后端接口

2022-11-06 21:04:49

字符串字段参数

2024-07-30 08:16:18

Python代码工具

2021-05-08 19:33:51

移除字符零宽

2021-10-20 20:02:47

字符变量函数

2021-09-14 21:29:01

项目环境变量

2022-06-20 19:37:59

Python字符串HTML

2021-06-08 21:36:24

PyCharm爬虫Scrapy

2021-10-15 21:08:31

PandasExcel对象

2022-06-28 09:31:44

LinuxmacOS系统

2022-03-12 20:38:14

网页Python测试

2020-12-04 06:39:25

爬虫网页

2023-10-28 12:14:35

爬虫JavaScriptObject

2024-07-30 08:11:16

2021-04-27 22:15:02

Selenium浏览器爬虫

2021-01-08 05:17:16

重复值JSON爬虫

2022-08-26 09:34:19

单元测试代码项目

2024-11-11 00:38:13

Mypy静态类型

2022-03-07 09:14:04

Selenium鼠标元素

2021-02-14 22:22:18

格式图片 HTTP
点赞
收藏

51CTO技术栈公众号