API do PyHash

Veja também o membro PyTypeObject.tp_hash e Hashing de tipos numéricos.

type Py_hash_t

Tipo de valor do hash: inteiro com sinal.

Adicionado na versão 3.2.

type Py_uhash_t

Tipo de valor do hash: inteiro sem sinal.

Adicionado na versão 3.2.

Py_HASH_ALGORITHM

A numerical value indicating the algorithm for hashing of str, bytes, and memoryview.

The algorithm name is exposed by sys.hash_info.algorithm.

Adicionado na versão 3.4.

Py_HASH_FNV
Py_HASH_SIPHASH24
Py_HASH_SIPHASH13

Numerical values to compare to Py_HASH_ALGORITHM to determine which algorithm is used for hashing. The hash algorithm can be configured via the configure --with-hash-algorithm option.

Adicionado na versão 3.4: Add Py_HASH_FNV and Py_HASH_SIPHASH24.

Adicionado na versão 3.11: Add Py_HASH_SIPHASH13.

Py_HASH_CUTOFF

Buffers of length in range [1, Py_HASH_CUTOFF) are hashed using DJBX33A instead of the algorithm described by Py_HASH_ALGORITHM.

  • A Py_HASH_CUTOFF of 0 disables the optimization.

  • Py_HASH_CUTOFF must be non-negative and less or equal than 7.

32-bit platforms should use a cutoff smaller than 64-bit platforms because it is easier to create colliding strings. A cutoff of 7 on 64-bit platforms and 5 on 32-bit platforms should provide a decent safety margin.

This corresponds to the sys.hash_info.cutoff constant.

Adicionado na versão 3.4.

PyHASH_MODULUS

O primo de Mersenne P = 2**n -1, usado para esquema de hash numérico.

This corresponds to the sys.hash_info.modulus constant.

Adicionado na versão 3.13.

PyHASH_BITS

O expoente n de P em PyHASH_MODULUS.

Adicionado na versão 3.13.

PyHASH_MULTIPLIER

Multiplicador de primo usado em strings e vários outros hashes.

Adicionado na versão 3.13.

PyHASH_INF

O valor de hash retornado para um infinito positivo.

This corresponds to the sys.hash_info.inf constant.

Adicionado na versão 3.13.

PyHASH_IMAG

O multiplicador usado para a parte imaginária de um número complexo.

This corresponds to the sys.hash_info.imag constant.

Adicionado na versão 3.13.

type PyHash_FuncDef

Definição de função de hash usada por PyHash_GetFuncDef().

Py_hash_t (*const hash)(const void*, Py_ssize_t)

Função de hash.

const char *name

Nome de função hash (string codificada em UTF-8).

This corresponds to the sys.hash_info.algorithm constant.

const int hash_bits

Tamanho interno do valor do hash em bits.

This corresponds to the sys.hash_info.hash_bits constant.

const int seed_bits

Tamanho da entrada de seed em bits.

This corresponds to the sys.hash_info.seed_bits constant.

Adicionado na versão 3.4.

PyHash_FuncDef *PyHash_GetFuncDef(void)

Obtém a definição de função de hash.

Ver também

PEP 456 “Algoritmo de hash seguro e intercambiável”.

Adicionado na versão 3.4.

Py_hash_t Py_HashPointer(const void *ptr)

Hash de um valor de ponteiro: processa o valor do ponteiro como um inteiro (converte-o para uintptr_t internamente). O ponteiro não é desreferenciado.

A função não pode falhar: ela não pode retornar -1.

Adicionado na versão 3.13.

Py_hash_t Py_HashBuffer(const void *ptr, Py_ssize_t len)

Calcula e retorna o valor de hash de um buffer de len bytes, começando no endereço ptr. O hash tem garantia de corresponder ao de bytes, memoryview e outros objetos embutidos que implementam o protocolo de buffer.

Usa esta função para implementar hash para objetos imutáveis cuja função tp_richcompare compara ao buffer de outro objeto.

len deve ser maior que ou igual a 0.

Esta função sempre tem sucesso.

Adicionado na versão 3.14.

Py_hash_t PyObject_GenericHash(PyObject *obj)

Função de hash genérica que deve ser colocada no slot tp_hash de um objeto de tipo. Seu resultado depende apenas da identidade do objeto.

No CPython, é equivalente a Py_HashPointer().

Adicionado na versão 3.13.