百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

有用的 Python 提示和技巧 — #5 python定义全局变量 多个函数使用技巧

off999 2024-12-27 15:59 36 浏览 0 评论

·

推导式和利用文档字符串

文档字符串是 Python 代码文档的关键组成部分。它们提供了一种简单且标准化的方式来记录模块、函数、类和方法,使开发人员能够了解代码组件的用途和功能。在 Python 中,文档字符串只是用三引号(“”“''')括起来的字符串文字,直接放置在它记录的元素下方。Python 的内置 help() 函数和文档生成工具(如 Sphinx)利用文档字符串,使其成为可维护和可访问代码的基础。

语法和约定

文档字符串通常遵循 Python 的 PEP 257 样式指南推荐的特定结构:

def example(param1, param2):
    """
    Brief description of what the function does.

    More detailed explanation if needed, including any
    edge cases or considerations.
    
    Args:
        param1 (type): Explanation of param1.
        param2 (type): Explanation of param2.
    Returns:
        type: Explanation of the return value.
    Raises:
        ExceptionType: Explanation of when the exception is raised.
    """
    ...

这种结构化方法增强了可读性,并帮助工具提取有用的元数据。值得注意的是,第一行应提供函数用途的简要概述,因为某些工具仅提取此初始行进行摘要。

单行文档字符串非常适合简单的函数或方法,其中一行就足以描述目的。

def add(x, y):
    """Add two numbers and return the result."""
    return x + y

可以使用其内置的 help() 函数或 __doc__ 属性来访问文档。

help(add) # or example.__doc__
add.__doc__ # or example.__doc__

通过遵守这些实践,Python 开发人员可以创建文档齐全、可维护的代码,从而简化新贡献者的开发和入门流程。

doctest:在文档中进行测试

Python 中的 doctest 模块允许您将代码作为其文档的一部分进行测试,这使其成为快速验证示例和确保您的文档准确的便捷而强大的工具。通过在文档字符串中嵌入可测试的代码示例, doctest 会运行这些示例以确认它们按描述工作。这有助于防止文档中的代码腐烂,因为示例与实际代码行为不一致。

doctest的工作原理

要使用 doctest,只需在函数、方法或模块文档字符串中以 Python 交互式会话的形式添加示例。每个示例都以 >>>(Python REPL 提示符)开头,预期输出紧随其后。当 doctest 运行时,它会将实际输出与预期输出进行比较,并标记任何不匹配。

def add(a: int, b: int) -> int:
    """
    Calculate the sum of two numbers.
  
    Example:
    >>> add(2, 3)
    5
    >>> add(-1, 1)
    0
    >>> add(4.5, 1.5)
    6.0
    """
    return a + b

当您运行 doctest 时,它将执行文档字符串中的代码并验证结果是否匹配。您可以从命令行在此脚本上调用 doctest

python -m doctest <filename>.py

或者,您可以在脚本中添加 doctest.testmod() 以在模块作为脚本执行时自动运行测试:

if __name__ == "__main__":
    import doctest
    doctest.testmod()

虽然 doctest 很方便,但它并不能完全替代更广泛的测试框架,例如 unittestpytest 。它最适合没有复杂设置、拆解或高级断言的简单情况。它还可能难以处理略有不同的输出(如浮点结果或非确定性输出)。

请参阅 add 函数的综合文档以了解
有关 DocString 中附加的有关其用法的更多信息。

def add(a, b):
    """
    Calculate the sum of two numbers.

    This function takes two numeric inputs, `a` and `b`, and returns their sum.
    
    It is suitable for integers and floating-point numbers.
    
    Parameters:
      a (int or float): The first number to add.
      b (int or float): The second number to add.
    
    Returns:
      int or float: The sum of `a` and `b`.
    
    Example:
    >>> add(2, 3)
    5
    >>> add(-1, 1)
    0
    >>> add(4.5, 1.5)
    6.0
    """
    return a + b

doctest 合并到您的工作流程中可以使您的代码更可靠,文档更值得信赖,从而使其他人能够有效地理解和验证代码行为。

推导式

Python 推导式是以简洁、可读的方式创建和操作数据的强大工具。此技术允许您直接从其他序列构建序列(如列表、字典或集),所有这些都在一行代码中完成。与使用 Loop 相比,这可能是一个显著的改进。

列表推导式

列表推导式是最常见的类型,通常用于基于现有列表或范围创建列表。

创建 0 到 9 的方格列表的示例 hwo:

# Syntax: [expression for item in iterable if condition]

squares = [x**2 for x in range(10)]
# Output: [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

上面的推导式从 range(10) 中取出每个数字,将其平方,并将其添加到 squares 列表中。您还可以包含条件语句来筛选元素。

如何添加条件以仅包含偶数个方块的示例:

even_squares = [x**2 for x in range(10) if x % 2 == 0]
# Output: [0, 4, 16, 36, 64]

这允许您以高度可读的方式创建筛选和转换的列表。

词典推导

字典推导式对于从序列动态创建字典非常有用。语法类似于列表推导式,但使用键值结构。

创建 0 到 9 的平方字典的示例 hwo:

# Syntax: {key_expression: value_expression for item in iterable if condition}

squares_dict = {x: x**2 for x in range(10)}
# Output: {0: 0, 1: 1, 2: 4, 3: 9, ..., 9: 81}

您还可以像对待列表推导式一样将条件应用于字典推导式。

集合推导式

集合推导式的工作方式与列表推导式类似,但生成的是集合而不是列表。集是无序的,会自动删除重复值,因此当您需要唯一的结果时,这非常有用。

如何为数字 0 到 9 创建一组正方形的示例:

# Syntax: {expression for item in iterable if condition}

squares_set = {x**2 for x in range(10)}
# Output: {0, 1, 4, 9, 16, 25, 36, 49, 64, 81}

您还可以像对待列表推导式一样将条件应用于字典推导式。

生成器推导式

生成器推导式类似于列表推导式,但创建的是生成器而不是列表。生成器一次生成一个项目,并且仅在需要时生成,从而使它们具有内存效率,尤其是对于大型数据集。如果您只需要迭代一次数据,或者数据集太大而无法一次全部放入内存,这将特别有用。

生成器推导式的语法使用括号 () 而不是方括号 [] 或大括号 {}

如何为数字 0 到 9 的平方创建生成器的示例:

# Syntax: (expression for item in iterable if condition)


squares_gen = (x**2 for x in range(10))

在此示例中,squares_gen 是一个生成器对象,仅当迭代每个正方形时,它才会生成每个正方形。

for square in squares_gen:
    print(square)

# Output: 0, 1, 4, 9, 16, 25, 36, 49, 64, 81

但是,请记住,生成器推导式只能迭代一次。如果需要多次访问元素,则列表推导式可能更合适。

相关推荐

笔记本电脑系统修复软件(笔记本电脑程序修复)

1、超级兔子2013系统修复软件超级兔子是一款完整的系统维护工具。拥有电脑系统评测、垃圾清理和注册表清理、可疑文件和插件检测、网页防护等功能,同时自带一些实用的系统工具,可清理你大多数的文件、注册表里...

联想保修服务包括哪些(联想保修都保修什么)

1、保修36个月的硬件包括:CPU、内存。2、保修24个月的硬件包括:主板、显卡、LCD屏、硬盘、电源适配器、键盘、鼠标模块。3、保修12个月的硬件包括:LCD之附件、光驱、DVD、CDR/W、软驱...

系统科学大会(中国系统科学学会)

2021年各种科学大会的召开时间取决于疫情的发展和国家政策的调整。一些大型的国际科学会议可能会推迟或者采用线上形式进行,以保障参会人员的安全和健康。同时,一些国内的学术会议也会受到疫情的影响,需要推迟...

win10系统下载的内容在哪(win10下载的软件在哪个文件夹)

进入C:\Windows\SoftwareDistribution\Download目录下,通过win10应用商店中下载的安装包都放在此目录下。进入C:\Windows\SoftwareDistrib...

下载原版xp系统光盘(xp光盘系统安装教程怎么安装)

方法步骤步骤如下:1、首先打开计算机,在电脑光驱上放入XP光盘,启动电脑后不停按F12、F11、Esc等启动热键,在弹出的启动菜单中选择DVD选项,回车。2、进入光盘主菜单,按数字2或点击选项2运行w...

windows7中文版下载安装(windows7安装包下载)

谢邀,如果你戳设置-时间和语言-区域和语言,右边的语言提示“只允许使用一种语言包”,那么你的系统就是家庭中文版。家庭中文版限定系统界面只能使用简体中文显示,其他功能则与普通家庭版没有区别,也可以使用其...

win7开机按f2怎么重装系统(win7开机按f12怎么重装系统)

开机或重启时,在进入Windows前按F2进入BIOS。  ←→移动到第三个好像是BOOT。  然后将EXTENELBOOT选项设置为ENABLE  最后按F5将第一启动项目设置为EXTENEL...

win10驱动管理(win10驱动程序)
win10驱动管理(win10驱动程序)

win10由于联网后会自动安装驱动,如果自动安装驱动没出现问题,即可视为最佳驱动,若出现问题,卸载出问题的驱动,然后去查自己主板型号,在主板供应商官网下载对应驱动即是最佳01Windows10驱动更新调整当前当你插入连接即插即用(Pn...

2025-12-29 05:51 off999

手机上怎么找qq邮箱登录(用手机怎么找到qq邮箱)

入口是“联系人”选项卡。qq邮箱手机在QQ主菜单中选择下方的“联系人”选项卡;3、在“联系人”中选取“公众号”选项卡;4、在公众号中菜单中找到或搜索“QQ邮箱提醒”,点击进入;5、点击“进入邮箱”;6...

amd显卡控制面板

AMD显卡控制面板是用来管理你的AMD显卡的,可以在控制面板中进行设置一些简单的调整,来提升显卡性能和效果。1、先打开AMD控制面板。2、打开“垂直同步(V-SYNC)”功能,可调整细节,改善影像流畅...

win10老是未响应卡死(window10总是未响应)

具体方法:1、如果win10中的应用程序出现不响应的情况,应该是应用程序加载失败了。可以通过重置方法来解决win10应用程序无响应。2、登录win10系统,用管理员身份运行Powershell(可在C...

usb安装系统步骤(USB安装系统步骤)

1.准备一张U盘,将联想官网下载的系统镜像文件复制到U盘中;2.将U盘插入联想S41U电脑,重启电脑,按F12进入BIOS设置,将U盘设置为启动项;3.重启电脑,进入U盘安装界面,按提示操作,完成系统...

win98安装教程(win98iso怎么安装)

如何安装windows98  一、具体安装步骤  备份好重要文件之后,就可以安装windows98了。  第一步:启动安装程序。  用户如果原来已安装了windows95/97/98,现在拟对其进行升...

雨林木风win7安装(雨林木风win732位安装教程)

  安装步骤如下:  1、光盘放入光驱,复制光盘上的win7.gho和安装系统.exe到硬盘非C盘的文件夹;(gho文件名可以是其他名字,后缀为gho,体积最大的就是。)  2、双击安装系统.exe;...

win10解绑管理员账户(win10管理员账户怎么取消开机密码)

要解除Windows10电脑上的管理员权限,您需要进行以下操作:1.打开“控制面板”:右键单击“开始”按钮,然后选择“控制面板”。2.进入“用户账户”:在控制面板中,选择“用户账户”。3.点击...

取消回复欢迎 发表评论: