python函数内文档,python函数帮助文档

万字干货，Python语法大合集，一篇文章带你入门

这份资料非常纯粹，只有Python的基础语法，专门针对想要学习Python的小白。

Python中用#表示单行注释，#之后的同行的内容都会被注释掉。

使用三个连续的双引号表示多行注释，两个多行注释标识之间内容会被视作是注释。

Python当中的数字定义和其他语言一样：

我们分别使用+, -, *, /表示加减乘除四则运算符。

这里要注意的是，在Python2当中，10/3这个操作会得到3，而不是3.33333。因为除数和被除数都是整数，所以Python会自动执行整数的计算，帮我们把得到的商取整。如果是10.0 / 3，就会得到3.33333。目前Python2已经不再维护了，可以不用关心其中的细节。

但问题是Python是一个 弱类型 的语言，如果我们在一个函数当中得到两个变量，是无法直接判断它们的类型的。这就导致了同样的计算符可能会得到不同的结果，这非常蛋疼。以至于程序员在运算除法的时候，往往都需要手工加上类型转化符，将被除数转成浮点数。

在Python3当中拨乱反正，修正了这个问题，即使是两个整数相除，并且可以整除的情况下，得到的结果也一定是浮点数。

如果我们想要得到整数，我们可以这么操作：

两个除号表示 取整除 ，Python会为我们保留去除余数的结果。

除了取整除操作之外还有取余数操作，数学上称为取模，Python中用%表示。

Python中支持 乘方运算 ，我们可以不用调用额外的函数，而使用**符号来完成：

当运算比较复杂的时候，我们可以用括号来强制改变运算顺序。

Python中用首字母大写的True和False表示真和假。

用and表示与操作，or表示或操作，not表示非操作。而不是C++或者是Java当中的, || 和！。

在Python底层， True和False其实是1和0 ，所以如果我们执行以下操作，是不会报错的，但是在逻辑上毫无意义。

我们用==判断相等的操作，可以看出来True==1， False == 0.

我们要小心Python当中的bool()这个函数，它并不是转成bool类型的意思。如果我们执行这个函数，那么 只有0会被视作是False，其他所有数值都是True ：

Python中用==判断相等，表示大于，=表示大于等于， 表示小于，=表示小于等于，!=表示不等。

我们可以用and和or拼装各个逻辑运算：

注意not，and，or之间的优先级，其中not and or。如果分不清楚的话，可以用括号强行改变运行顺序。

关于list的判断，我们常用的判断有两种，一种是刚才介绍的==，还有一种是is。我们有时候也会简单实用is来判断，那么这两者有什么区别呢？我们来看下面的例子：

Python是全引用的语言，其中的对象都使用引用来表示。is判断的就是 两个引用是否指向同一个对象 ，而==则是判断两个引用指向的具体内容是否相等。举个例子，如果我们把引用比喻成地址的话，is就是判断两个变量的是否指向同一个地址，比如说都是沿河东路XX号。而==则是判断这两个地址的收件人是否都叫张三。

显然，住在同一个地址的人一定都叫张三，但是住在不同地址的两个人也可以都叫张三，也可以叫不同的名字。所以如果a is b，那么a == b一定成立，反之则不然。

Python当中对字符串的限制比较松， 双引号和单引号都可以表示字符串 ，看个人喜好使用单引号或者是双引号。我个人比较喜欢单引号，因为写起来方便。

字符串也支持+操作，表示两个字符串相连。除此之外，我们把两个字符串写在一起，即使没有+，Python也会为我们拼接：

我们可以使用[]来查找字符串当中某个位置的字符，用 len 来计算字符串的长度。

我们可以在字符串前面 加上f表示格式操作 ，并且在格式操作当中也支持运算，比如可以嵌套上len函数等。不过要注意，只有Python3.6以上的版本支持f操作。

最后是None的判断，在Python当中None也是一个对象， 所有为None的变量都会指向这个对象 。根据我们前面所说的，既然所有的None都指向同一个地址，我们需要判断一个变量是否是None的时候，可以使用is来进行判断，当然用==也是可以的，不过我们通常使用is。

理解了None之后，我们再回到之前介绍过的bool()函数，它的用途其实就是判断值是否是空。所有类型的 默认空值会被返回False ，否则都是True。比如0，""，[], {}, ()等。

除了上面这些值以外的所有值传入都会得到True。

Python当中的标准输入输出是 input和print 。

print会输出一个字符串，如果传入的不是字符串会自动调用__str__方法转成字符串进行输出。 默认输出会自动换行 ，如果想要以不同的字符结尾代替换行，可以传入end参数：

使用input时，Python会在命令行接收一行字符串作为输入。可以在input当中传入字符串，会被当成提示输出：

Python支持 三元表达式 ，但是语法和C++不同，使用if else结构，写成：

上段代码等价于：

Python中用[]表示空的list，我们也可以直接在其中填充元素进行初始化：

使用append和pop可以在list的末尾插入或者删除元素：

list可以通过[]加上下标访问指定位置的元素，如果是负数，则表示 倒序访问 。-1表示最后一个元素，-2表示倒数第二个，以此类推。如果访问的元素超过数组长度，则会出发 IndexError 的错误。

list支持切片操作，所谓的切片则是从原list当中 拷贝 出指定的一段。我们用start: end的格式来获取切片，注意，这是一个 左闭右开区间 。如果留空表示全部获取，我们也可以额外再加入一个参数表示步长，比如[1:5:2]表示从1号位置开始，步长为2获取元素。得到的结果为[1, 3]。如果步长设置成-1则代表反向遍历。

如果我们要指定一段区间倒序，则前面的start和end也需要反过来，例如我想要获取[3: 6]区间的倒序，应该写成[6:3:-1]。

只写一个:，表示全部拷贝，如果用is判断拷贝前后的list会得到False。可以使用del删除指定位置的元素，或者可以使用remove方法。

insert方法可以 指定位置插入元素 ，index方法可以查询某个元素第一次出现的下标。

list可以进行加法运算，两个list相加表示list当中的元素合并。 等价于使用extend 方法：

我们想要判断元素是否在list中出现，可以使用 in关键字 ，通过使用len计算list的长度：

tuple和list非常接近，tuple通过()初始化。和list不同， tuple是不可变对象 。也就是说tuple一旦生成不可以改变。如果我们修改tuple，会引发TypeError异常。

由于小括号是有改变优先级的含义，所以我们定义单个元素的tuple， 末尾必须加上逗号 ，否则会被当成是单个元素：

tuple支持list当中绝大部分操作：

我们可以用多个变量来解压一个tuple：

解释一下这行代码：

我们在b的前面加上了星号， 表示这是一个list 。所以Python会在将其他变量对应上值的情况下，将剩下的元素都赋值给b。

补充一点，tuple本身虽然是不可变的，但是 tuple当中的可变元素是可以改变的 。比如我们有这样一个tuple：

我们虽然不能往a当中添加或者删除元素，但是a当中含有一个list，我们可以改变这个list类型的元素，这并不会触发tuple的异常：

dict也是Python当中经常使用的容器，它等价于C++当中的map，即 存储key和value的键值对 。我们用{}表示一个dict，用:分隔key和value。

对 。我们用{}表示一个dict，用:分隔key和value。

dict的key必须为不可变对象，所以 list、set和dict不可以作为另一个dict的key ，否则会抛出异常：

我们同样用[]查找dict当中的元素，我们传入key，获得value，等价于get方法。

我们可以call dict当中的keys和values方法，获取dict当中的所有key和value的集合，会得到一个list。在Python3.7以下版本当中，返回的结果的顺序可能和插入顺序不同，在Python3.7及以上版本中，Python会保证返回的顺序和插入顺序一致：

我们也可以用in判断一个key是否在dict当中，注意只能判断key。

如果使用[]查找不存在的key，会引发KeyError的异常。如果使用 get方法则不会引起异常，只会得到一个None ：

setdefault方法可以 为不存在的key 插入一个value，如果key已经存在，则不会覆盖它：

我们可以使用update方法用另外一个dict来更新当前dict，比如a.update(b)。对于a和b交集的key会被b覆盖，a当中不存在的key会被插入进来：

我们一样可以使用del删除dict当中的元素，同样只能传入key。

Python3.5以上的版本支持使用**来解压一个dict：

set是用来存储 不重复元素 的容器，当中的元素都是不同的，相同的元素会被删除。我们可以通过set()，或者通过{}来进行初始化。注意当我们使用{}的时候，必须要传入数据，否则Python会将它和dict弄混。

set当中的元素也必须是不可变对象，因此list不能传入set。

可以调用add方法为set插入元素：

set还可以被认为是集合，所以它还支持一些集合交叉并补的操作。

set还支持 超集和子集的判断 ，我们可以用大于等于和小于等于号判断一个set是不是另一个的超集或子集：

和dict一样，我们可以使用in判断元素在不在set当中。用copy可以拷贝一个set。

Python当中的判断语句非常简单，并且Python不支持switch，所以即使是多个条件，我们也只能 罗列if-else 。

我们可以用in来循环迭代一个list当中的内容，这也是Python当中基本的循环方式。

如果我们要循环一个范围，可以使用range。range加上一个参数表示从0开始的序列，比如range(10)，表示[0, 10)区间内的所有整数：

如果我们传入两个参数，则 代表迭代区间的首尾 。

如果我们传入第三个元素，表示每次 循环变量自增的步长 。

如果使用enumerate函数，可以 同时迭代一个list的下标和元素 ：

while循环和C++类似，当条件为True时执行，为false时退出。并且判断条件不需要加上括号：

Python当中使用 try和except捕获异常 ，我们可以在except后面限制异常的类型。如果有多个类型可以写多个except，还可以使用else语句表示其他所有的类型。finally语句内的语法 无论是否会触发异常都必定执行 ：

在Python当中我们经常会使用资源，最常见的就是open打开一个文件。我们 打开了文件句柄就一定要关闭 ，但是如果我们手动来编码，经常会忘记执行close操作。并且如果文件异常，还会触发异常。这个时候我们可以使用with语句来代替这部分处理，使用with会 自动在with块执行结束或者是触发异常时关闭打开的资源 。

以下是with的几种用法和功能：

凡是可以使用in语句来迭代的对象都叫做 可迭代对象 ，它和迭代器不是一个含义。这里只有可迭代对象的介绍，想要了解迭代器的具体内容，请移步传送门：

Python——五分钟带你弄懂迭代器与生成器，夯实代码能力

当我们调用dict当中的keys方法的时候，返回的结果就是一个可迭代对象。

我们 不能使用下标来访问 可迭代对象，但我们可以用iter将它转化成迭代器，使用next关键字来获取下一个元素。也可以将它转化成list类型，变成一个list。

使用def关键字来定义函数，我们在传参的时候如果指定函数内的参数名， 可以不按照函数定义的顺序 传参：

可以在参数名之前加上*表示任意长度的参数，参数会被转化成list：

也可以指定任意长度的关键字参数，在参数前加上**表示接受一个dict：

当然我们也可以两个都用上，这样可以接受任何参数：

传入参数的时候我们也可以使用*和**来解压list或者是dict：

Python中的参数 可以返回多个值 ：

函数内部定义的变量即使和全局变量重名，也 不会覆盖全局变量的值 。想要在函数内部使用全局变量，需要加上 global 关键字，表示这是一个全局变量：

Python支持 函数式编程 ，我们可以在一个函数内部返回一个函数：

Python中可以使用lambda表示 匿名函数 ，使用:作为分隔，:前面表示匿名函数的参数，:后面的是函数的返回值：

我们还可以将函数作为参数使用map和filter，实现元素的批量处理和过滤。关于Python中map、reduce和filter的使用，具体可以查看之前的文章：

五分钟带你了解map、reduce和filter

我们还可以结合循环和判断语来给list或者是dict进行初始化：

使用 import语句引入一个Python模块 ，我们可以用.来访问模块中的函数或者是类。

我们也可以使用from import的语句，单独引入模块内的函数或者是类，而不再需要写出完整路径。使用from import *可以引入模块内所有内容（不推荐这么干）

可以使用as给模块内的方法或者类起别名：

我们可以使用dir查看我们用的模块的路径：

这么做的原因是如果我们当前的路径下也有一个叫做math的Python文件，那么 会覆盖系统自带的math的模块 。这是尤其需要注意的，不小心会导致很多奇怪的bug。

我们来看一个完整的类，相关的介绍都在注释当中

以上内容的详细介绍之前也有过相关文章，可以查看：

Python—— slots ，property和对象命名规范

下面我们来看看Python当中类的使用：

这里解释一下，实例和对象可以理解成一个概念，实例的英文是instance，对象的英文是object。都是指类经过实例化之后得到的对象。

继承可以让子类 继承父类的变量以及方法 ，并且我们还可以在子类当中指定一些属于自己的特性，并且还可以重写父类的一些方法。一般我们会将不同的类放在不同的文件当中，使用import引入，一样可以实现继承。

我们创建一个蝙蝠类：

我们再创建一个蝙蝠侠的类，同时继承Superhero和Bat：

执行这个类：

我们可以通过yield关键字创建一个生成器，每次我们调用的时候执行到yield关键字处则停止。下次再次调用则还是从yield处开始往下执行：

除了yield之外，我们还可以使用()小括号来生成一个生成器：

关于生成器和迭代器更多的内容，可以查看下面这篇文章：

五分钟带你弄懂迭代器与生成器，夯实代码能力

我们引入functools当中的wraps之后，可以创建一个装饰器。装饰器可以在不修改函数内部代码的前提下，在外面包装一层其他的逻辑:

装饰器之前也有专门的文章详细介绍，可以移步下面的传送门：

一文搞定Python装饰器，看完面试不再慌

不知道有多少小伙伴可以看到结束，原作者的确非常厉害，把Python的基本操作基本上都囊括在里面了。如果都能读懂并且理解的话，那么Python这门语言就算是入门了。

如果你之前就有其他语言的语言基础，我想本文读完应该不用30分钟。当然在30分钟内学会一门语言是不可能的，也不是我所提倡的。但至少通过本文我们可以做到熟悉Python的语法，知道大概有哪些操作，剩下的就要我们亲自去写代码的时候去体会和运用了。

根据我的经验，在学习一门新语言的前期，不停地查阅资料是免不了的。希望本文可以作为你在使用Python时候的查阅文档。

最后，我这里有各种免费的编程类资料，有需要的及时私聊我，回复"学习"，分享给大家，正在发放中............

相关问答

Q1: python中函数定义

1、函数定义

①使用def关键字定义函数

②

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

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

#函数体

return 表达式

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

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

2、函数调用

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

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

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

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

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

Q2: Python中冷门但非常好用的内置函数

Python中有许多内置函数,不像print、len那么广为人知,但它们的功能却异常强大,用好了可以大大提高代码效率，同时提升代码的简洁度，增强可阅读性

Counter

collections在python官方文档中的解释是High-performance container datatypes，直接的中文翻译解释高性能容量数据类型。这个模块实现了特定目标的容器，以提供Python标准内建容器 dict , list , set , 和 tuple 的替代选择。在python3.10.1中它总共包含以下几种数据类型：

容器名简介

namedtuple() 创建命名元组子类的工厂函数

deque 类似列表(list)的容器，实现了在两端快速添加(append)和弹出(pop)

ChainMap 类似字典(dict)的容器类，将多个映射集合到一个视图里面

Counter 字典的子类，提供了可哈希对象的计数功能

OrderedDict 字典的子类，保存了他们被添加的顺序

defaultdict 字典的子类，提供了一个工厂函数，为字典查询提供一个默认值

UserDict 封装了字典对象，简化了字典子类化

UserList 封装了列表对象，简化了列表子类化

UserString 封装了字符串对象，简化了字符串子类化

其中Counter中文意思是计数器，也就是我们常用于统计的一种数据类型，在使用Counter之后可以让我们的代码更加简单易读。Counter类继承dict类，所以它能使用dict类里面的方法

举例

#统计词频

fruits = ['apple', 'peach', 'apple', 'lemon', 'peach', 'peach']

result = {}

for fruit in fruits:

if not result.get(fruit):

result[fruit] = 1

else:

result[fruit] += 1

print(result)

#{'apple': 2, 'peach': 3, 'lemon': 1}下面我们看用Counter怎么实现：

from collections import Counter

fruits = ['apple', 'peach', 'apple', 'lemon', 'peach', 'peach']

c = Counter(fruits)

print(dict(c))

#{'apple': 2, 'peach': 3, 'lemon': 1}显然代码更加简单了，也更容易阅读和维护了。

elements()

返回一个迭代器，其中每个元素将重复出现计数值所指定次。元素会按首次出现的顺序返回。如果一个元素的计数值小于1，elements()将会忽略它。

c = Counter(a=4, b=2, c=0, d=-2)

sorted(c.elements())

['a', 'a', 'a', 'a', 'b', 'b']most_common([n])

返回一个列表，其中包含n个最常见的元素及出现次数，按常见程度由高到低排序。如果n被省略或为None，most_common()将返回计数器中的所有元素。计数值相等的元素按首次出现的顺序排序：

Counter('abracadabra').most_common(3)

[('a', 5), ('b', 2), ('r', 2)]这两个方法是Counter中最常用的方法，其他方法可以参考 python3.10.1官方文档

实战

Leetcode 1002.查找共用字符

给你一个字符串数组words，请你找出所有在words的每个字符串中都出现的共用字符（包括重复字符），并以数组形式返回。你可以按任意顺序返回答案。

输入：words = ["bella", "label", "roller"]

输出：["e", "l", "l"]

输入：words = ["cool", "lock", "cook"]

输出：["c", "o"]看到统计字符，典型的可以用Counter完美解决。这道题是找出字符串列表里面每个元素都包含的字符，首先可以用Counter计算出每个元素每个字符出现的次数，依次取交集最后得出所有元素共同存在的字符，然后利用elements输出共用字符出现的次数

class Solution:

def commonChars(self, words: List[str]) - List[str]:

from collections import Counter

ans = Counter(words[0])

for i in words[1:]:

ans = Counter(i)

return list(ans.elements())提交一下，发现83个测试用例耗时48ms，速度还是不错的

sorted

在处理数据过程中，我们经常会用到排序操作，比如将列表、字典、元组里面的元素正/倒排序。这时候就需要用到sorted()，它可以对任何可迭代对象进行排序，并返回列表

对列表升序操作：

a = sorted([2, 4, 3, 7, 1, 9])

print(a)

# 输出：[1, 2, 3, 4, 7, 9]对元组倒序操作：

sorted((4,1,9,6),reverse=True)

print(a)

# 输出：[9, 6, 4, 1]使用参数：key，根据自定义规则，按字符串长度来排序：

fruits = ['apple', 'watermelon', 'pear', 'banana']

a = sorted(fruits, key = lambda x : len(x))

print(a)

# 输出：['pear', 'apple', 'banana', 'watermelon']all

all() 函数用于判断给定的可迭代参数iterable中的所有元素是否都为 TRUE，如果是返回 True，否则返回 False。元素除了是 0、空、None、False外都算True。注意：空元组、空列表返回值为True。

all(['a', 'b', 'c', 'd']) # 列表list，元素都不为空或0

True

all(['a', 'b', '', 'd']) # 列表list，存在一个为空的元素

False

all([0, 1，2, 3]) # 列表list，存在一个为0的元素

False

all(('a', 'b', 'c', 'd')) # 元组tuple，元素都不为空或0

True

all(('a', 'b', '', 'd')) # 元组tuple，存在一个为空的元素

False

all((0, 1, 2, 3)) # 元组tuple，存在一个为0的元素

False

all([]) # 空列表

True

all(()) # 空元组

Trueany函数正好和all函数相反：判断一个tuple或者list是否全为空，0，False。如果全为空，0，False，则返回False；如果不全为空，则返回True。

F-strings

在python3.6.2版本中，PEP 498提出一种新型字符串格式化机制，被称为 “字符串插值” 或者更常见的一种称呼是F-strings，F-strings提供了一种明确且方便的方式将python表达式嵌入到字符串中来进行格式化：

s1='Hello'

s2='World'

print(f'{s1} {s2}!')

# Hello World!在F-strings中我们也可以执行函数：

def power(x):

return x*x

x=4

print(f'{x} * {x} = {power(x)}')

# 4 * 4 = 16而且F-strings的运行速度很快，比传统的%-string和str.format()这两种格式化方法都快得多，书写起来也更加简单。

本文主要讲解了python几种冷门但好用的函数，更多内容以后会陆陆续续更新~

Q3: python 如何判断函数有没有描述文档

用__doc__属性，比如：

import os

print os.makedirs.__doc__

makedirs(path [, mode=0777])

Super-mkdir; create a leaf directory and all intermediate ones.

Works like mkdir, except that any intermediate path segment (not

just the rightmost) will be created if it does not exist. This is

recursive.

Q4: Python基础之常见内建函数

map() 函数接受两个参数，一个是函数，一个是可迭代对象（Iterable）, map 将传入的函数依次作用到可迭代对象的每一个元素，并把结果作为迭代器(Iterator)返回。

举例说明，有一个函数 f(x)=x^2 ，要把这个函数作用到一个list [1,2,3,4,5,6,7,8,9] 上：

运用简单的循环可以实现：

运用高阶函数 map() ：

结果 r 是一个迭代器，迭代器是惰性序列，通过 list() 函数让它把整个序列都计算出来并返回一个 list 。

如果要把这个list所有数字转为字符串利用 map() 就简单了：

小练习：利用 map() 函数，把用户输入的不规范的英文名字变为首字母大写其他小写的规范名字。输入 ['adam', 'LISA', 'barT'] ,输出 ['Adam', 'Lisa', 'Bart']

reduce() 函数也是接受两个参数，一个是函数，一个是可迭代对象， reduce 将传入的函数作用到可迭代对象的每个元素的结果做累计计算。然后将最终结果返回。

效果就是： reduce(f, [x1, x2, x3, x4]) = f(f(f(x1, x2), x3), x4)

举例说明，将序列 [1,2,3,4,5] 变换成整数 12345 ：

小练习：编写一个 prod() 函数，可以接受一个 list 并利用 reduce 求积：

map() 和 reduce() 综合练习：编写 str2float 函数，把字符串 '123.456' 转换成浮点型 123.456

filter() 函数用于过滤序列， filter() 也接受一个函数和一个序列， filter() 把传入的函数依次作用于每个元素，然后根据返回值是 True 还是 False 决定保留还是丢弃该元素。

举例说明，删除list中的偶数:

小练习：用 filter() 求素数

定义一个筛选函数：

定义一个生成器不断返回下一个素数：

打印100以内素数：

python内置的 sorted() 函数可以对list进行排序：

sorted() 函数也是一个高阶函数，还可以接受一个 key 函数来实现自定义排序：

key 指定的函数将作用于list的每一个元素上，并根据 key 函数返回的结果进行排序.

默认情况下，对字符串排序，是按照ASCII的大小比较的，由于'Z' 'a'，结果，大写字母Z会排在小写字母a的前面。如果想忽略大小写可都转换成小写来比较：

要进行反向排序，不必改动key函数，可以传入第三个参数 reverse=True ：

小练习：假设我们用一组tuple表示学生名字和成绩： L = [('Bob', 75), ('Adam', 92), ('Bart', 66), ('Lisa', 88)] 。用sorted()对上述列表分别按c成绩从高到低排序：

运用匿名函数更简洁：