Observação: o Python 2.7 chegou ao fim do suporte em 31 de janeiro de 2024. Os aplicativos Python 2.7 atuais continuarão a ser executados e a receber tráfego. No entanto, o App Engine pode bloquear a reimplantação de aplicativos que usam ambientes de execução após o término da data de suporte. Recomendamos que você migre para a versão compatível mais recente do Python.

Módulo google.appengine.ext.ndb.metadata

Resumo

Modelos e funções auxiliares para acessar metadados do armazenamento de dados do app.

Essas entidades não podem ser criadas por usuários. Elas são criadas como resultados de consultas ou recebimentos de metadados __namespace__, __kind__, __property__ e __entity_group__.

Uma API simplificada também é oferecida:

ndb.metadata.get_namespaces(): uma lista de nomes de namespace. ndb.metadata.get_kinds(): uma lista de nomes de tipo. ndb.metadata.get_properties_of_kind(kind):

Uma lista de nomes de propriedade do nome do tipo fornecido.

ndb.metadata.get_representations_of_kind(kind):: Um dict que mapeia nomes de propriedades para listas de códigos de representação.
ndb.metadata.get_entity_group_version(key):: A versão do grupo de entidades que contém a chave (apenas HRD).

get_kinds(), get_properties_of_kind(), get_representations_of_kind() são aplicados implicitamente ao namespace atual.

get_namespaces(), get_kinds(), get_properties_of_kind(), get_representations_of_kind() têm argumentos de início e fim opcionais para limitar a consulta a um intervalo de nomes, como start <= name < end.

Índice

class google.appengine.ext.ndb.metadata.Namespace(*args, **kwds)source

Bases: google.appengine.ext.ndb.metadata._BaseMetadata

Modelo para os resultados da consulta de metadados __namespace__.

EMPTY_NAMESPACE_ID = 1

KIND_NAME = '__namespace__'

classmethod key_for_namespace(namespace)source

Retorna a chave de um namespace.

Parâmetros

namespace: uma string que fornece o namespace com chave solicitada.

Retorna

A chave do namespace.

classmethod key_to_namespace(key)source

Retorna o namespace especificado por determinada chave de __namespace__.

Parâmetros

key: chave com o nome solicitado.

Retorna

O namespace especificado pela chave.

namespace_name: Retorna o nome do namespace especificado pela chave dessa entidade.

class google.appengine.ext.ndb.metadata.Kind(*args, **kwds)source

Bases: google.appengine.ext.ndb.metadata._BaseMetadata

Modelo para os resultados da consulta de metadados __kind__.

KIND_NAME = '__kind__'

classmethod key_for_kind(kind)source

Retorna a chave __kind__ do tipo.

Parâmetros

kind: tipo com a chave solicitada.

Retorna

A chave do tipo.

classmethod key_to_kind(key)source

Retorna o tipo especificado por determinada chave __kind__.

Parâmetros

key: chave com o nome solicitado.

Retorna

O tipo especificado pela chave.

kind_name: Retorna o nome do tipo especificado pela chave dessa entidade.

class google.appengine.ext.ndb.metadata.Property(*args, **kwds)source

Bases: google.appengine.ext.ndb.metadata._BaseMetadata

Modelo para resultados da consulta de metadados __property__.

KIND_NAME = '__property__'

classmethod key_for_kind(kind)source

Retorna a chave __property__ de kind.

Parâmetros

kind: tipo com a chave solicitada.

Retorna

A chave pai das chaves __property__ de tipo.

classmethod key_for_property(kind, property)source

Retorna a chave __property__ da propriedade do tipo.

Parâmetros

kind: tipo com a chave solicitada.
property: propriedade com a chave solicitada.

Retorna

A chave da propriedade do tipo.

classmethod key_to_kind(key)source

Retorna o tipo especificado por determinada chave __property__.

Parâmetros

key: chave com o nome do tipo solicitado.

Retorna

O tipo especificado pela chave.

classmethod key_to_property(key)source

Retorna a propriedade especificada por determinada chave __property__.

Parâmetros

key: chave com o nome da propriedade solicitado.

Retorna

a propriedade especificada pela chave ou None se a chave especificou apenas um tipo.

kind_name: Retorna o nome do tipo especificado pela chave dessa entidade.

property_name: Retorna o nome da propriedade especificado pela chave desta entidade.

property_representation: Uma propriedade indexada com o valor que é uma string de texto de comprimento limitado.

class google.appengine.ext.ndb.metadata.EntityGroup(*args, **kwds)source

Bases: google.appengine.ext.ndb.metadata._BaseMetadata

Modelo para metadados __entity_group__ (disponível apenas no armazenamento de dados HR).

Esses metadados contêm uma propriedade __version__ numérica que garante o aumento em cada mudança no grupo de entidades. A versão pode aumentar mesmo na ausência de alterações visíveis ao usuário no grupo de entidades. A entidade __entity_group__ poderá não existir se o grupo de entidades nunca tiver sido gravado.

ID = 1

KIND_NAME = '__entity_group__'

classmethod key_for_entity_group(key)source

Retorna a chave que contém o grupo de entidades.

Parâmetros

key: uma chave de um grupo de entidades com __entity_group__ que você quer.

Retorna

A chave __entity_group__ do grupo de entidades que contém a chave.

version: Uma propriedade com o valor que é um inteiro ou longo (ou booleano) do Python.

google.appengine.ext.ndb.metadata.get_namespaces(start=None, end=None)Fonte

Retorna todos os namespaces no intervalo especificado.

Parâmetros

start: retorna apenas os namespaces >= start, se start não for None.
end: retorna apenas os namespaces < end, se end não for None.

Retorna

Uma lista de nomes de namespaces entre os valores inicial e final (opcionais).

google.appengine.ext.ndb.metadata.get_kinds(start=None, end=None)Fonte

Retorna todos os tipos no intervalo especificado, do namespace atual.

Parâmetros

start: retorna apenas os tipos >= start, se start não for None.
end: retorna apenas os tipos < end, se end não for None.

Retorna

Uma lista de nomes de tipos entre os valores inicial e final (opcionais).

google.appengine.ext.ndb.metadata.get_properties_of_kind(kind, start=None, end=None)Fonte

Retorna todas as propriedades do tipo no intervalo especificado.

OBSERVAÇÃO: essa função não retorna propriedades não indexadas.

Parâmetros

kind: nome do tipo com as propriedades que você quer.
start: retorna apenas propriedades >= start, se start não for None.
end: retorna apenas propriedades < end, se end não for None.

Retorna

Uma lista de nomes de propriedades de tipo entre os valores inicial e final (opcional).

google.appengine.ext.ndb.metadata.get_representations_of_kind(kind, start=None, end=None)Fonte

Retorna todas as representações de propriedades do tipo no intervalo especificado.

OBSERVAÇÃO: essa função não retorna propriedades não indexadas.

Parâmetros

kind: nome do tipo com as propriedades que você quer.
start: retorna apenas propriedades >= start, se start não for None.
end: retorna apenas propriedades < end, se end não for None.

Retorna

Um dicionário que mapeia nomes de propriedades para a respectiva lista de representações.

google.appengine.ext.ndb.metadata.get_entity_group_version(key)Fonte

Retorna a versão do grupo de entidades que contém a chave.

Parâmetros

key: uma chave de um grupo de entidades com __entity_group__ que você quer.

Retorna

A versão do grupo de entidades que contém a chave. Essa versão certamente aumenta a cada alteração feita no grupo de entidades. A versão pode aumentar mesmo na ausência de alterações visíveis ao usuário no grupo de entidades. Poderá retornar None se o grupo de entidades jamais tiver sido gravado.

Em armazenamentos de dados não HR, essa função retorna None.