5.函数参数和文档

注意:相关笔记或代码段之间空一行,没有联系知识点之间的代码段之间空两行,以示区别!!!

笔记 note5.md

技术交流QQ群:1027579432,欢迎你的加入!

四类参数

  • 普通参数
  • 默认参数
  • 关键字参数
  • 收集参数

关键字参数开始

  • 语法

      def func(p1=v1, p2=v2.....):
          func_body
    
      调用函数:
      func(p1=value1, p2=value2.......)
    
  • 比较麻烦,但也有好处:

    • 不容易混淆, 一般实参和形参只是按照位置一一对应即可,容易出错
    • 使用关键字参数,可以不考虑参数位置

收集参数

  • 把没有位置,不能和定义时的参数位置相对应的参数,放入一个特定的数据结构中

  • 语法

      def func(*args):
          func_body
          按照list使用方式访问args得到传入的参数
    
      调用:
      func(p1, p2, p3, .....)
    
  • 参数名args不是必须这么写,但是,我们推荐直接用args,约定俗成

  • 参数名args前需要由星号

  • 收集参数可以和其他参数共存

收集参数之关键字收集参数

  • 把关键字参数按字典格式存入收集参数

  • 语法:

      def func( **kwargs):
          func_body
      # 调用:
      func(p1=v1, p2=v2, p3=v3........)
    
  • kwargs一般约定俗成

  • 调用的时候,把多余的关键字参数放入kwargs

  • 访问kwargs需要按字典格式访问

收集参数混合调用的顺序问题

  • 收集参数,关键字参数,普通参数可以混合使用
  • 使用规则就是,普通参数和关键字参数优先
  • 定义的时候一般找普通参数,关键字参数,收集参数tuple,收集参数dict

收集参数的解包问题

  • 把参数放入list或者字典中,直接把list/dict中的值放入收集参数中
  • 语法:参看案例

同理,dict类型收集参数一样可以解包,但是

  • 对dict类型进行解包
  • 需要用两个星号进行解包

返回值

  • 函数和过程的区别
    • 有无返回值
  • 需要用return显示返回内容,
  • 如果没有返回,则默认返回None
  • 推荐写法,无论有无返回值,最后都要以return 结束

函数文档

  • 函数的文档的作用是对当前函数提供使用相关的参考信息
  • 文档的写法:
    • 在函数内部开始的第一行使用三引号字符串定义符
    • 一般具有特定格式
    • 参看案例
  • 文档查看
    • 使用help函数,形如 help(func)
    • 使用doc, 参看案例

代码 5.函数参数和文档.py

!/usr/bin/env python

-- coding: utf-8 --

@Date : 2018-10-09 09:00:29

@Author : cdl (1217096231@qq.com)

@Link : https://github.com/cdlwhm1217096231/python3_spider

@Version : Id

def stu(name, age, addr):
print("I am a student")
print("我叫 {0}, 我今年 {1}岁了, 我住{2}".format(name, age, addr))

n = "jingjing"
a = 18
addr = "我家"

普通参数,只按照位置传递,容易出错

stu(a, n, addr)

关键字参数案例

def stu_key(name="No name", age=0, addr="No addr"):
print("I am a student")
print("我叫 {0}, 我今年 {1}岁了, 我住{2}".format(name, age, addr))

n = "jingjing"
a = 18
addr = "我家"

普通参数,只按照位置传递,容易出错

stu_key(age=a, name=n, addr=addr)

收集参数代码

函数模拟一个学生进行自我介绍,但具体内容不清楚

args把他看做一个list

def stu(*args):
print("Hello 大家好,我自我介绍以下,简答说两句:")
# type函数作用是检测变量的类型
print(type(args))
for item in args:
print(item)

stu("liuying", 18, "北京大通州区", "wangxiaojing", "single")
print("*" * 50)
stu("周大神")

收集参数案例

说明收集参数可以不带任何实参调用,此时收集参数为空tuple

print("" * 50)
stu()
print("
" * 50)

如果使用关键字参数格式调用,会出现问题

stu(name="liuying")

收集参数案例

自我介绍

调用的时候需要使用关键字参数调用

def stu(**kwargs):
# 在函数体内对于kwargs的使用不用带星号
print("Hello 大家好,我先自我介绍一下:")
print(type(kwargs))
# 对于字典的访问,python2 和python3有区别
for k, v in kwargs.items():
print(k, "---", v)

stu(name="liuying", age=19, addr="北京大通州区", lover="王晓静", work="Teacher")
print("*" * 50)
stu(name="周大神")

收集参数可以为空案例

print("" * 50)
stu()
print("
" * 50)

收集参数混合调用案例

stu模拟一个学生的自我介绍

def stu(name, age, *args, hobby="没有", **kwargs):
print("Hello 大家好")
print("我叫 {0}, 我今年{1}岁了。".format(name, age))
if hobby == "没有":
print("我没有爱好, so sorry")
else:
print("我的爱好是{0}".format(hobby))

print("*" * 20)

for i in args:
    print(i)

print("#" * 30)

for k, v in kwargs.items():
    print(k, "---", v)

开始调用函数

name = "liuying"
age = 19

调用的不同格式

stu(name, age)

stu(name, age, hobby="游泳")

stu(name, age, "王晓静", "刘石头", hobby="游泳", hobby2="烹饪", hobby3="跟不同女生聊天")

收集参数的解包问题

def stu(*args):
print("哈哈哈哈哈")
# n 用来表示循环次数
# 主要用来调试
n = 0
for i in args:
print(type(i))
print(n)
n += 1
print(i)

stu("liuying", "liuxiaoyhing", 19, 200)

l = ["liuying", 19, 23, "wangxiaojing"]

stu(l)

此时,args的表示形式是字典内一个list类型的元素,即 args = (["liuying", 19, 23, "wangxiaojing"],)

很显然跟上述语法与我们最初的想法违背

此时的调用,我们就需要解包符号,即调用的时候前面加一个星号

stu(*l)

返回值示例

def func_1():
print("有返回值呀")
return 1

def func_2():
print("没有返回值")

f1 = func_1()
print(f1)

f2 = func_2()
print(f2)

文档案例

函数stu是模拟一个学生的自我介绍的内容

def stu(name, age, *args):
'''
这是第一行
这是第二行
这是第三行
'''
print("This is hanshu stu")

查看函数文档

help(stu)
stu.doc 此处显示有问题,具体参考笔记note5.md
print("*" * 20)

def stu1(name, age):
'''
这是文档的文字内容
:param name: 表示学生的姓名
:param age: 表示学生的年龄
:return: 此函数没有返回值
'''
pass

print(help(stu1))
print("*" * 20)
print(stu1.doc)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,367评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,959评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,750评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,226评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,252评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,975评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,592评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,497评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,027评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,147评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,274评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,953评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,623评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,143评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,260评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,607评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,271评论 2 358