Módulo google.appengine.api.yaml_builder

Resumo

Gerenciador de construtores de eventos PyYAML

Recebe eventos do listener YAML e os encaminha para um objeto de construtor. Dessa maneira, ele pode criar um objeto estruturado corretamente.

Índice

class google.appengine.api.yaml_builder.Buildersource

Bases: object

Interface para criar documentos e tipos com base em eventos YAML.

Implemente essa interface para criar um novo construtor. Os construtores são passados para o BuilderHandler e desempenham o papel de fábrica e montador para criar representações concretas de arquivos YAML.

AppendTo(subject, value)source

Anexe valor a uma representação de sequência.

A implementação é definida pela subclasse de Builder.

Parâmetros
  • subject: objeto que representa a sequência. Valor retornado de BuildSequence.

  • valor: valor a ser anexado ao assunto. Pode ser qualquer tipo de valor.

BuildDocument()source

Crie um novo documento.

O objeto criado por esse método se torna a entidade de nível superior que o gerenciador do construtor cria. O tipo real é determinado pela subclasse da classe Builder e pode ser basicamente qualquer tipo. Esse método é sempre chamado quando o analisador encontra o início de um novo documento.

Retorna

Nova instância de objeto que representa um documento concreto retornado para o usuário por meio de BuilderHandler.GetResults().

BuildMapping(top_value)source

Crie uma nova representação de mapeamento.

Chamado quando o evento StartMapping foi recebido. O tipo de objeto é determinado pela subclasse Builder.

Parâmetros

top_value: objeto que será o novo pai de mapeamentos. Será o objeto retornado da chamada anterior para BuildMapping ou BuildSequence.

Retorna

Instância do novo objeto que representa um tipo de mapeamento no modelo de destino.

BuildSequence(top_value)source

Crie uma nova representação de sequência.

Chamado quando o evento StartSequence foi recebido. O tipo de objeto é determinado pela subclasse Builder.

Parâmetros

top_value: objeto que será o novo pai de sequências. Será o objeto retornado da chamada anterior para BuildMapping ou BuildSequence.

Retorna

Instância de novo objeto que representa um tipo de sequência no modelo de destino.

EndMapping(top_value, mapping)source

Escopo de mapeamento criado anteriormente em um término.

Chamado quando o término de um bloco de mapeamento é encontrado. Útil para limpeza adicional ou término da validação de escopo.

Parâmetros
  • top_value: valor que é pai do mapeamento

  • mapping: mapeamento no término do escopo

EndSequence(top_value, sequence)source

Escopo de sequência criado anteriormente em um término.

Chamado quando o término de um bloco de sequência é encontrado. Útil para limpeza adicional ou término da validação de escopo.

Parâmetros
  • top_value: valor que é pai da sequência

  • sequence: sequência no término do escopo

InitializeDocument(document, value)source

Inicialize o documento com o valor de nível superior do documento.

Esse método é chamado quando o elemento do documento raiz é encontrado no nível superior de um documento YAML. Ele precisará ser chamado logo depois de BuildDocument.

Receber o valor None indica o documento vazio.

Parâmetros
  • document: documento criado em BuildDocument

  • value: valor escalar para inicialização do documento

MapTo(subject, key, value)source

Mapeie o valor com uma representação de mapeamento.

A implementação é definida pela subclasse de Builder.

Parâmetros
  • subject: objeto que representa o mapeamento. Valor retornado de BuildMapping.

  • key: chave usada a fim de mapear valor para assunto. Pode ser qualquer valor escalar.

  • value: valor mapeado para assunto. Pode ser qualquer tipo de valor.

class google.appengine.api.yaml_builder.BuilderHandler(builder)source

Bases: google.appengine.api.yaml_listener.EventHandler

Manipulador de eventos PyYAML usado para criar objetos.

Mantém informações de estado à medida que recebe eventos de análise. Dessa maneira, o aninhamento do objeto é mantido. Usa o objeto do construtor fornecido para criar e montar objetos conforme o andamento.

Ao receber eventos do analisador YAML, ele cria uma pilha de dados que representam tokens estruturais. À medida que o escopo de documentos, mapeamentos e sequências termina, esses pares de tokens e valores são exibidos na parte superior da pilha. Dessa maneira, o escopo original pode retomar o processamento.

Um caso especial é feito para o token _KEY. Ele representa um valor temporário que só ocorre dentro de mapeamentos. Ele é imediatamente removido da pilha quando o valor associado é encontrado no fluxo de análise. É necessário fazer isso porque o analisador YAML não combina informações de chave e valor em um único evento.

Alias(event, loader)source

Ainda não implementado.

Parâmetros

event: ignorado.

DocumentEnd(event, loader)source

Término do documento.

Parâmetros

event: ignorado.

DocumentStart(event, loader)source

Crie um novo documento.

Envia um novo documento para pilha.

Parâmetros

event: ignorado.

GetResults()source

Receba resultados do processamento de stream do documento.

Esse método poderá ser invocado depois da análise completa de todo o arquivo YAML para recuperar o conteúdo criado do arquivo YAML. Chamado depois de EndStream.

Retorna

Uma tupla de todos os objetos de documento que foram analisados com base no stream YAML.

Gera

InternalError caso a pilha do construtor não esteja vazia até o final da análise.

MappingEnd(event, loader)source

Fim do mapeamento

Parâmetros
  • event: ignorado

  • loader: ignorado

MappingStart(event, loader)source

Início do escopo do mapeamento.

Crie um mapeamento do construtor e processe-o no contexto do respectivo pai.

Parâmetros
  • event: MappingStartEvent gerado pelo carregador

  • loader: carregador que gerou o evento

Scalar(event, loader)source

Processe o valor escalar

Como os escalares são valores simples passados diretamente pelo analisador, processe como qualquer valor sem processamento adicional.

Naturalmente, os valores de chave serão processados de maneira especial. Um valor de chave é reconhecido quando o token superior é _TOKEN_MAPPING.

Parâmetros

event: evento que contém valor escalar.

SequenceEnd(event, loader)source

Término da sequência.

Parâmetros
  • event: ignorado

  • loader: ignorado

SequenceStart(event, loader)source

Início do escopo de sequência

Crie uma nova sequência com base no construtor e processe no contexto do pai dele.

Parâmetros
  • event: SequenceStartEvent gerado pelo carregador

  • loader: carregador que gerou o evento

StreamEnd(event, loader)source

Limpa estado interno do gerenciador após a análise

Parâmetros

event: ignorado.

StreamStart(event, loader)source

Inicializa estado interno do gerenciador

Parâmetros

event: ignorado.

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

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2