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

Resumo

Classe Context.

Conteúdo

class google.appengine.ext.ndb.context.Context(conn=None, auto_batcher_class=google.appengine.ext.ndb.context.AutoBatcher, config=None, parent_context=None)Fonte

Bases: object

allocate_ids(*args, **kwds)Fonte
call_on_commit(callback)Fonte

Chame um retorno de chamada mediante o commit bem-sucedido de uma transação.

O retorno de chamada é feito imediatamente, caso não esteja em uma transação.

Em uma transação, vários retornos de chamada podem ser registrados e serão chamados assim que a transação for confirmada na ordem em que foram registrados. Em caso de falha na transação, os retornos de chamada não serão chamados.

Caso gere uma exceção, o retorno de chamada surge normalmente. Isso significa que, se o retorno de chamada for feito imediatamente, qualquer exceção gerada também surgirá imediatamente. Se a chamada for adiada até o commit, os retornos de chamada restantes serão pulados, e a exceção surgirá pela chamada transaction(). No entanto, a transação já terá sido confirmada a essa altura.

clear_cache()Fonte

Apaga o cache na memória.

OBSERVAÇÃO: isso não afeta Memcache.

static default_cache_policy(key)Fonte

Política de cache padrão.

É deferida para _use_cache na classe Model.

Parâmetros

key: instância de Key

Retorna

Um booleano ou None.

static default_datastore_policy(key)Fonte

Política de armazenamento de dados padrão.

É deferida para _use_datastore na classe Model.

Parâmetros

key: instância de Key

Retorna

Um booleano ou None.

static default_memcache_policy(key)Fonte

Política de Memcache padrão.

É deferida para _use_memcache na classe Model.

Parâmetros

key: instância de Key

Retorna

Um booleano ou None.

static default_memcache_timeout_policy(key)Fonte

Política de tempo limite de Memcache padrão.

É deferida para _memcache_timeout na classe Model.

Parâmetros

key: instância de Key

Retorna

Tempo limite de Memcache a ser usado (inteiro) ou None.

delete(*args, **kwds)Fonte
flush(*args, **kwds)Fonte
get(*args, **kwds)Fonte

Retorna uma instância de Model, dada a chave de entidade.

Ele usará o cache de contexto se a política de cache da chave especificada estiver ativada.

Parâmetros
  • key: instância de Key

  • **ctx_options: opções de contexto

Retorna

Uma instância de Model caso a chave exista no armazenamento de dados. Caso contrário, None.

get_cache_policy()Fonte

Retorna a função de política de cache de contexto atual.

Retorna

Uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa ser armazenado em cache. Pode ser None.

get_datastore_policy()Fonte

Retorna a função de política de armazenamento de dados de contexto atual.

Retorna

Uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa usar o armazenamento de dados. Pode ser None.

get_indexes(*args, **kwds)Fonte
get_memcache_policy()Fonte

Retorna a função da política de Memcache atual.

Retorna

Uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa ser armazenado em cache. Pode ser None.

get_memcache_timeout_policy()Fonte

Retorna a função da política atual para o tempo limite de Memcache (expiração).

in_transaction()Fonte

Informa se uma transação está ativa no momento.

iter_query(*args, **kwds)Fonte
map_query(*args, **kwds)Fonte
memcache_add(key, value, time=0, namespace=None, deadline=None)Fonte
memcache_cas(key, value, time=0, namespace=None, deadline=None)Fonte
memcache_decr(key, delta=1, initial_value=None, namespace=None, deadline=None)Fonte
memcache_delete(key, seconds=0, namespace=None, deadline=None)Fonte
memcache_get(key, for_cas=False, namespace=None, use_cache=False, deadline=None)Fonte

Um wrapper de lote automático para memcache.get() ou .get_multi().

Parâmetros
  • key: chave a ser definida (precisa ser uma string e nenhum prefixo é aplicado)

  • for_cas: se True, a solicitação e o armazenamento de códigos CAS no Context

  • namespace: namespace opcional

  • deadline: prazo opcional para o RPC

Retorna

Uma Future (!) com um valor de retorno recuperado de Memcache ou None.

memcache_gets(key, namespace=None, use_cache=False, deadline=None)Fonte
memcache_incr(key, delta=1, initial_value=None, namespace=None, deadline=None)Fonte
memcache_replace(key, value, time=0, namespace=None, deadline=None)Fonte
memcache_set(key, value, time=0, namespace=None, use_cache=False, deadline=None)Fonte
put(*args, **kwds)Fonte
set_cache_policy(func)Fonte

Define a função da política de cache de contexto.

Parâmetros

func: uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa ser armazenado em cache. Pode ser None.

set_datastore_policy(func)Fonte

Define a função da política do armazenamento de dados de contexto.

Parâmetros

func: uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa usar o armazenamento de dados. Pode ser None.

set_memcache_policy(func)Fonte

Define a função da política de Memcache.

Parâmetros

func: uma função que aceita uma instância de Key como argumento e retorna um booleano indicando se ele precisa ser armazenado em cache. Pode ser None.

set_memcache_timeout_policy(func)Fonte

Define a função da política para tempo limite de Memcache (expiração).

Parâmetros

func: uma função que aceita uma instância de Key como argumento e retorna um inteiro indicando o tempo limite de Memcache pretendido. Pode ser None.

Caso a função retorne 0, isso implica o tempo limite padrão.

transaction(*args, **kwds)Fonte
urlfetch(*args, **kwds)Fonte
class google.appengine.ext.ndb.context.ContextOptionsFonte

Bases: google.appengine.datastore.datastore_rpc.Configuration

Opções de configuração que podem ser passadas com get/put/delete.

max_memcache_items

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

memcache_deadline

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

memcache_timeout

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

use_cache

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

use_datastore

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

use_memcache

Um descritor para uma opção de configuração.

Esta classe é usada para criar uma opção de configuração em uma classe que herda de BaseConfiguration. Uma função validadora decorada com esta classe será convertida em um descritor somente leitura, e BaseConfiguration implementará a lógica de construtor e mesclagem desta opção de configuração. Uma função validadora utiliza um único valor diferente de None para validar e gera uma exceção ou retorna esse valor (ou um valor equivalente). Um validador é chamado uma vez no momento da construção, mas somente se for especificado um valor diferente de None para a opção de configuração nos argumentos de palavra-chave do construtor.

class google.appengine.ext.ndb.context.TransactionOptionsFonte

Bases: google.appengine.ext.ndb.context.ContextOptions, google.appengine.datastore.datastore_rpc.TransactionOptions

Aceita opções de contexto e de transação.

class google.appengine.ext.ndb.context.AutoBatcher(todo_tasklet, limit)Fonte

Bases: object

Agrupa várias chamadas assíncronas caso elas compartilhem as mesmas opções de rpc.

Aqui está um exemplo para explicar o que esta classe faz.

Vida útil de uma chamada de API key.get_async(options): *) A chave recebe a instância de Context singleton e invoca Context.get. *) Context.get chama Context._get_batcher.add(key, options). Isso

retorna um "fut" futuro como o valor de retorno de key.get_async. Neste momento, key.get_async é retornado.

*) Quando mais do que o número "limite" de _get_batcher.add() foi chamado,

_get_batcher invoca self._todo_tasklet dele, Context._get_tasklet, com a lista de chaves vistas até aqui.

*) Context._get_tasklet aciona MultiRPC e o aguarda. *) Na conclusão de MultiRPC, Context._get_tasklet passa os resultados

para o respectivo "fut" de key.get_async.

*) Caso o usuário chame "fut".get_result() antes do número "limite" de add() ter sido chamado,

"fut".get_result() chamará eventloop.run1() repetidamente.

*) Depois do processamento de retornos de chamada imediatos, eventloop executará idlers.

AutoBatcher._on_idle é um idler.

*) _on_idle executará "todo_tasklet" antes que o lote fique cheio.

Dessa maneira, o mecanismo é todo_tasklet, que é uma tasklet proxy que pode combinar argumentos em lotes e passa resultados para futuros respectivos. Esta classe é basicamente um auxiliar que invoca todo_tasklet com os argumentos certos no momento certo.

action()Fonte
add(arg, options=None)Fonte

Adiciona um arg e recupera um futuro.

Parâmetros
  • arg: um argumento para _todo_tasklet

  • options: opções de rpc

Retorna

Uma instância de Future, representando o resultado da execução

_todo_tasklet sem lotes.

add_once(arg, options=None)Fonte
flush(*args, **kwds)Fonte
run_queue(options, todo)Fonte

Executa _todo_tasklet efetivamente.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2