Módulo google.appengine.api.yaml_object

Resumo

Construtor para mapear documentos YAML a instâncias de objetos.

O ObjectBuilder é responsável por mapear um documento YAML para classes definidas usando o mecanismo de validação (consulte google.appengine.api.validation.py).

Índice

google.appengine.api.yaml_object.BuildObjects(default_class, stream, loader=yaml.loader.SafeLoader)source

Constrói objetos a partir do fluxo de dados.

Lida com o caso básico de carregar todos os objetos de um fluxo de dados.

Parâmetros
  • default_class: classe instanciada após a detecção de um novo documento. Uma instância dessa classe funcionará como o próprio documento.

  • stream: documento de string ou objeto de arquivo aberto a ser processado de acordo com o método yaml.parse. Qualquer objeto que implemente um método "read ()" que retorne um documento de string funcionará com o analisador YAML.

  • loader_class: usado para injeção de dependências.

Retorna

Lista de instâncias default_class analisadas a partir do fluxo de dados.

google.appengine.api.yaml_object.BuildSingleObject(default_class, stream, loader=yaml.loader.SafeLoader)source

Constrói um objeto a partir do fluxo de dados.

Lida com o caso básico de carregar um único objeto de um fluxo de dados.

Parâmetros
  • default_class: classe instanciada após a detecção de um novo documento. Uma instância dessa classe funcionará como o próprio documento.

  • stream: documento de string ou objeto de arquivo aberto a ser processado de acordo com o método yaml.parse. Qualquer objeto que implemente um método "read ()" que retorne um documento de string funcionará com o analisador YAML.

  • loader_class: usado para injeção de dependências.

class google.appengine.api.yaml_object.ObjectBuilder(default_class)source

Bases: google.appengine.api.yaml_builder.Builder

Construtor usado para criar objetos validados.

Com uma classe determinada que implementa validation.ValidatedBase, ele analisará um documento YAML e tentará construir uma instância da classe. O ObjectBuilder mapeará apenas campos YAML que são aceitos pela função GetValidator do ValidatedBase. As listas são mapeadas como atributos validated. Repeated, e os mapas são mapeados como propriedades validated.Type.

Para que um mapa YAML seja compatível com uma classe, ela precisa ter um construtor que possa ser chamado sem parâmetros. Se o tipo fornecido não tiver um construtor assim, ocorrerá um erro de tempo de análise.

AppendTo(subject, value)source

Anexa um valor a uma sequência.

Parâmetros
  • subject: _ObjectSequence que recebe um novo valor.

  • value: o valor anexado à sequência.

BuildDocument()source

Instancia o novo objeto validado pela raiz.

Retorna

Nova instância do objeto validado.

BuildMapping(top_value)source

Nova instância do mapeador de objetos do escopo do mapa de abertura.

Parâmetros

top_value: pai do objeto aninhado.

Retorna

Nova instância do mapeador de objetos.

BuildSequence(top_value)source

Nova instância da sequência de objetos.

Parâmetros

top_value: objeto que contém a nova sequência.

Retorna

Uma nova instância de _ObjectSequencer.

EndMapping(top_value, mapping)source

Ao sair do escopo, garante que o novo objeto seja inicializado.

Esse método é usado principalmente para identificar atributos necessários ausentes.

Parâmetros
  • top_value: pai do objeto de mapeamento de fechamento

  • mapping: instância _ObjectMapper que está deixando o escopo

MapTo(subject, key, value)source

Mapeia o par de chave-valor de um atributo de objetos.

Parâmetros
  • subject: _ObjectMapper do objeto que receberá o novo atributo

  • key: chave do atributo

  • value: valor do novo atributo

Cria
  • UnexpectedAttribute quando a chave não é um atributo validado

  • a classe de valor do assunto

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

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2