Fetch 模块

模块：borax.fetch

函数接口

borax.fetch 模块实现了从数据列表按照指定的一个或多个属性/键选取数据。

fetch 模块包含了以下几个函数：

  • fetch(iterable, key, *keys, default=EMPTY, defaults=None, getter=None)
  • ifetch(iterable, key, *keys, default=EMPTY, defaults=None, getter=None)
  • fetch_single(iterable, key, default=EMPTY, getter=None)
  • ifetch_multiple(iterable, *keys, defaults=None, getter=None)
  • ifetch_single(iterable, key, default=EMPTY, getter=None)

各个参数意义如下：

  • iterable：数据列表
  • key / keys：键值、属性访问方式的索引
  • default：默认值，用于选择单个属性
  • defaults：默认值字典，用于选择多个属性
  • getter：自定义访问回调函数

通常使用 fetch 函数即可。

基本使用

选取单个属性

从 objects 数据获取 name 的数据。

  1. from borax.fetch import fetch
  3. objects = [
  4.     {'id': 282, 'name': 'Alice', 'age': 30},
  5.     {'id': 217, 'name': 'Bob', 'age': 56},
  6.     {'id': 328, 'name': 'Charlie', 'age': 56},
  7. ]
  9. names = fetch(objects, 'name')
  10. print(names)

输出

  1. ['Alice', 'Bob', 'Charlie']

选取多个属性

从 objects 数据获取 name 和 age 的数据。

  1. from borax.fetch import fetch
  3. objects = [
  4.     {'id': 282, 'name': 'Alice', 'age': 30},
  5.     {'id': 217, 'name': 'Bob', 'age': 56},
  6.     {'id': 328, 'name': 'Charlie', 'age': 56},
  7. ]
  9. names, ages = fetch(objects, 'name', 'age')
  10. print(names)
  11. print(ages)

输出

  1. ['Alice', 'Bob', 'Charlie']
  2. [30, 56, 56]

提供默认值

当 iterable 数据列表缺少某个属性/键，可以通过指定 default 或 defaults 参数提供默认值。

  1. from borax.fetch import fetch
  3. objects = [
  4.     {'id': 282, 'name': 'Alice', 'age': 30, 'gender': 'female'},
  5.     {'id': 217, 'name': 'Bob', 'age': 56},
  6.     {'id': 328, 'name': 'Charlie', 'gender': 'male'},
  7. ]
  9. print('Demo for one default value')
  10. genders = fetch(objects, 'gender', default='unknown')
  11. print(genders)
  13. print('Demo for multiple default values')
  14. ages, genders = fetch(objects, 'age', 'gender', defaults={'age': 0, 'gender':'unknown'})
  15. print(genders)
  16. print(ages)

结果输出

  1. Demo for one default value
  2. ['female', 'unknown', 'male']
  3. Demo for multiple default values
  4. ['female', 'unknown', 'male']
  5. [30, 56, 0]

属性访问

除了上述的键值访问方式，fetch 函数还内置属性访问的获取方式。

  1. from borax.fetch import fetch
  3. class Point:
  4.     def __init__(self, x, y, z):
  5.         self.x = x
  6.         self.y = y
  7.         self.z = z
  10. points = [
  11.     Point(1, 2, 3),
  12.     Point(4, 5, 6),
  13.     Point(7, 8, 9)
  14. ]
  16. print('Fetch x values:')
  17. x = fetch(points, 'x')
  18. print(x)
  20. print('Fetch x,y,z values:')
  21. x, y, z = fetch(points, 'x', 'y', 'z')
  22. print(x)
  23. print(y)
  24. print(z)

结果输出

  1. Fetch x values:
  2. [1, 4, 7]
  3. Fetch x,y,z values:
  4. [1, 4, 7]
  5. [2, 5, 8]
  6. [3, 6, 9]

自定义Getter

除了内置的属性访问方式 itemgetter 和键值访问方式 attrgetter 外，fetch 函数还通过 getter 参数支持自定义访问方式。

getter 需满足下列的几个条件：

  • 是一个函数，命名函数或匿名函数均可
  • 该函数必须含有 item 和 key 两个参数
  • 返回是具体的数值

例子：

  1. from borax.fetch import fetch
  4. class Point:
  5.     def __init__(self, index, x, y, z):
  6.         self.index = index
  7.         self._data = {'x': x, 'y': y, 'z': z}
  9.     def get(self, key):
  10.         return self._data.get(key)
  13. points = [
  14.     Point('a', 1, 2, 3),
  15.     Point('b', 4, 5, 6),
  16.     Point('c', 7, 8, 9)
  17. ]
  20. def point_getter(item, key):
  21.     return item.get(key)
  24. print('Fetch x values:')
  25. x = fetch(points, 'x', getter=point_getter)
  26. print(x)
  28. print('Fetch x,y,z values:')
  29. x, y, z = fetch(points, 'x', 'y', 'z', getter=point_getter)
  30. print(x)
  31. print(y)
  32. print(z)

结果输出

  1. Fetch x values:
  2. [1, 4, 7]
  3. Fetch x,y,z values:
  4. [1, 4, 7]
  5. [2, 5, 8]
  6. [3, 6, 9]

需要注意的是，自定义 Getter 是应用至所有属性的，内置的 属性访问方式 和 键值访问方式 将不再使用，混用将可能无法获得期望的结果。

错误的示例1

  1. >>> indexes, xs = fetch(points, 'index', 'x', getter=point_getter)
  2. [None, None, None]
  3. [1, 4, 7]

错误的示例2

  1. >>> indexes, xs = fetch(points, 'index', 'x')
  2. Traceback (most recent call last):
  3. TypeError: 'Point' object is not subscriptable

应当分别调用 fetch 函数。

正确的用法

  1. x, y = fetch(points, 'x', 'y', getter=point_getter)
  3. print(x)
  4. print(y)
  6. indexes = fetch(points, 'index')
  7. print(indexes)

结果输出

  1. [1, 4, 7]
  2. [2, 5, 8]
  3. ['a', 'b', 'c']