美文网首页
Python中给函数添加元信息

Python中给函数添加元信息

作者: 致Great | 来源:发表于2019-01-08 16:01 被阅读31次

问题背景

我们写好一个自定义函数之后,要告诉其他人其他人怎么用这个函数,可以利用->为函数添加一些元信息,比如这个函数具体参数以及参数类型

解决方案

使用函数参数注解是一个很好的办法,它能提示程序员应该怎样正确使用这个函数。 例如,下面有一个被注解了的函数:

def add(x:int, y:int) -> int:
    return x + y
add(1,2)
3

需要注意:

python解释器不会对这些注解添加任何的语义,也就是说它们不会进行类型检查,运行时跟没有加注解之前的效果也没有任何差距。 然而,对于那些阅读源码的人来讲就很有帮助啦。第三方工具和框架可能会对这些注解添加语义。同时它们也会出现在文档中。

比如,我们将x=1,y=2.0输出给函数,结果和1+2.0=3.0一样

add(1,2.0)
3.0
help(add)
Help on function add in module __main__:

add(x:int, y:int) -> int

思考

函数注解只存储在函数的__annotations__ 属性中。例如:

add.__annotations__
{'x': int, 'y': int, 'return': int}

尽管注解的使用方法可能有很多种,但是它们的主要用途还是文档。 因为python并没有类型声明,通常来讲仅仅通过阅读源码很难知道应该传递什么样的参数给这个函数。 这时候使用注解就能给程序员更多的提示,让他们可以正确的使用函数。

基于函数注解实现方法重载

重载(overloading) 是在一个类里面,方法名字相同,而参数不同。返回类型可以相同也可以不同。

每个重载的方法(或者构造函数)都必须有一个独一无二的参数类型列表。

最常用的地方就是构造器的重载。

重载规则:

  • 被重载的方法必须改变参数列表(参数个数或类型不一样);
  • 被重载的方法可以改变返回类型;
  • 被重载的方法可以改变访问修饰符;
  • 被重载的方法可以声明新的或更广的检查异常;
  • 方法能够在同一个类中或者在一个子类中被重载。
  • 无法以返回值类型作为重载函数的区分标准。
class Spam:
    def bar(self, x:int, y:int):
        print('Bar 1:', x, y)

    def bar(self, s:str, n:int = 0):
        print('Bar 2:', s, n)

s = Spam()
s.bar(2, 3) # Prints Bar 1: 2 3
s.bar('hello') # Prints Bar 2: hello 0
Bar 2: 2 3
Bar 2: hello 0
# reference https://python3-cookbook.readthedocs.io/zh_CN/latest/c09/p20_implement_multiple_dispatch_with_function_annotations.html

相关文章

  • Python中给函数添加元信息

    问题背景 我们写好一个自定义函数之后,要告诉其他人其他人怎么用这个函数,可以利用->为函数添加一些元信息,比如这个...

  • python:给函数增加元信息

    参数注解 一般来说python语言没有类型声明,有些时候我们很难读懂参数到底是什么类型,这个时候我们就需要一个类似...

  • Python3 - 给函数参数增加元信息

    问题 为定义的函数参数,增加一些额外的信息,使其他使用者能清楚的知道这个函数应该怎么使用。 解决方案 使用函数参数...

  • 20201112-函数定义中的->

    描述 ->常常出现在python函数定义的函数名后面,为函数添加元数据,描述函数的返回类型,从而方便开发人员使用,...

  • Jquery动态添加元素并给元素增加onchange相应

    动态添加元素: 给元素添加onchange回调函数: 机智如我~

  • 17 | python中的装饰器

    python中的装饰器 函数核心回顾 1.函数是Python中的一等公民,函数也是对象。可以把函数赋值给变量。 2...

  • ArrayList(jdk 1.8)

    ArrayList底层用数组来实现,重点方法是每次添加元素的时候,是否需要扩容 1、成员变量 2、构造函数 3、添...

  • python中的__str__ __name__ 和__call

    通过str( )函数可以打印对象的属性信息,方便我们调试代码。 python中的name python中的call...

  • 理解Python中的闭包

    Python基础 在Python中,函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。...

  • Python函数式介绍一 - 高阶函数

    Python函数式介绍一 - 高阶函数Python函数式介绍二 - 链式调用 最近为了给朋友推广Python函数式...

网友评论

      本文标题:Python中给函数添加元信息

      本文链接:https://www.haomeiwen.com/subject/jthbrqtx.html