函数文档python 函数文档是什么

如何定义Python函数说明

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

成都创新互联公司坚持“要么做到，要么别承诺”的工作理念，服务领域包括：网站设计、成都网站建设、企业官网、英文网站、手机端网站、网站推广等服务，满足客户于互联网时代的泰顺网站设计、移动媒体设计的需求，帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴！

比如：

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

python中函数定义

1、函数定义

①使用def关键字定义函数

②

def 函数名(参数1.参数2.参数3...):

"""文档字符串，docstring，用来说明函数的作用"""

#函数体

return 表达式

注释的作用：说明函数是做什么的，函数有什么功能。

③遇到冒号要缩进，冒号后面所有的缩进的代码块构成了函数体，描述了函数是做什么的，即函数的功能是什么。Python函数的本质与数学中的函数的本质是一致的。

2、函数调用

①函数必须先定义，才能调用，否则会报错。

②无参数时函数的调用：函数名()，有参数时函数的调用：函数名(参数1.参数2.……)

③不要在定义函数的时候在函数体里面调用本身，否则会出不来，陷入循环调用。

④函数需要调用函数体才会被执行，单纯的只是定义函数是不会被执行的。

⑤Debug工具中Step into进入到调用的函数里，Step Into My Code进入到调用的模块里函数。

二级Python----Python的内置函数及标准库（DAY 8）

python的内置函数（68个）

Python考核31个内置函数，

python内置了很多内置函数、类方法属性及各种模块。当我们想要当我们想要了解某种类型有哪些属性方法以及每种方法该怎么使用时，我们可以使用dir()函数和help()函数在python idle交互式模式下获得我们想要的信息。

• dir()函数获得对象中可用属性的列表

Python中的关键词有哪些？

dir(__builtins__)：查看python内置函数

help(‘keywords‘)：查看python关键词

如微分积分方程的求解程序、访问互联网、获取日期和时间、机器学习算法等。这些程序往往被收入程序库中，构成程序库。

只有经过严格检验的程序才能放在程序库里。检验，就是对程序作充分的测试。通常进行的有正确性测试、精度测试、速度测试、边界条件和出错状态的测试。经过检验的程序不但能保证计算结果的正确性，而且对错误调用也能作出反应。程序库中的程序都是规范化的。所谓规范化有三重含义：①同一库里所有程序的格式是统一的；② 对这些程序的调用方法是相同的；③ 每个程序所需参数的数目、顺序和类型都是严格规定好的。

Python的库包含标准库和第三方库

标准库：程序语言自身拥有的库，可以直接使用。help('modules')

第三方库：第三方者使用该语言提供的程序库。

标准库： turtle 库（必选）、 random 库（必选）、 time 库（可选）。

• turtle 库：图形绘制库

原理如同控制一只海龟，以不同的方向和速度进行位移而得到其运动轨迹。

使用模块的帮助时，需要先将模块导入。

例如：在IDLE中输入import turtle

dir(turtle)

help(turtle.**)

1.画布

画布就是turtle为我们展开用于绘图区域, 我们可以设置它的大小和初始位置。

setup()方法用于初始化画布窗口大小和位置，参数包括画布窗口宽、画布窗口高、窗口在屏幕的水平起始位置和窗口在屏幕的垂直起始位置。

参数:width, height: 输入宽和高为整数时,表示 像素 ;为小数时,表示占据电脑屏幕的比例。(startx,starty):这一坐标表示

矩形窗口左上角顶点的位置,如果为空,则窗口位于屏幕中心:

例如：setup(640,480,300,300)表示在桌面屏幕(300,300)位置开始创建640×480大小的画布窗体。

2、画笔

• color() 用于设置或返回画笔颜色和填充颜色。

例如：color(‘red’)将颜色设为红色，也可用fillcolor()方法设置或返回填充颜色，或用pencolor()方法设置或返回笔触颜色。

Python中定义函数的使用方法？

4.6. 定义函数

我们可以创建一个用来生成指定边界的斐波那契数列的函数:

def fib(n): # write Fibonacci series up to n

... """Print a Fibonacci series up to n."""

... a, b = 0, 1

... while a n:

... print(a, end=' ')

... a, b = b, a+b

... print()

...

# Now call the function we just defined:

... fib(2000)

0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

关键字 def 引入了一个函数 定义。在其后必须跟有函数名和包括形式参数的圆括号。函数体语句从下一行开始，必须是缩进的。

函数体的第一行语句可以是可选的字符串文本，这个字符串是函数的文档字符串，或者称为 docstring。（更多关于 docstrings 的信息请参考 文档字符串） 有些工具通过 docstrings 自动生成在线的或可打印的文档，或者让用户通过代码交互浏览；在你的代码中包含 docstrings 是一个好的实践，让它成为习惯吧。

函数 调用 会为函数局部变量生成一个新的符号表。确切的说，所有函数中的变量赋值都是将值存储在局部符号表。变量引用首先在局部符号表中查找，然后是包含函数的局部符号表，然后是全局符号表，最后是内置名字表。因此，全局变量不能在函数中直接赋值（除非用 global 语句命名），尽管他们可以被引用。

函数引用的实际参数在函数调用时引入局部符号表，因此，实参总是 传值调用 （这里的 值 总是一个对象 引用 ，而不是该对象的值）。[1] 一个函数被另一个函数调用时，一个新的局部符号表在调用过程中被创建。

一个函数定义会在当前符号表内引入函数名。函数名指代的值（即函数体）有一个被 Python 解释器认定为 用户自定义函数 的类型。 这个值可以赋予其他的名字（即变量名），然后它也可以被当作函数使用。这可以作为通用的重命名机制:

fib

f = fib

f(100)

0 1 1 2 3 5 8 13 21 34 55 89

如果你使用过其他语言，你可能会反对说：fib 不是一个函数，而是一个方法，因为它并不返回任何值。事实上，没有 return 语句的函数确实会返回一个值，虽然是一个相当令人厌烦的值（指 None ）。这个值被称为 None （这是一个内建名称）。如果 None 值是唯一被书写的值，那么在写的时候通常会被解释器忽略（即不输出任何内容）。如果你确实想看到这个值的输出内容，请使用 print() 函数:

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

python所有内置函数的定义详解

1、定义函数

函数是可重用的程序。本书中已经使用了许多内建函数，如len()函数和range()函数，但是还没自定义过函数。定义函数的语法格式如下：

def 函数名(参数):

函数体

定义函数的规则如下：

①关键字def用来定义一个函数，它是define的缩写。

②函数名是函数的唯一标识，函数名的命名规则遵循标识符的命名规则。

③函数名后面一定要紧跟着一个括号，括号内的参数是可选的，括号后面要有冒号。

④函数体(statement)为一个或一组Python语句，注意要有缩进。

⑤函数体的第一行可以有文档字符串，用于描述函数的功能，用三引号括起来。

按照定义规则，可以定义第一个函数了：

def hello_world():

...     print('Hello,world!')   # 注意函数体要有缩进

...

hello_world()

Hello,world!

这个函数不带任何参数，它的功能是打印出“Hello,world!”。最后一行代码hello_world()是调用函数，即让Python执行函数的代码。

2、全局变量和局部变量

全局变量是定义在所有函数外的变量。例如，定义一个全局变量a，分别在函数test1()和test2()使用变量a：

a = 100   # 全局变量

def test1():

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

test2()

100

定义了全局变量a之后，在函数test1()和test2()内都可以使用变量a，由此可知，全局变量的作用范围是全局。

局部变量是在函数内定义的变量，除了用关键字global修饰的变量以外。例如，在函数test1()内定义一个局部变量a，分别在函数外和另一个函数test2()内使用变量a：

def test1():

...     a = 100   # 局部变量

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

print(a)

Traceback (most recent call last):

File "stdin", line 1, in module

NameError: name 'a' is not defined

test2()

Traceback (most recent call last):

File "stdin", line 1, in module

File "stdin", line 2, in test2

NameError: name 'a' is not defined

Python解释器提示出错了。由于局部变量a定义在函数test1()内，因此，在函数test1()内可以使用变量a，但是在函数外或者另一个函数test2()内使用变量a，都会报错，由此可见，局部变量的作用范围是定义它的函数内部。

一般情况下，在函数内声明的变量都是局部变量，但是采用关键字global修饰的变量却是全局变量：

def test1():

...     global a   # 全局变量

...     a = 100

...     print(a)

...

def test2():

...     print(a)

...

test1()

100

print(a)

100

test2()

100

这个程序与上个程序相比，只是在函数test1()中多了一行代码“global a”，程序便可以正确运行了。在函数test1()中，采用关键字global修饰了变量a之后，变量a就变成了全局变量，不仅可以在该函数内使用，还可以在函数外或者其他函数内使用。

如果在某个函数内局部变量与全局变量同名，那么在该函数中局部变量会覆盖全局变量：

a = 100   # 全局变量

def test1():

...     a = 200   # 同名局部变量

...     print(a)

...

def test2():

...     print(a)

...

test1()

200

test2()

100

由于在函数test1()中定义了一个与全局变量同名的局部变量a，因此，在函数test1()中全局变量a的值被局部变量覆盖了，但是在函数test2()中全局变量a的值没有被覆盖。

综上所述，在Python中，全局变量保存的数据供整个脚本文件使用;而局部变量只用于临时保存数据，变量仅供局部代码块使用。