0

0

在 Python 中注释函数

心靈之曲

心靈之曲

发布时间:2024-12-26 15:57:01

|

436人浏览过

|

来源于php中文网

原创

在 python 中注释函数

最近,我撰写了一篇关于TypeScript函数注释的博文。 深入研究后,我了解了更多关于Python函数注释的知识。 本文将使用与上一篇博文类似的示例,讲解Python函数的注释方法。

您可以通过将python.analysis.typecheckingMode设置为basicstandardstrict来验证Visual Studio Code中的类型注释。 basicstandard选项不一定能保证您对函数和变量的注释正确性,但strict模式可以。

函数作为值

您可以在Python中返回函数,并将函数作为值传递。回调函数实际上使用callable类型进行注释,其语法如下:

callable[[argtype1, argtype2, argtype3], returntype]

例如,函数length(text: str) -> int将被注释为callable[[str], int]

立即学习Python免费学习笔记(深入)”;

例如,JavaScript中的这个函数:

function multiplier(factor){
    return value => factor * value
}

const n = multiplier(6)
n(8) // 48

在Python中可以这样写:

def multiplier(factor):
    def inner(value):
        return value * factor
    return inner

n = multiplier(6)
n(8) # 48

我们可以创建一个名为number的类型别名,它是intfloat的联合类型:

from typing import typealias, Union

number: typealias = Union[int, float]

将参数视为JavaScript数字。

因此,要注释此函数,我们有:

def multiplier(factor: number) -> callable[[number], number]:
    def inner(value: number) -> number:
        return value * factor
    return inner

a = multiplier(4.5)
a(3) # 13.5

泛型函数

经典的泛型函数示例是:

def pick(array, index):
    return array[index]

pick([1,2,3], 2) # 3

使用TypeVar,我们可以创建更详细的泛型信息(比TypeScript更详细)。

from typing import TypeVar

t = TypeVar("t")  # 参数名和变量名必须相同

这样我们就有:

from typing import TypeVar, Sequence

def pick(array: Sequence[t], index: int) -> t:
    return array[index]

print(pick([1,2,3,4], 2))

那么自定义mymap函数呢?它的作用类似于JavaScript中的map函数。

2088shop商城购物系统
2088shop商城购物系统

2088shop商城购物系统是商城系统中功能最全的一个版本:非会员购物、商品无限级分类、不限商品数量、商品多级会员定价、上货库存、Word在线编辑器、订单详情销售报表、商品评论、留言簿、管理员多级别、VIP积分、会员注册积分奖励、智能新闻发布、滚动公告、投票调查、背景图片颜色更换、店标上传、版权联系方式修改、背景音乐(好歌不断)、广告图片支持Flash、弹出浮动广告、搜索引擎关健词优化、图文友情联

下载
注意: Python中的map()返回的是迭代器,而不是列表。
def mymap(array, fn):
    return map(fn, array)

def twice(n): return n * 2
print(mymap([1,2,3], twice))

我们可以混合使用callableTypeVar类型来注释此函数。

from typing import TypeVar, Iterable, Callable

input_type = TypeVar("input_type")
output_type = TypeVar("output_type")

def mymap(array: Iterable[input_type], fn: Callable[[input_type], output_type]) -> Iterable[output_type]:
    return map(fn, array)

def twice(n: int) -> int: return n * 2
print(mymap([1,2,3], twice))

或者我们可以为callable函数创建别名:

from typing import TypeVar, Iterable, Callable

input_type = TypeVar("input_type")
output_type = TypeVar("output_type")

MappableFunction = Callable[[input_type], output_type]

def mymap(array: Iterable[input_type], fn: MappableFunction) -> Iterable[output_type]:
    return map(fn, array)

MappableFunction接受泛型类型输入和输出,并将它们应用到Callable[[input_type], output_type]上下文中。

思考一下myfilter函数该如何注释?

如果您想到了这个:

from typing import Iterable, TypeVar, Callable

input_type = TypeVar("input_type")

def myfilter(array: Iterable[input_type], fn: Callable[[input_type], bool]) -> Iterable[input_type]:
    return filter(fn, array)

您答对了!

泛型类

Python中的泛型类与TypeScript中的定义方式有所不同。

在TypeScript中,您可以这样定义:

class genericstore{
    stores: type[] = []

    constructor(){
        this.stores = []
    }

    add(item: type){
        this.stores.push(item)
    }
}

const g1 = new genericstore(); //g1.stores: string[]
g1.add("hello") // only strings are allowed

但在Python中,它们相当不同。

  • 首先,我们导入Generic类型,然后让它们成为泛型类的子类。

因此,要在Python中重新创建这个GenericStore类:

from typing import Generic, TypeVar
from dataclasses import dataclass

Type = TypeVar("Type")

@dataclass
class GenericStore(Generic[Type]):
    store: list[Type] = []

    def add(self, item: Type) -> None:
        self.store.append(item)

g1 = GenericStore([True, False]) # g1.store: list[bool]
g1.add(False) # only bool is allowed

为什么要学习Python函数注释?

函数注释有助于构建更强大的类型系统,从而减少错误的可能性(尤其是在使用mypy等静态类型检查器时)。此外,当使用强大的类型系统编写库(或SDK)时,可以显著提高使用该库的开发人员的工作效率(主要是因为编辑器的代码提示)。

如果您有任何疑问或发现本文中的错误,请随时在评论区留言。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

750

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

635

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

758

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1262

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

706

2023.08.11

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号