【Python】怎么写好一个 Python 函数? | 您所在的位置:网站首页 › python计数函数countif怎么用 › 【Python】怎么写好一个 Python 函数? |
文章目录1. 命名2. 功能单一3. 文档字符串4. 返回值5. 函数长度 1. 命名 符合 PEP-8 函数命名书写规范的是小写+下划线或者比较常用的驼峰命名法。内容方面是动宾结合。 举个例子: def setUserName(String userName): pass推荐一个函数命名网站:codeIf 函数中带有参数类型以及返回值的函数定义写法: >>> def setUserName(UserName:str)->None: print(UserName)>>> setUserName('xiaoming')xiaoming值得说明的是,这里并没有强制类型检查,这种写法也并不建议,不过上面的写法也有一个好处: 如果想显示函数参数类型的话,可以用函数说明文档来解决。 >>> def setUserName(UserName): """ @UserName: str """ print(UserName)>>> print(setUserName.__doc__) @UserName: str 2. 功能单一一个函数只做一件事情。举个例子:get_user_list(age)这个函数定义就违反了我们的一个函数只做一件事情的要求,我们需要将op1、op2、op3三个操作分别写到三个函数中去。但是,也不至于将函数功能分得过细。 def get_user_list(age): # op1: 从数据库中拿到原始用户列表信息 # op2: 根据 age 提取合适的目标用户信息 # op3: 将用户分类 pass 3. 文档字符串关于文档字符串(Documentation Strings),每个函数都应该有一个说明文档,可以参照下方样例。需要有函数的功能描述、参数说明、返回值说明。 def if_ID_exit(user='', id=''): """ 判断账户是否存在 :param user: teacher、student :return: bool, False - 账户存在 True - 账户不存在 """ passprint(if_ID_exit.__doc__)查看函数说明文档的方式。 判断账户是否存在 :param user: teacher、student :return: bool, False - 账户存在 True - 账户不存在 4. 返回值你可能听说python的函数能够返回多个值,像下面这个例子一样: def returnSth(): return 1,2,3,4但实际上,它会将1,2,3,4作为一个整体返回,也就是说它会将这些数字全都放到元组里面。 print(returnSth()) # (1,2,3,4)每个函数都会有返回值,即使你没有明确写出,那么它的返回值也会被默认为None。尽量保证每个函数的返回值都是有意义的。哪怕它没有什么操作,你也可以返回boolen类型来判断执行是否顺利。 5. 函数长度不要太长,行数不要超过三位数。保证入口参数相同的情况下,函数所造成的影响是确定的并且是相同的——纯函数。
|
CopyRight 2018-2019 实验室设备网 版权所有 |