python函数说明文档 Python函数说明

Python函数的参数类型

Python函数的参数类型主要包括必选参数、可选参数、可变参数、位置参数和关键字参数，本文介绍一下他们的定义以及可变数据类型参数传递需要注意的地方。

必选参数（Required arguments）是必须输入的参数，比如下面的代码，必须输入2个参数，否则就会报错：

其实上面例子中的参数 num1和num2也属于关键字参数，比如可以通过如下方式调用：

执行结果：

可选参数（Optional arguments）可以不用传入函数，有一个默认值，如果没有传入会使用默认值，不会报错。

位置参数（positional arguments）根据其在函数定义中的位置调用，下面是pow()函数的帮助信息:

x，y，z三个参数的的顺序是固定的，并且不能使用关键字：

输出：

在上面的pow()函数帮助信息中可以看到位置参数后面加了一个反斜杠 / ，这是python内置函数的语法定义，Python开发人员不能在python3.8版本之前的代码中使用此语法。但python3.0到3.7版本可以使用如下方式定义位置参数：

星号前面的参数为位置参数或者关键字参数，星号后面是强制关键字参数，具体介绍见强制关键字参数。

python3.8版本引入了强制位置参数（Positional-Only Parameters），也就是我们可以使用反斜杠 / 语法来定义位置参数了，可以写成如下形式：

来看下面的例子：

python3.8运行：

不能使用关键字参数形式赋值了。

可变参数 (varargs argument) 就是传入的参数个数是可变的，可以是0-n个，使用星号（ * ）将输入参数自动组装为一个元组（tuple）：

执行结果：

关键字参数（keyword argument）允许将任意个含参数名的参数导入到python函数中，使用双星号（ ** ），在函数内部自动组装为一个字典。

执行结果：

上面介绍的参数可以混合使用：

结果：

注意：由于传入的参数个数不定，所以当与普通参数一同使用时，必须把带星号的参数放在最后。

强制关键字参数（Keyword-Only Arguments）是python3引入的特性，可参考：。 使用一个星号隔开：

在位置参数一节介绍过星号前面的参数可以是位置参数和关键字参数。星号后面的参数都是强制关键字参数，必须以指定参数名的方式传参，如果强制关键字参数没有设置默认参数，调用函数时必须传参。

执行结果：

也可以在可变参数后面命名关键字参数，这样就不需要星号分隔符了：

执行结果：

在Python对象及内存管理机制中介绍了python中的参数传递属于对象的 引用传递 （pass by object reference），在编写函数的时候需要特别注意。

先来看个例子：

执行结果：

l1 和 l2指向相同的地址，由于列表可变，l1改变时，l2也跟着变了。

接着看下面的例子：

结果：

l1没有变化！为什么不是[1, 2, 3, 4]呢？

l = l + [4]表示创建一个“末尾加入元素 4“的新列表，并让 l 指向这个新的对象，l1没有进行任何操作，因此 l1 的值不变。如果要改变l1的值，需要加一个返回值：

结果：

下面的代码执行结果又是什么呢？

执行结果：

和第一个例子一样，l1 和 l2指向相同的地址，所以会一起改变。这个问题怎么解决呢？

可以使用下面的方式：

也可以使用浅拷贝或者深度拷贝，具体使用方法可参考Python对象及内存管理机制。这个问题在Python编程时需要特别注意。

本文主要介绍了python函数的几种参数类型：必选参数、可选参数、可变参数、位置参数、强制位置参数、关键字参数、强制关键字参数，注意他们不是完全独立的，比如必选参数、可选参数也可以是关键字参数，位置参数可以是必选参数或者可选参数。

另外，python中的参数传递属于对象的 引用传递 ，在对可变数据类型进行参数传递时需要特别注意，如有必要，使用python的拷贝方法。

参考文档：

--THE END--

相关问答

Q1: Python魔法函数（特殊函数）

Python中如何实现运算符的重载，即实现例如a+b这样的运算符操作呢？

在C++中可以使用 operator 关键字实现运算符的重载。但是在Python中没有类似这样的关键字，所以要实现运算符的重载，就要用到Python的魔法函数。Python魔法函数是以双下划线开头，双下划线结尾的一组函数。我们在类定义中最常用到的 __init__ 函数就是这样一个魔法函数，它在创建类对象时被自动调用。

下面我们来看个简单的例子。

上述代码示例了几个魔法函数的用法。 __add__ 函数对应了二元运算符+，当执行a+b语句时，python就会自动调用a. add (b)。 对于上述例子中的v1+v2+v3，则相当于调用了(v1. add(v2)). add(v3)。

代码中还有一个在Python类定义经常使用的 __str__ 函数，当使用 str() 时会被调用。print函数对传入的参数都调用了str()将其转换成易读的字符串形式，便于打印输出，因而会调用类定义的__str__函数打出自定义的字符串。

代码中还有一个特殊的 __call__ 函数，该函数在将对象采用函数调用方式使用时被调用, 例如v1()相当于v1. call ()。

以上就是魔法函数的基本使用方法。常见的魔法函数我们可以使用 dir() 函数来查看。

输出结果为：

上述结果中形式为‘__函数名__’的函数为魔法函数，注意有些对象也是这种形式，例如__class__, __module__等, 这些不是魔法函数。具体的魔法函数说明可以参考Python官方说明文档。

以上代码在Python3.6运行通过.

Q2: 【Python】split()函数

Python中有split()和os.path.split()两个函数，具体作用如下：

split()：拆分字符串，通过指定分隔符对字符串进行切片，并返回分割后的字符串列表（list）

os.path.split()：按照路径将文件名和路径分割开

一、函数说明

1、split()函数

语法：str.split(str="",num=string.count(str))[n]

参数说明：

str:表示为分隔符，默认为空格，但是不能为空('')。若字符串中没有分隔符，则把整个字符串作为列表的一个元素

num:表示分割次数。如果存在参数num，则仅分隔成 num+1 个子字符串，并且每一个子字符串可以赋给新的变量

[n]:表示选取第n个分片

注意：当使用空格作为分隔符时，对于中间为空的项会自动忽略

2、os.path.split()函数

语法：os.path.split('PATH')

参数说明：

1.PATH指一个文件的全路径作为参数：

2.如果给出的是一个目录和文件名，则输出路径和文件名

3.如果给出的是一个目录名，则输出路径和为空文件名

二、分离字符串

string = ""

1.以'.'为分隔符

print(string.split('.'))

['www', 'gziscas', 'com', 'cn']

2.分割两次

print(string.split('.'，2))

['www', 'gziscas', 'com.cn']

3.分割两次，并取序列为1的项

print(string.split('.',2)[1])

gziscas

4.分割两次，并把分割后的三个部分保存到三个文件

u1, u2, u3 =string.split('.',2)

print(u1)—— www

print(u2)—— gziscas

print(u3) ——com.cn

三、分离文件名和路径

import os

print(os.path.split('/dodo/soft/python/'))

('/dodo/soft/python', '')

print(os.path.split('/dodo/soft/python'))

('/dodo/soft', 'python')

四、实例

str="hello boy[]byebye"

print(str.split("[")[1].split("]")[0])

Q3: python怎么编写函数

在python中，定义一个函数要使用def语句，依次写出函数名、括号、括号中的参数和冒号：，然后在缩进块中编写函数体，函数的返回值用return语句返回

def 函数名([参数1,参数2,...,参数n]):

函数体

函数代码以def关键词开头，后接函数标识符名称和圆括号():

任何传入参数和自变量必须放在圆括号中间，圆括号之间可以用于定义参数

函数的第一行语句可以选择性的使用文档字符串-用于存放函数说明

函数内容以冒号起始，并且缩进

return[表达式]结束函数，选择性的返回一个值给调用方，不带表达式的return相当于返回None

Q4: 如何定义Python函数说明

函数说明就是函数文档，用字符串表示的。

比如：

图中圈出来的地方就是函数说明，也就是函数文档，可以直接用格式： 函数名.__doc__  访问的

Q5: Python的函数都有哪些？

Python 函数

函数是组织好的，可重复使用的，用来实现单一，或相关联功能的代码段。

函数能提高应用的模块性，和代码的重复利用率。你已经知道Python提供了许多内建函数，比如print()。但你也可以自己创建函数，这被叫做用户自定义函数。

定义一个函数

你可以定义一个由自己想要功能的函数，以下是简单的规则：

函数代码块以 def 关键词开头，后接函数标识符名称和圆括号()。

任何传入参数和自变量必须放在圆括号中间。圆括号之间可以用于定义参数。

函数的第一行语句可以选择性地使用文档字符串—用于存放函数说明。

函数内容以冒号起始，并且缩进。

return [表达式] 结束函数，选择性地返回一个值给调用方。不带表达式的return相当于返回 None。

语法

def functionname( parameters ):   "函数_文档字符串"

  function_suite

  return [expression]

默认情况下，参数值和参数名称是按函数声明中定义的顺序匹配起来的。

实例

以下为一个简单的Python函数，它将一个字符串作为传入参数，再打印到标准显示设备上。

实例(Python 2.0+)

def printme( str ):   "打印传入的字符串到标准显示设备上"

  print str

  return

函数调用

定义一个函数只给了函数一个名称，指定了函数里包含的参数，和代码块结构。

这个函数的基本结构完成以后，你可以通过另一个函数调用执行，也可以直接从Python提示符执行。

如下实例调用了printme（）函数：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

# 定义函数def printme( str ):   "打印任何传入的字符串"

  print str

  return

# 调用函数printme("我要调用用户自定义函数!")printme("再次调用同一函数")

以上实例输出结果：

我要调用用户自定义函数!再次调用同一函数

参数传递

在 python 中，类型属于对象，变量是没有类型的：

a=[1,2,3]

a="Runoob"

以上代码中，[1,2,3] 是 List 类型，"Runoob" 是 String 类型，而变量 a 是没有类型，她仅仅是一个对象的引用（一个指针），可以是 List 类型对象，也可以指向 String 类型对象。

可更改(mutable)与不可更改(immutable)对象

在 python 中，strings, tuples, 和 numbers 是不可更改的对象，而 list,dict 等则是可以修改的对象。

不可变类型：变量赋值 a=5 后再赋值 a=10，这里实际是新生成一个 int 值对象 10，再让 a 指向它，而 5 被丢弃，不是改变a的值，相当于新生成了a。

可变类型：变量赋值 la=[1,2,3,4] 后再赋值 la[2]=5 则是将 list la 的第三个元素值更改，本身la没有动，只是其内部的一部分值被修改了。

python 函数的参数传递：

不可变类型：类似 c++ 的值传递，如 整数、字符串、元组。如fun（a），传递的只是a的值，没有影响a对象本身。比如在 fun（a）内部修改 a 的值，只是修改另一个复制的对象，不会影响 a 本身。

可变类型：类似 c++ 的引用传递，如 列表，字典。如 fun（la），则是将 la 真正的传过去，修改后fun外部的la也会受影响

python 中一切都是对象，严格意义我们不能说值传递还是引用传递，我们应该说传不可变对象和传可变对象。

python 传不可变对象实例

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

def ChangeInt( a ):    a = 10

b = 2ChangeInt(b)print b # 结果是 2

实例中有 int 对象 2，指向它的变量是 b，在传递给 ChangeInt 函数时，按传值的方式复制了变量 b，a 和 b 都指向了同一个 Int 对象，在 a=10 时，则新生成一个 int 值对象 10，并让 a 指向它。

传可变对象实例

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

# 可写函数说明def changeme( mylist ):   "修改传入的列表"

  mylist.append([1,2,3,4])

  print "函数内取值: ", mylist

  return

# 调用changeme函数mylist = [10,20,30]changeme( mylist )print "函数外取值: ", mylist

实例中传入函数的和在末尾添加新内容的对象用的是同一个引用，故输出结果如下：

函数内取值:  [10, 20, 30, [1, 2, 3, 4]]函数外取值:  [10, 20, 30, [1, 2, 3, 4]]

参数

以下是调用函数时可使用的正式参数类型：

必备参数

关键字参数

默认参数

不定长参数

必备参数

必备参数须以正确的顺序传入函数。调用时的数量必须和声明时的一样。

调用printme()函数，你必须传入一个参数，不然会出现语法错误：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

#可写函数说明def printme( str ):   "打印任何传入的字符串"

  print str

  return

#调用printme函数printme()

以上实例输出结果：

Traceback (most recent call last):

 File "test.py", line 11, in module

   printme()TypeError: printme() takes exactly 1 argument (0 given)

关键字参数

关键字参数和函数调用关系紧密，函数调用使用关键字参数来确定传入的参数值。

使用关键字参数允许函数调用时参数的顺序与声明时不一致，因为 Python 解释器能够用参数名匹配参数值。

以下实例在函数 printme() 调用时使用参数名：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

#可写函数说明def printme( str ):   "打印任何传入的字符串"

  print str

  return

#调用printme函数printme( str = "My string")

以上实例输出结果：

My string

下例能将关键字参数顺序不重要展示得更清楚：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

#可写函数说明def printinfo( name, age ):   "打印任何传入的字符串"

  print "Name: ", name

  print "Age ", age

  return

#调用printinfo函数printinfo( age=50, name="miki" )

以上实例输出结果：

Name:  mikiAge  50

默认参数

调用函数时，默认参数的值如果没有传入，则被认为是默认值。下例会打印默认的age，如果age没有被传入：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

#可写函数说明def printinfo( name, age = 35 ):   "打印任何传入的字符串"

  print "Name: ", name

  print "Age ", age

  return

#调用printinfo函数printinfo( age=50, name="miki" )printinfo( name="miki" )

以上实例输出结果：

Name:  mikiAge  50Name:  mikiAge  35

不定长参数

你可能需要一个函数能处理比当初声明时更多的参数。这些参数叫做不定长参数，和上述2种参数不同，声明时不会命名。基本语法如下：

def functionname([formal_args,] *var_args_tuple ):   "函数_文档字符串"

  function_suite

  return [expression]

加了星号（*）的变量名会存放所有未命名的变量参数。不定长参数实例如下：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

# 可写函数说明def printinfo( arg1, *vartuple ):   "打印任何传入的参数"

  print "输出: "

  print arg1

  for var in vartuple:      print var

  return

# 调用printinfo 函数printinfo( 10 )printinfo( 70, 60, 50 )

以上实例输出结果：

输出:10输出:706050

匿名函数

python 使用 lambda 来创建匿名函数。

lambda只是一个表达式，函数体比def简单很多。

lambda的主体是一个表达式，而不是一个代码块。仅仅能在lambda表达式中封装有限的逻辑进去。

lambda函数拥有自己的命名空间，且不能访问自有参数列表之外或全局命名空间里的参数。

虽然lambda函数看起来只能写一行，却不等同于C或C++的内联函数，后者的目的是调用小函数时不占用栈内存从而增加运行效率。

语法

lambda函数的语法只包含一个语句，如下：

lambda [arg1 [,arg2,.....argn]]:expression

如下实例：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

# 可写函数说明sum = lambda arg1, arg2: arg1 + arg2

# 调用sum函数print "相加后的值为 : ", sum( 10, 20 )print "相加后的值为 : ", sum( 20, 20 )

以上实例输出结果：

相加后的值为 :  30相加后的值为 :  40

return 语句

return语句[表达式]退出函数，选择性地向调用方返回一个表达式。不带参数值的return语句返回None。之前的例子都没有示范如何返回数值，下例便告诉你怎么做：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

# 可写函数说明def sum( arg1, arg2 ):   # 返回2个参数的和."

  total = arg1 + arg2

  print "函数内 : ", total

  return total

# 调用sum函数total = sum( 10, 20 )

以上实例输出结果：

函数内 :  30

变量作用域

一个程序的所有的变量并不是在哪个位置都可以访问的。访问权限决定于这个变量是在哪里赋值的。

变量的作用域决定了在哪一部分程序你可以访问哪个特定的变量名称。两种最基本的变量作用域如下：

全局变量

局部变量

全局变量和局部变量

定义在函数内部的变量拥有一个局部作用域，定义在函数外的拥有全局作用域。

局部变量只能在其被声明的函数内部访问，而全局变量可以在整个程序范围内访问。调用函数时，所有在函数内声明的变量名称都将被加入到作用域中。如下实例：

实例(Python 2.0+)

#!/usr/bin/python# -*- coding: UTF-8 -*-

total = 0 # 这是一个全局变量# 可写函数说明def sum( arg1, arg2 ):   #返回2个参数的和."

  total = arg1 + arg2 # total在这里是局部变量.

  print "函数内是局部变量 : ", total

  return total

#调用sum函数sum( 10, 20 )print "函数外是全局变量 : ", total

以上实例输出结果：

函数内是局部变量 :  30函数外是全局变量 :  0