zoukankan      html  css  js  c++  java
  • python函数注释

    python函数注释,参数后面加冒号:,函数后面的箭头→是什么?

    python的函数注释:

    def f(text:str,max_len:'int>0'=80) ->str:
    	"""这个是函数的帮助说明文档,help时会显示"""
        return True
    """
    函数声明中,text:str
    text 是参数 :冒号后面  str是参数的注释。
    如果参数有默认值,还要给注释,如下写。
    max_len:'int>0'=80
    
    ->str 是函数返回值的注释。
    
    这些注释信息都是函数的元信息,保存在f.__annotations__字典中、
    
    需要注意,python对注释信息和f.__annotations__的一致性,不做检查
    不做检查,不做强制,不做验证!什么都不做。
    """
    

      

    函数注释示例:

    def f(ham: 42, eggs: int = 'spam') -> "Nothing to see here":
        print("函数注释", f.__annotations__)
        print("参数值打印", ham, eggs)
        print(type(ham),type(eggs))
    
    f("www")

    返回信息:

    函数注释 {'ham': 42, 'eggs': <class 'int'>, 'return': 'Nothing to see here'}
    参数值打印 www spam
    <class 'str'> <class 'str'>
    

    解释说明:

    注释的一般规则是参数名后跟一个冒号(:),然后再跟一个expression,这个expression可以是任何形式。
    
    返回值的形式是 -> int,annotation可被保存为函数的attributes。
    

    以上属于静态注释,还有一种方法叫做动态注释

    动态注释的原理,就是在函数中或者装饰器中动态的增加 删除 更改 注释内容

    f.__annotations__ 是一个字典,可以使用字典的所有操作,这样就可以动态的更改注释了
    

    大多数情况,我使用的是一下方法,进行注释说明

    def foo():
      """ This is function foo"""
    

      


    Google风格
    """
    This is a groups style docs.
    
    Parameters:
      param1 - this is the first param
      param2 - this is a second param
    
    Returns:
    	This is a description of what is returned
    
    Raises:
    	KeyError - raises an exception
    """
    

      


    Rest风格
    """
    This is a reST style.
    
    :param param1: this is a first param
    :param param2: this is a second param
    :returns: this is a description of what is returned
    :raises keyError: raises an exception
    """
    

      

     
     原文链接:https://blog.csdn.net/sunt2018/article/details/83022493
     



    如果这篇文章帮助到了你,你可以请作者喝一杯咖啡

  • 相关阅读:
    【转载】Hadoop 文件副本存放的位置策略
    【原创】Hadoop 常用命令集锦
    【转载】centos6.2下安装星际译王stardict3.0
    【转载】hadoop之failed task任务和killed task任务
    【原创】linux 下远程连接windows桌面
    【原创】Hadoop配置详解
    【原创】Pig 0.10.0 piggybank 如何编译
    【转载】关于hadoop的dfs.replication
    【原创】centos 安装 thrift 0.8
    【原创】ASP.NET常见问题集锦
  • 原文地址:https://www.cnblogs.com/sddai/p/14406799.html
Copyright © 2011-2022 走看看