Python 中 key 参数的含义及用法

哈喽大家好，我是咸鱼

我们在使用 sorted() 或 map() 函数的时候，都会看到里面有一个 key 参数

其实这个 key 参数也存在于其他内置函数中（例如 min()、max() 等），那么我们今天就来了解一下 key 参数的含义以及用途吧！

原文：https://www.thepythoncodingstack.com/p/the-key-to-the-key-parameter-in-python

sorted() 中的 key

我们来看下面这段代码：

some_numbers = [
    3.14159,
    2.71828,
    6.022e23,
    6.626e-34,
    299_792_458,
    6.674e-11,
    1.61803,
]

reordered_numbers = sorted(some_numbers)

print(*reordered_numbers, sep="\n")

reordered_numbers = sorted(some_numbers) 这一行代码使用 Python 的内置函数 sorted() 对 some_numbers 列表中的数值进行排序

*reordered_numbers 将列表中的元素作为参数传递给 print() 函数，其中解包操作符 * 逐个解包列表中的元素，这相当于在括号内直接用逗号分隔每个元素

输出如下：

6.626e-34
6.674e-11
1.61803
2.71828
3.14159
299792458
6.022e+23

如果我们把要排序的元素由【数字】改成【名字（字符串）】，看下会发生什么

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

reordered_names = sorted(some_names)
print(*reordered_names, sep="\n")

输出如下：

Albert
Alexandra
Christine
Ishaan
Max
Robert
Trevor

可以看到是按照名字的字母顺序进行排序，那如果我们想要根据名称的长度来进行排序呢？

也就是说，我想自己定义排序的规则，这便是 key 参数的使用场景了

我们可以把自定义的规则用函数的形式表示出来，然后再把函数名作为 key 参数的值

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

reordered_names = sorted(some_names, key=len)
print(*reordered_names, sep="\n")

首先列表中 some_names 的每个元素都作为参数传递给函数 len() ，然后 sorted() 使用 len() 返回的值来确定元素的顺序

输出如下：

Max
Robert
Ishaan
Trevor
Albert
Alexandra
Christine

上面我们说过可以把自定义的规则用函数的形式表示出来，然后再把函数名作为 key 参数的值

这里的函数可以是：

• 内置函数
• 自定义函数
• 匿名函数（lambda）

下面是一个自定义函数的例子

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

def get_number_of_a_s(item):
    return item.lower().count("a")

reordered_names = sorted(some_names, key=get_number_of_a_s)
print(*reordered_names, sep="\n")

函数 get_number_of_a_s() 将输入字符串转换为小写，并计算字母 “a” 的出现次数。该函数返回此计数，用于 sorted() 确定新列表中元素的顺序。输出如下：

Robert
Trevor
Christine
Max
Albert
Ishaan
Alexandra

由于 sorted() 通过按升序对数值进行排序来处理数值，因此没有“a”的名称首先出现，因为 .count("a") 这些名称的返回 0

"Max" 并且是 "Albert" 下一个，因为它们包含一个出现的 “a”。 "Max" 列在最前面，因为它在原始列表中出现之前 "Albert" 。接下来是出现两次和三次 “a” 的名称

下面是一个 lambda 函数的例子

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

reordered_names = sorted(
    some_names,
    key=lambda item: item.lower().count("a"),
)
print(*reordered_names, sep="\n")

list.sort() 中的 key

sorted()

• 返回一个新的排序列表
• 不会修改原始列表
• 可以给定一个自定义的比较函数

list.sort()

• 对列表进行原地排序
• 会修改原始列表
• 不能给定一个自定义的比较函数

我们来看看列表的排序函数 list.sort()，需要注意的是：list.sort() 不像内置函数 sorted() 那样返回一个新的排序列表，而是对原有列表进行排序

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

some_names.sort(
    key=lambda item: item.lower().count("a")
)
print(*some_names, sep="\n")

输出如下：

Robert
Trevor
Christine
Max
Albert
Ishaan
Alexandra

max() 和 min() 中的 key

不单单 sorted() 和 list.sort() 函数有 key 参数，max()\min() 里面也有

比如说我想返回一个随机列表中的最大值，并自定义了比较规则

import random

numbers = [random.randint(1, 50) for _ in range(20)]

print(numbers)

# 输出出列表 numbers 中的最大值
print(
    max(numbers)
)

print(
    max(
        numbers,
        key=lambda x: sum(int(y) for y in str(x)),
    )
)

输出如下：

[6, 8, 44, 16, 46, 43, 23, 26, 33, 28, 32, 26, 15, 38, 32, 38, 23, 13, 21, 26]
46
38

其中 key 参数的值为 lambda 函数，使用 lambda 函数来自定义规则，计算列表中每个元素的各位数之和，并找出其中的最大值：

• str(x) 将整数转换为字符串，int(y) 将字符串转换为整数，然后 sum() 函数计算了该数字的各位数之和。
• max() 函数根据这个规则找到了列表中数字各位数之和最大的那个数字

其他

除此之外，像 heapq 模块中的nlargest() 和 nsmallest() 函数、itertools 模块中的groupby() 函数也有 key 参数

我们来看个例子，使用 itertools.groupby() 函数，将名字列表 some_names 按照名字长度进行分组，并将分组结果打印输出

import itertools

some_names = [
    "Robert",
    "Ishaan",
    "Max",
    "Trevor",
    "Alexandra",
    "Albert",
    "Christine",
]

output = itertools.groupby(
    some_names,
    key=len,
)
for item, group in output:
    print(item, list(group))

函数 itertools.groupby() 有两个参数（第二个参数是可选的）。第一个参数是包含数据的可迭代对象，第二个参数是 key

key=len 表示按照元素的长度进行分组。groupby() 函数将根据指定的 key 返回一个迭代器，该迭代器产生一对元素，第一个元素是分组的键（这里是名字的长度），第二个元素是对应的分组中的元素。

输出如下：

6 ['Robert', 'Ishaan']
3 ['Max']
6 ['Trevor']
9 ['Alexandra']
6 ['Albert']
9 ['Christine']