当前位置:首页 > Python > 正文

掌握Python三引号字符串(轻松编写多行文本与文档说明)

在学习 Python三引号字符串 之前,你可能已经熟悉了用单引号(')或双引号(")定义字符串。但当你需要写一段包含多行文字、保留格式的文本,或者为函数添加说明文档时,Python 提供了一种更优雅的方式——使用三引号字符串

掌握Python三引号字符串(轻松编写多行文本与文档说明) Python三引号字符串 Python多行字符串 Python文档字符串 Python字符串语法 第1张

什么是三引号字符串?

三引号字符串是 Python 中一种特殊的字符串字面量,它由三个连续的单引号(''')或三个连续的双引号(""")包围而成。它的最大特点是:可以跨越多行,并且保留原始的换行和缩进格式

基本语法

你可以这样定义一个三引号字符串:

# 使用三个双引号multi_line_str = """这是第一行。这是第二行。    这里有缩进。最后一行。"""# 或者使用三个单引号another_str = '''也可以用单引号!同样支持多行。'''

运行上述代码后,multi_line_str 将完整保留所有换行符和空格,输出效果如下:

这是第一行。这是第二行。    这里有缩进。最后一行。

常见用途一:多行文本

当你需要在程序中嵌入一段较长的说明、邮件模板、SQL 查询语句等,三引号字符串非常实用。例如:

email_template = """亲爱的用户,感谢您注册我们的服务!您的账户已成功激活。如有任何问题,请随时联系我们。祝好,客服团队"""print(email_template)

常见用途二:文档字符串(Docstring)

在 Python 中,文档字符串(docstring)是函数、类或模块开头的三引号字符串,用于说明其功能。这是 Python 的最佳实践之一,也是生成 API 文档的基础。

def calculate_area(length, width):    """    计算矩形的面积。        参数:        length (float): 矩形的长度        width (float): 矩形的宽度            返回:        float: 矩形的面积    """    return length * width# 查看文档字符串print(calculate_area.__doc__)

通过 函数名.__doc__ 可以访问文档字符串,许多开发工具(如 VS Code、PyCharm)也会自动显示这些说明。

注意事项

  • 三引号内的内容会原样保留换行和空格,包括开头和结尾的换行。如果你不希望首尾有额外空行,可以这样写:
# 避免开头换行text = """\第一行第二行第三行"""# 或者将第一个引号和内容写在同一行text = """第一行第二行第三行"""
  • 三引号字符串中的变量不会自动替换(不像 f-string),如需插入变量,可结合 .format() 或 f-string 使用:
name = "小明"age = 18info = f"""姓名:{name}年龄:{age}"""print(info)

总结

通过本教程,你应该已经掌握了 Python三引号字符串 的基本用法。无论是处理 Python多行字符串,还是编写规范的 Python文档字符串,三引号都是不可或缺的工具。记住它的核心优势:保留格式、支持跨行、提升代码可读性。

现在,试着在你的项目中使用三引号来优化长文本或添加函数说明吧!这不仅能让你的代码更清晰,也符合 Python字符串语法 的最佳实践。