在Python实际编程过程中,组织代码结构的两个重要手段是:函数和类。有了函数,我们才能把一个个内聚的流程封装起来;有了类,我们才能把一个个现实对象抽象表达出来,即使你说不用自己写类,但是你用的很多语言库提供的类型,都是以类形式实现的,所以也必须理解它。
1. 函数定义
函数相对类是很简单的,函数定义是:
def 函数名(参数列表):
函数体(返回值)
参数可以是0个到多个,返回值是可有可无。
python
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# 练习函数
def main():
pass
if __name__ == '__main__':
main()
以main()函数作为整个程序入口比较容易理解,是一个惯例。
函数一定有关键字def和函数名,其它就是参数和返回值的变化而已,不外乎:
-
- 无参数无返回值的函数
-
- 无参数有返回值的函数
-
- 有参数无返回值的函数
-
- 有参数有返回值的函数
python
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# 练习函数
# 无参数无返回值的函数
def test1():
n = 1 + 2
print('1 + 2 =', n)
# 无参数有返回值的函数
def test2():
n = 1 + 2
return n
# 有参数无返回值的函数
def test3(i, j):
n = i + j
print('%d + %d = %d' % (i, j, n))
# 有参数有返回值的函数
def test4(i, j):
n = i + j
return n
def main():
test1()
n1 = test2()
print('n1 =', n1)
test3(2, 3)
n2 = test4(3, 4)
print('n2 =', n2)
if __name__ == '__main__':
main()
2. 参数缺省值
python
def test5(i, j = 1, k = 2):
z = i + j + k
print('%d + %d + %d = %d' % (i, j, k, z))
def main():
test5(4)
test5(4, j = 4)
test5(4, k = 5)
test5(4, j = 6, k = 7)
3. 可变参数
python
def test6(*arguments):
for arg in arguments:
print(arg)
def test7(**keywords):
for kw in keywords:
print(kw, ':', keywords[kw])
def test8(s, *arguments, **keywords):
print('*' * 50)
print('s=', s)
for arg in arguments:
print(arg)
print('-' * 50)
for kw in keywords:
print(kw, ':', keywords[kw])
def main():
test6('red', 'blue', 'yellow')
test7(red=1, blue=2, yellow=3, black=4)
test8('yellow')
test8('yellow', 'red', 'blue', 'yellow')
test8('yellow', red=1, blue=2, yellow=3, black=4)
test8('yellow', 'red', 'blue', yellow=3, black=4)
4. 关于函数的编程原则
函数本身语法定义很简单,而且在实际开发过程中我们大部分都是用最常见的函数定义,可变长参数基本没用,那是不是函数就很容易写了,其实不然。
基于多年编程经验和回忆,简单总结几条:
4.1 函数名一定要能表达函数实现的功能
函数是实现一个功能流程,命名应该是动词式或动宾式,不应该是名词式。
后来维护者一看到函数名就知道这个函数体是干嘛用的。
不要很懒地随便取一个名字。
不要用实现技术来取名,要动脑筋去提炼函数体代码到底是实现了什么。初学编程的新手,最容易犯这个错误,最喜欢用所用技术去命名。
4.2 不要在函数体内实现跟函数名描述的功能不相干的其它功能
常常函数名表达的是A功能,开发人员却在函数体内实现了A功能、B功能、C功能.....,这一点很多老程序员都一样出现这个问题,特别那些懒惰的,系统里到处是这种现象,反正他实现了功能,可读性和可维护性对他来说不存在。
4.3 不要在函数体内写太多if和for嵌套
太多if和for语句会让代码难以理解和维护,要学会写直线型代码,用return、continue和break去处理代码逻辑。
4.4 函数体不能写太多行代码
到底一个函数应该写多少行代码,目前没有定论,就我个人经验和喜好,喜欢一个函数最长在五六十行左右,一般电脑基本在两屏,我用VIM翻页比较容易。
4.5 函数头注释要认真写,函数体内代码块开头也应该写好功能说明注释
注释不是可有可无,一定要认真写。