# 字典物件

`PyDictObject`

  `PyObject` 子型態代表一個 Python 字典物件。

PyTypeObject `PyDict_Type`

  `PyTypeObject` 實例代表一個 Python 字典型態。此與 Python 層中的 `dict` 為同一個物件。

int `PyDict_Check`(PyObject *p)

  若 p 是一個字典物件或字典的子型態實例則會回傳 true。

int `PyDict_CheckExact`(PyObject *p)

  若 p 是一個字典物件但並不是一個字典子型態的實例，則回傳 true。

PyObject* `PyDict_New`()
  Return value: New reference.

  回傳一個新的空字典，或在失敗時回傳 NULL。

PyObject* `PyDictProxy_New`(PyObject *mapping)
  Return value: New reference.

  返回 `types.MappingProxyType` 对象，用于强制执行只读行为的映射。这通常用于创建视图以防止修改非动态类类型的字典。

void `PyDict_Clear`(PyObject *p)

  清空现有字典的所有键值对。

int `PyDict_Contains`(PyObject *p, PyObject *key)

  确定 key 是否包含在字典 p 中。如果 key 匹配上 p 的某一项，则返回 `1` ，否则返回 `0` 。返回 `-1` 表示出错。这等同于Python表达式 `key in p` 。

PyObject* `PyDict_Copy`(PyObject *p)
  Return value: New reference.

  返回与 p 包含相同键值对的新字典。

int `PyDict_SetItem`(PyObject *p, PyObject *key, PyObject *val)

  使用 key 作为键将 value 插入字典 p 。 key 必须为 hashable ；如果不是，会抛出 `TypeError` 异常。成功返回 `0` ，失败返回 `-1` 。

int `PyDict_SetItemString`(PyObject *p, const char *key, PyObject *val)

  Insert value into the dictionary p using key as a key. key should be a `char*`. The key object is created using `PyUnicode_FromString(key)`. Return `0` on success or `-1` on failure.

int `PyDict_DelItem`(PyObject *p, PyObject *key)

  使用键 key 删除字典 p 中的条目。 key 必须是可哈希的；如果不是，则抛出 `TypeError` 异常。成功时返回 `0` ，失败时返回 `-1` 。

int `PyDict_DelItemString`(PyObject *p, const char *key)

  删除字典 p 中由字符串 key 作为键的条目。成功时返回 `0` ，失败时返回 `-1`。

PyObject* `PyDict_GetItem`(PyObject *p, PyObject *key)
  Return value: Borrowed reference.

  Return the object from dictionary p which has a key key. Return NULL if the key key is not present, but without setting an exception.

  需要注意的是，调用 `__hash__()` 和 `__eq__()` 方法产生的异常不会被抛出。改用 `PyDict_GetItemWithError()` 获得错误报告。

PyObject* `PyDict_GetItemWithError`(PyObject *p, PyObject *key)

  Variant of `PyDict_GetItem()` that does not suppress exceptions. Return NULL with an exception set if an exception occurred. Return NULL without an exception set if the key wasn’t present.

PyObject* `PyDict_GetItemString`(PyObject *p, const char *key)
  Return value: Borrowed reference.

  This is the same as `PyDict_GetItem()`, but key is specified as a `char*`, rather than a `PyObject*`.

  需要注意的是，调用 `__hash__()` 、 `__eq__()` 方法和创建一个临时的字符串对象时产生的异常不会被抛出。改用 `PyDict_GetItemWithError()` 获得错误报告。

PyObject* `PyDict_SetDefault`(PyObject *p, PyObject *key, PyObject *default)
  Return value: Borrowed reference.

  这跟Python层面的 `dict.setdefault()` 一样。如果键 key 存在，它返回在字典 p 里面对应的值。如果键不存在，它会和值 defaultobj 一起插入并返回 defaultobj 。这个函数只计算 key 的哈希函数一次，而不是在查找和插入时分别计算它。

  3.4 版新加入.

PyObject* `PyDict_Items`(PyObject *p)
  Return value: New reference.

  返回一个包含字典中所有键值项的 `PyListObject`。

PyObject* `PyDict_Keys`(PyObject *p)
  Return value: New reference.

  返回一个包含字典中所有键(keys)的 `PyListObject`。

PyObject* `PyDict_Values`(PyObject *p)
  Return value: New reference.

  返回一个包含字典中所有值(values)的 `PyListObject`。

Py_ssize_t `PyDict_Size`(PyObject *p)

  返回字典中项目数，等价于对字典 p 使用 `len(p)`。

int `PyDict_Next`(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)

  Iterate over all key-value pairs in the dictionary p. The `Py_ssize_t` referred to by ppos must be initialized to `0` prior to the first call to this function to start the iteration; the function returns true for each pair in the dictionary, and false once all pairs have been reported. The parameters pkey and pvalue should either point to `PyObject*` variables that will be filled in with each key and value, respectively, or may be NULL. Any references returned through them are borrowed. ppos should not be altered during iteration. Its value represents offsets within the internal dictionary structure, and since the structure is sparse, the offsets are not consecutive.

  例如

      PyObject *key, *value;
      Py_ssize_t pos = 0;

      while (PyDict_Next(self->dict, &pos, &key, &value)) {
          /* do something interesting with the values... */
          ...
      }

  字典 p 不应该在遍历期间发生改变。在遍历字典时，改变键中的值是安全的，但仅限于键的集合不发生改变。例如:

      PyObject *key, *value;
      Py_ssize_t pos = 0;

      while (PyDict_Next(self->dict, &pos, &key, &value)) {
          long i = PyLong_AsLong(value);
          if (i == -1 && PyErr_Occurred()) {
              return -1;
          }
          PyObject *o = PyLong_FromLong(i + 1);
          if (o == NULL)
              return -1;
          if (PyDict_SetItem(self->dict, key, o) < 0) {
              Py_DECREF(o);
              return -1;
          }
          Py_DECREF(o);
      }

int `PyDict_Merge`(PyObject *a, PyObject *b, int override)

  对映射对象 b 进行迭代，将键值对添加到字典 a。 b 可以是一个字典，或任何支持 `PyMapping_Keys()` 和 `PyObject_GetItem()` 的对象。 如果 override 为真值，则如果在 b 中找到相同的键则 a 中已存在的相应键值对将被替换，否则如果在 a 中没有相同的键则只是添加键值对。 当成功时返回 `0` 或者当引发异常时返回 `-1`。

int `PyDict_Update`(PyObject *a, PyObject *b)

  这与 C 中的 `PyDict_Merge(a, b, 1)` 一样，也类似于 Python 中的 `a.update(b)`，差别在于 `PyDict_Update()` 在第二个参数没有 「keys」 属性时不会回退到迭代键值对的序列。 当成功时返回 `0` 或者当引发异常时返回 `-1`。

int `PyDict_MergeFromSeq2`(PyObject *a, PyObject *seq2, int override)

  将 seq2 中的键值对更新或合并到字典 a。 seq2 必须为产生长度为 2 的用作键值对的元素的可迭代对象。 当存在重复的键时，如果 override 真值则最后出现的键胜出。 当成功时返回 `0` 或者当引发异常时返回 `-1`。 等价的 Python 代码（返回值除外）:

      def PyDict_MergeFromSeq2(a, seq2, override):
          for key, value in seq2:
              if override or key not in a:
                  a[key] = value

int `PyDict_ClearFreeList`()

  清空释放列表。 返回所释放的条目数。

  3.3 版新加入.