Módulo google.appengine.api.appinfo

Resumo

Ferramentas AppInfo.

Essa biblioteca permite que você trabalhe com registros AppInfo na memória, além de armazená-los e carregá-los de arquivos de configuração.

Conteúdo

class google.appengine.api.appinfo.AdminConsole(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as diretivas de um console administrativo nas informações do aplicativo.

ATRIBUTOS = {'pages': <google.appengine.api.validation.Optional object>}
classmethod Merge(adminconsole_one, adminconsole_two)source

Retorna o resultado da mesclagem de dois objetos AdminConsole.

class google.appengine.api.appinfo.AdminConsolePage(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a página do console administrativo em um objeto AdminConsole.

ATRIBUTOS = {'url': '(?!\\^)/.*|\\..*|(\\(.).*(?!\\$).', 'name': '^.+$'}
class google.appengine.api.appinfo.ApiConfigHandler(**attributes)source

Bases: google.appengine.api.appinfo.HandlerBase

Classe que representa as diretivas do gerenciador da api_config nas informações do aplicativo.

ATRIBUTOS = {'secure': <google.appengine.api.validation.Options object>, 'script': <google.appengine.api.validation.Regex object>, 'url': <google.appengine.api.validation.Regex object>, 'login': <google.appengine.api.validation.Options object>, 'auth_fail_action': <google.appengine.api.validation.Options object>}
class google.appengine.api.appinfo.AppInclude(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa o conteúdo de um arquivo app.yaml incluído.

Essa classe é usada para ambas as diretivas builtins e includes.

ATRIBUTOS = {'beta_settings': <google.appengine.api.validation.Optional object>, 'builtins': <google.appengine.api.validation.Optional object>, 'vm_settings': <google.appengine.api.validation.Optional object>, 'admin_console': <google.appengine.api.validation.Optional object>, 'handlers': <google.appengine.api.validation.Optional object>, 'manual_scaling': <google.appengine.api.validation.Optional object>, 'skip_files': <google.appengine.api.validation.RegexStr object>, 'vm': <google.appengine.api.validation.Optional object>, 'env_variables': <google.appengine.api.validation.Optional object>, 'includes': <google.appengine.api.validation.Optional object>}
classmethod MergeAppIncludes(appinclude_one, appinclude_two)source

Mescla o estado não referencial do AppInclude fornecido.

Ou seja, as diretivas includes e builtins não são preservadas, mas todos os objetos estáticos são copiados em um objeto AppInclude agregado que preserva as diretivas dos dois objetos AppInclude fornecidos.

appinclude_one é atualizado para ser o resultado mesclado nesse processo.

Parâmetros
  • appinclude_one: primeiro AppInclude para mesclar.

  • appinclude_two: segundo AppInclude para mesclar.

Retorna

Objeto AppInclude que é o resultado da mesclagem das diretivas estáticas de appinclude_one e appinclude_two. Uma versão atualizada do appinclude_one é retornada.

classmethod MergeAppYamlAppInclude(appyaml, appinclude)source

Mescla um arquivo app.yaml com os builtins/includes referenciados.

Parâmetros
  • appyaml: o arquivo app.yaml que você quer atualizar com o appinclude.

  • appinclude: os includes que você quer mesclar com appyaml.

Retorna

Um arquivo atualizado app.yaml que inclui as diretivas especificadas em appinclude.

classmethod MergeManualScaling(appinclude_one, appinclude_two)source

Extrai a maior das <manual_scaling.instances> dos argumentos.

appinclude_one é transformado para ser o resultado mesclado nesse processo.

Além disso, essa função precisará ser atualizada se ManualScaling receber mais campos.

Parâmetros
  • appinclude_one: o primeiro objeto a ser mesclado. O objeto precisa ter um campo manual_scaling que contenha um ManualScaling().

  • appinclude_two: o segundo objeto a ser mesclado. O objeto precisa ter um campo manual_scaling que contenha um ManualScaling().

Retorna

Um objeto que é o resultado da mesclagem de appinclude_one.manual_scaling.instances e appinclude_two.manual_scaling.instances. Ele é retornado como um objeto appinclude_one revisado após as mutações serem concluídas.

static MergeSkipFiles(skip_files_one, skip_files_two)source

Mescla duas diretivas skip_files.

Parâmetros
  • skip_files_one: o primeiro elemento skip_files que você quer mesclar.

  • skip_files_two: o segundo elemento skip_files que você quer mesclar.

Retorna

Uma lista de expressões regulares que estão mescladas.

class google.appengine.api.appinfo.AppInfoExternal(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as informações de aplicativo dos usuários.

Essa classe é passada para um construtor yaml_object a fim de fornecer a validação para o analisador de formato do arquivo de informações do aplicativo.

application

Identificador exclusivo para o aplicativo.

version

Versão principal do aplicativo.

runtime

Tempo de execução usado pelo aplicativo.

api_version

Que versão das APIs será usada.

source_language

Especificação opcional do idioma de origem. Por exemplo, você poderá especificar php-quercus se este for um aplicativo Java gerado da origem PHP usando Quercus.

handlers

Lista de gerenciadores de URLs.

default_expiration

Delta de tempo padrão a ser usado para expiração de cache para todos os arquivos estáticos, a menos que eles tenham uma expiration específica definida. Consulte a documentação do campo URLMap.expiration para mais informações.

skip_files

Um objeto de expressão regular. Os arquivos que correspondem a essa expressão regular não serão enviados por appcfg.py. Por exemplo:

skip_files: |
  .svn.*|
  #.*#
nobuild_files

Um objeto de expressão regular. Os arquivos que correspondem a essa expressão regular não serão incorporados ao aplicativo. Esta diretiva é válida apenas para o Go.

api_config

Raiz e script de URL ou caminho de servlet para veiculação de API aprimorada.

ATRIBUTOS = {'manual_scaling': <google.appengine.api.validation.Optional object>, 'env_variables': <google.appengine.api.validation.Optional object>, 'inbound_services': <google.appengine.api.validation.Optional object>, 'builtins': <google.appengine.api.validation.Optional object>, 'service': <google.appengine.api.validation.Preferred object>, 'runtime_channel': <google.appengine.api.validation.Optional object>, 'instance_class': <google.appengine.api.validation.Optional object>, 'vm_health_check': <google.appengine.api.validation.Optional object>, 'backends': <google.appengine.api.validation.Optional object>, 'resources': <google.appengine.api.validation.Optional object>, 'basic_scaling': <google.appengine.api.validation.Optional object>, 'admin_console': <google.appengine.api.validation.Optional object>, 'liveness_check': <google.appengine.api.validation.Optional object>, 'auto_id_policy': <google.appengine.api.validation.Optional object>, 'standard_websocket': <google.appengine.api.validation.Optional object>, 'vm_settings': <google.appengine.api.validation.Optional object>, 'default_expiration': <google.appengine.api.validation.Optional object>, 'project': <google.appengine.api.validation.Optional object>, 'code_lock': <google.appengine.api.validation.Optional object>, 'automatic_scaling': <google.appengine.api.validation.Optional object>, 'source_language': <google.appengine.api.validation.Optional object>, 'vm': <google.appengine.api.validation.Optional object>, 'module': <google.appengine.api.validation.Deprecated object>, 'zones': <google.appengine.api.validation.Optional object>, 'endpoints_api_service': <google.appengine.api.validation.Optional object>, 'beta_settings': <google.appengine.api.validation.Optional object>, 'threadsafe': <google.appengine.api.validation.Optional object>, 'skip_files': <google.appengine.api.validation.RegexStr object>, 'libraries': <google.appengine.api.validation.Optional object>, 'application': <google.appengine.api.validation.Optional object>, 'readiness_check': <google.appengine.api.validation.Optional object>, 'version': <google.appengine.api.validation.Optional object>, 'entrypoint': <google.appengine.api.validation.Optional object>, 'env': <google.appengine.api.validation.Optional object>, 'api_version': <google.appengine.api.validation.Optional object>, 'health_check': <google.appengine.api.validation.Optional object>, 'includes': <google.appengine.api.validation.Optional object>, 'derived_file_type': <google.appengine.api.validation.Optional object>, 'network': <google.appengine.api.validation.Optional object>, 'error_handlers': <google.appengine.api.validation.Optional object>, 'handlers': <google.appengine.api.validation.Optional object>, 'runtime_config': <google.appengine.api.validation.Optional object>, 'nobuild_files': <google.appengine.api.validation.RegexStr object>, 'runtime': <google.appengine.api.validation.Optional object>, 'api_config': <google.appengine.api.validation.Optional object>}
ApplyBackendSettings(backend_name)source

Aplica as configurações do back-end indicado ao AppInfoExternal.

As entradas de back-end podem conter diretivas que modificam outras partes do arquivo app.yaml, como a diretiva start, que adiciona um gerenciador à solicitação inicial. Este método executa essas modificações.

Parâmetros

backend_name: o nome de um back-end definido na diretiva backends.

Gera
  • BackendNotFound: se o back-end indicado não foi listado na diretiva backends.

  • DuplicateBackend: se o back-end for encontrado mais de uma vez na diretiva backends.

CheckInitialized()source

Executa a validação baseada em expressão não regular.

Os seguintes itens são verificados:
  • Pelo menos um mapeamento de URL é fornecido nos mapeadores de URL.

  • O número de mapeadores de URL não excede MAX_URL_MAPS.

  • A versão principal não contém a string -dot-.

  • Se os api_endpoints estiverem definidos, uma estrofe api_config precisará ser definida.

  • Se runtime é python27 e threadsafe está definido, nenhum gerenciador CGI pode ser usado.

  • O nome da versão não começa com BUILTIN_NAME_PREFIX.

  • Se redirect_http_response_code existe, ele está na lista de 300s válidos.

  • Módulo e serviço não estão definidos. Os serviços antes eram conhecidos como módulos.

Gera
  • DuplicateLibrary: se library_name foi especificado mais de uma vez.

  • MissingURLMapping: se nenhum objeto URLMap está presente no objeto.

  • TooManyURLMappings: se há muitas entradas URLMap.

  • MissingApiConfig: se api_endpoints existe sem um api_config.

  • MissingThreadsafe: se threadsafe não foi definido, mas o tempo de execução exige isso.

  • ThreadsafeWithCgiHandler: se runtime é python27, threadsafe foi definido e os gerenciadores CGI foram especificados.

  • TooManyScalingSettingsError: se mais de um bloco de configurações de escalonamento está presente.

  • RuntimeDoesNotSupportLibraries: se a cláusula libraries é usada para um tempo de execução incompatível, como python25.

GetAllLibraries()source

Retorna uma lista de todas as instâncias de Library ativas para esta configuração.

Retorna

A lista de instâncias de Library ativas para esta configuração. Isso inclui bibliotecas diretamente especificadas e quaisquer dependências necessárias.

GetEffectiveRuntime()source

Retorna o tempo de execução do aplicativo, resolvendo as VMs para o vm_runtime subjacente.

Retorna

O valor de beta/vm_settings.vm_runtime se runtime é vm, caso contrário runtime.

Tipo de retorno

O tempo de execução efetivo

GetNormalizedLibraries()source

Retorna uma lista de instâncias de Library normalizadas para esta configuração.

Retorna

A lista de instâncias de Library ativas para esta configuração. Isso inclui bibliotecas especificadas diretamente, as dependências necessárias e quaisquer bibliotecas ativadas por padrão. Qualquer biblioteca com a versão latest será substituída pela versão mais recente disponível.

IsVm()source
NormalizeVmSettings()source

Normaliza as configurações da VM.

SetEffectiveRuntime(runtime)source

Define o tempo de execução, respeitando as regras de tempos de execução de VMs para configurações de tempo de execução.

Parâmetros

runtime: o tempo de execução a ser usado.

class google.appengine.api.appinfo.AppInfoSummary(**attributes)source

Bases: google.appengine.api.validation.Validated

Esta classe contém apenas informações básicas resumidas sobre um aplicativo.

Esta classe é usada para passar informações sobre o aplicativo recém-criado aos usuários depois que uma nova versão foi criada.

ATRIBUTOS = {'application': '(?:[a-z\\d\\-]{1,100}\\~)?(?:(?!\\-)[a-z\\d\\-\\.]{1,100}:)?(?!-)[a-z\\d\\-]{0,99}[a-z\\d]', 'major_version': '^(?!-)[a-z\\d\\-]{0,62}[a-z\\d]$', 'minor_version': <google.appengine.api.validation.Type object>}
class google.appengine.api.appinfo.AutomaticScaling(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as configurações de escalonamento automático em AppInfoExternal.

ATRIBUTOS = {'target_concurrent_requests': <google.appengine.api.validation.Optional object>, 'target_disk_write_ops_per_sec': <google.appengine.api.validation.Optional object>, 'target_disk_read_bytes_per_sec': <google.appengine.api.validation.Optional object>, 'max_pending_latency': <google.appengine.api.validation.Optional object>, 'min_num_instances': <google.appengine.api.validation.Optional object>, 'target_disk_read_ops_per_sec': <google.appengine.api.validation.Optional object>, 'target_network_sent_bytes_per_sec': <google.appengine.api.validation.Optional object>, 'cool_down_period_sec': <google.appengine.api.validation.Optional object>, 'target_cpu_utilization': <google.appengine.api.validation.Optional object>, 'target_network_received_bytes_per_sec': <google.appengine.api.validation.Optional object>, 'target_network_received_packets_per_sec': <google.appengine.api.validation.Optional object>, 'target_request_count_per_sec': <google.appengine.api.validation.Optional object>, 'cpu_utilization': <google.appengine.api.validation.Optional object>, 'max_num_instances': <google.appengine.api.validation.Optional object>, 'min_pending_latency': <google.appengine.api.validation.Optional object>, 'min_idle_instances': <google.appengine.api.validation.Optional object>, 'max_idle_instances': <google.appengine.api.validation.Optional object>, 'target_disk_write_bytes_per_sec': <google.appengine.api.validation.Optional object>, 'max_instances': <google.appengine.api.validation.Optional object>, 'target_throughput_utilization': <google.appengine.api.validation.Optional object>, 'max_concurrent_requests': <google.appengine.api.validation.Optional object>, 'min_instances': <google.appengine.api.validation.Optional object>, 'target_network_sent_packets_per_sec': <google.appengine.api.validation.Optional object>, 'custom_metrics': <google.appengine.api.validation.Optional object>}
class google.appengine.api.appinfo.BasicScaling(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as configurações básicas de escalonamento em AppInfoExternal.

ATRIBUTOS = {'idle_timeout': <google.appengine.api.validation.Optional object>, 'max_instances': <google.appengine.api.validation.Regex object>}
class google.appengine.api.appinfo.BetaSettings(**kwds)source

Bases: google.appengine.api.appinfo.VmSettings

Classe para configurações Beta (internas ou não lançadas).

Esta classe destina-se a substituir VmSettings futuramente.

Essas configurações não são mais validadas aqui. As configurações são validadas no lado do servidor.

classmethod Merge(beta_settings_one, beta_settings_two)source

Mescla duas instâncias de BetaSettings.

Parâmetros
  • beta_settings_one: a primeira ocorrência de BetaSettings ou None.

  • beta_settings_two: a segunda ocorrência de BetaSettings ou None.

Retorna

A instância de BetaSettings mesclada, ou None se as duas instâncias de entrada forem None ou vazias.

class google.appengine.api.appinfo.BuiltinHandler(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as diretivas do gerenciador interno nas informações do aplicativo.

Esta classe permite chaves arbitrárias, mas seus valores precisam ser descritos pelo objeto validation.Options retornado por ATTRIBUTES.

ATRIBUTOS = {}
class DynamicAttributes(return_value, **parameters)source

Bases: dict

Fornece um objeto de dicionário que sempre declara ter uma chave.

Esse dicionário retorna um valor fixo para qualquer operação get. O valor fixo que você passa como um parâmetro de construtor deve ser um objeto validation.Validated.

GetUnnormalized(key)source
classmethod IsDefined(builtins_list, builtin_name)source

Descobre se um builtin está definido em determinada lista de objetos gerenciadores incorporados.

Parâmetros
  • builtins_list: uma lista de objetos BuiltinHandler, normalmente yaml.builtins.

  • builtin_name: o nome do built-in que você quer determinar se está definido.

Retorna

True se builtin_name for definido por um membro de builtins_list. Todos os outros resultados retornam False.

classmethod ListToTuples(builtins_list)source

Converte uma lista de objetos BuiltinHandler.

Parâmetros

builtins_list: uma lista de objetos BuildinHandler para converter em tuplas.

Retorna

Uma lista de (name, status) derivada dos objetos BuiltinHandler.

ToDict()source

Converte um objeto BuiltinHander em um dicionário.

Retorna

on/off}` form

Tipo de retorno

Um dicionário em `{builtin_handler_name

classmethod Validate(builtins_list, runtime=None)source

Verifica se todos os objetos BuiltinHandler são válidos e não repetidos.

Parâmetros
  • builtins_list: uma lista de objetos BuiltinHandler para validar.

  • runtime: se você especificar esse argumento, os avisos serão gerados para os built-ins que foram reprovados no tempo de execução determinado.

Gera
  • InvalidBuiltinFormat: se o nome de um objeto BuiltinHandler não puder ser determinado.

  • DuplicateBuiltinsSpecified: se um nome BuiltinHandler for usado mais de uma vez na lista.

class google.appengine.api.appinfo.CpuUtilization(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração da utilização da CPU da VM.

ATRIBUTOS = {'target_utilization': <google.appengine.api.validation.Optional object>, 'aggregation_window_length_sec': <google.appengine.api.validation.Optional object>}
class google.appengine.api.appinfo.CustomMetric(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa CustomMetrics em AppInfoExternal.

ATRIBUTOS = {'target_utilization': <google.appengine.api.validation.Objeto opcional>, 'filter': <google.appengine.api.validation.Objeto opcional>, 'single_instance_assignment': <google.appengine.api.validation.Objeto opcional>, 'metric_name': <google.appengine.api.validation.Objeto Regex>, 'target_type': <google.appengine.api.validation.Regex object>}
CheckInitialized()source

Determina se CustomMetric é inválido.

Gera
  • appinfo_errors.TooManyAutoscalingUtilizationTargetsError: se muitos

  • destinos de escalonamento estão definidos

  • appinfo_errors.NotEnoughAutoscalingUtilizationTargetsError: se nenhum destino

  • de escalonamento está definido

class google.appengine.api.appinfo.EndpointsApiService(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa EndpointsApiService em AppInfoExternal.

ATRIBUTOS = {'config_id': <google.appengine.api.validation.Optional object>, 'name': <google.appengine.api.validation.Regex object>, 'rollout_strategy': <google.appengine.api.validation.Optional object>}
CheckInitialized()source

Determina se o serviço da Endpoints API é inválido.

Gera
  • appinfo_errors.MissingEndpointsConfigId: se o código de configuração estiver ausente quando a estratégia de distribuição não for especificada ou for definida como "fixa".

  • appinfo_errors.UnexpectedEndpointsConfigId: se o código de configuração for definido quando a estratégia de distribuição for "gerenciada".

class google.appengine.api.appinfo.EnvironmentVariables(**kwds)Fonte

Bases: google.appengine.api.validation.ValidatedDict

Classe que representa um mapeamento de pares de chave-valor de variável de ambiente.

KEY_VALIDATOR = <google.appengine.api.validation.Regex object>
classmethod Merge(env_variables_one, env_variables_two)source

Mescla duas instâncias de EnvironmentVariables.

Se uma variável é especificada por ambas as instâncias, o valor de env_variables_two é usado.

Parâmetros
  • env_variables_one: a primeira ocorrência de EnvironmentVariables ou None.

  • env_variables_two: a segunda ocorrência de EnvironmentVariables ou None.

Retorna

A ocorrência de EnvironmentVariables mesclada, ou None se as duas instâncias de entrada forem None ou vazias.

VALUE_VALIDATOR

alias de str

class google.appengine.api.appinfo.ErrorHandlers(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as diretivas do gerenciador de erros nas informações do aplicativo.

ATRIBUTOS = {'error_code': <google.appengine.api.validation.Optional object>, 'mime_type': <google.appengine.api.validation.Optional object>, 'file': '.+'}
google.appengine.api.appinfo.GetAllRuntimes()source

Retorna a lista de todos os tempos de execução válidos.

Essa lista pode incluir tempos de execução de terceiros e tempos de execução automáticos.

Retorna

Tupla de strings.

class google.appengine.api.appinfo.HandlerBase(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe base para URLMap e ApiConfigHandler.

ATRIBUTOS = {'secure': <google.appengine.api.validation.Options object>, 'script': <google.appengine.api.validation.Regex object>, 'url': <google.appengine.api.validation.Regex object>, 'login': <google.appengine.api.validation.Options object>, 'auth_fail_action': <google.appengine.api.validation.Options object>}
class google.appengine.api.appinfo.HealthCheck(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração da verificação de integridade.

ATRIBUTOS = {'check_interval_sec': <google.appengine.api.validation.Optional object>, 'timeout_sec': <google.appengine.api.validation.Optional object>, 'healthy_threshold': <google.appengine.api.validation.Optional object>, 'enable_health_check': <google.appengine.api.validation.Optional object>, 'unhealthy_threshold': <google.appengine.api.validation.Optional object>, 'host': <google.appengine.api.validation.Optional object>, 'restart_threshold': <google.appengine.api.validation.Optional object>}
class google.appengine.api.appinfo.HttpHeadersDict(**kwds)source

Bases: google.appengine.api.validation.ValidatedDict

Um dicionário que limita chaves e valores ao que http_headers permite.

http_headers é uma chave de gerenciador estática. Ela se aplica a gerenciadores com as chaves static_dir ou static_files. O código a seguir é um exemplo de como http_headers é usado:

handlers:
- url: /static
  static_dir: static
  http_headers:
    X-Foo-Header: foo value
    X-Bar-Header: bar value
DISALLOWED_HEADERS = frozenset(['date', 'content-length', 'server', 'content-encoding'])
Get(header_name)source

Extrai um valor de cabeçalho.

Parâmetros

header_name: nome do cabeçalho HTTP a ser pesquisado.

Retorna

Um valor de cabeçalho que corresponde a header_name. Se mais de um desses valores estiver em self, um dos valores será selecionado arbitrariamente e retornado. A seleção não é determinista.

KEY_VALIDATOR = <google.appengine.api.appinfo.KeyValidator object>
class KeyValidator(default=None)source

Bases: google.appengine.api.validation.Validator

Garante que as chaves em HttpHeadersDict sejam válidas.

HttpHeadersDict contém uma lista de cabeçalhos. Uma instância é usada como KEY_VALIDATOR de HttpHeadersDict.

Validate(name, unused_key=None)source

Retorna um argumento ou cria uma exceção se o argumento for inválido.

Os nomes dos cabeçalhos HTTP são definidos pela RFC 2616, seção 4.2.

Parâmetros
  • name: valor do campo do cabeçalho HTTP.

  • unused_key: não usado.

Retorna

argumento "name", inalterado.

Gera

appinfo_errors.InvalidHttpHeaderName: um argumento não pode ser usado como um nome de cabeçalho HTTP.

MAX_HEADER_LENGTH = 500
MAX_HEADER_VALUE_LENGTHS = {'set-cookie2': 4096, 'content-security-policy': 10240, 'set-cookie': 4096, 'content-security-policy-report-only': 10240, 'location': 2047, 'x-content-security-policy': 10240, 'x-webkit-csp': 10240}
MAX_LEN = 500
VALUE_VALIDATOR = <google.appengine.api.appinfo.ValueValidator object>
class ValueValidator(default=None)source

Bases: google.appengine.api.validation.Validator

Garante que os valores em HttpHeadersDict sejam válidos.

Uma instância é usada como VALUE_VALIDATOR de HttpHeadersDict.

static AssertHeaderNotTooLong(name, value)source
Validate(value, key=None)source

Retorna um valor ou gera uma exceção se o valor for inválido.

De acordo com a RFC 2616 seção 4.2, os valores do campo de cabeçalho precisam conter "*TEXT ou combinações de token, separadores e string entre aspas":

TEXT = <any OCTET except CTLs, but including LWS>
Parâmetros
  • value: valor do campo de cabeçalho HTTP.

  • key: nome do campo de cabeçalho HTTP.

Retorna

Um argumento "value".

Gera

appinfo_errors.InvalidHttpHeaderValue: um argumento não pode ser usado como um valor de cabeçalho HTTP.

class google.appengine.api.appinfo.Library(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração de uma única biblioteca.

ATRIBUTOS = {'version': <google.appengine.api.validation.Type object>, 'name': <google.appengine.api.validation.Type object>}
CheckInitialized()source

Determina se a configuração da biblioteca não é válida.

Gera
  • appinfo_errors.InvalidLibraryName: se a biblioteca especificada for incompatível.

  • appinfo_errors.InvalidLibraryVersion: se a versão da biblioteca especificada for incompatível.

class google.appengine.api.appinfo.LivenessCheck(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração de verificação de atividade.

ATRIBUTOS = {'check_interval_sec': <google.appengine.api.validation.Optional object>, 'timeout_sec': <google.appengine.api.validation.Optional object>, 'host': <google.appengine.api.validation.Optional object>, 'failure_threshold': <google.appengine.api.validation.Optional object>, 'path': <google.appengine.api.validation.Optional object>, 'initial_delay_sec': <google.appengine.api.validation.Optional object>, 'success_threshold': <google.appengine.api.validation.Optional object>}
google.appengine.api.appinfo.LoadAppInclude(app_include)source

Carrega um único objeto AppInclude em que um, e apenas um, é esperado.

Parâmetros

app_include: um objeto ou string semelhante a um arquivo. O argumento é definido como uma string, o argumento é analisado como um arquivo de configuração. Se o argumento estiver definido como um objeto semelhante a arquivo, os dados serão lidos e analisados.

Retorna

Uma instância do AppInclude como carregada de um arquivo YAML.

Gera
  • EmptyConfigurationFile: se não houver documentos no arquivo YAML.

  • MultipleConfigurationFile: se houver mais de um documento no arquivo YAML.

google.appengine.api.appinfo.LoadSingleAppInfo(app_info)source

Carrega um único objeto AppInfo em que um, e apenas um, é esperado.

Esse método valida se os valores no AppInfo correspondem aos validadores definidos nesse arquivo, em particular, AppInfoExternal.ATTRIBUTES.

Parâmetros

app_info: um objeto ou string semelhante a um arquivo. Se o argumento for uma string, ele será analisado como um arquivo de configuração. Se o argumento for um objeto semelhante a um arquivo, os dados serão lidos e, em seguida, analisados.

Retorna

Uma instância do AppInfoExternal como carregada de um arquivo YAML.

Gera
  • ValueError: se um serviço especificado não for válido.

  • EmptyConfigurationFile: se não houver documentos no arquivo YAML.

  • MultipleConfigurationFile: se mais de um documento existir no arquivo YAML.

  • DuplicateBackend: se um back-end for encontrado mais de uma vez na diretiva backends.

  • yaml_errors.EventError: se houver falha na validação do arquivo app.yaml.

  • appinfo_errors.MultipleProjectNames: se o arquivo app.yaml tiver uma diretiva application e uma diretiva project.

class google.appengine.api.appinfo.ManualScaling(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa as configurações manuais de escalonamento no AppInfoExternal.

ATRIBUTOS = {'instances': <google.appengine.api.validation.Regex object>}
class google.appengine.api.appinfo.Network(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração de rede da VM.

ATRIBUTOS = {'instance_tag': <google.appengine.api.validation.Optional object>, 'session_affinity': <google.appengine.api.validation.Optional object>, 'name': <google.appengine.api.validation.Optional object>, 'forwarded_ports': <google.appengine.api.validation.Optional object>, 'subnetwork_name': <google.appengine.api.validation.Optional object>}
google.appengine.api.appinfo.ParseExpiration(expiration)source

Analisa uma string delta de expiração.

Parâmetros

expiration: string que corresponde a _DELTA_REGEX.

Retorna

Delta de tempo em segundos.

class google.appengine.api.appinfo.ReadinessCheck(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração da verificação de preparo.

ATRIBUTOS = {'check_interval_sec': <google.appengine.api.validation.Optional object>, 'timeout_sec': <google.appengine.api.validation.Optional object>, 'app_start_timeout_sec': <google.appengine.api.validation.Optional object>, 'host': <google.appengine.api.validation.Optional object>, 'failure_threshold': <google.appengine.api.validation.Optional object>, 'path': <google.appengine.api.validation.Optional object>, 'success_threshold': <google.appengine.api.validation.Optional object>}
class google.appengine.api.appinfo.Resources(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração de recursos da VM.

ATRIBUTOS = {'memory_gb': <google.appengine.api.validation.Optional object>, 'disk_size_gb': <google.appengine.api.validation.Optional object>, 'cpu': <google.appengine.api.validation.Optional object>, 'volumes': <google.appengine.api.validation.Optional object>}
class google.appengine.api.appinfo.RuntimeConfig(**kwds)source

Bases: google.appengine.api.validation.ValidatedDict

Classe para configuração de tempo de execução "baunilha".

Os campos usados variam por tempo de execução, portanto, a validação é delegada aos processos de criação por tempo de execução.

Eles são destinados para uso durante a geração do Dockerfile, não após a inicialização da VM.

KEY_VALIDATOR = <google.appengine.api.validation.Regex object>
VALUE_VALIDATOR

alias de str

class google.appengine.api.appinfo.URLMap(**attributes)source

Bases: google.appengine.api.appinfo.HandlerBase

Mapas de URLs para gerenciadores.

Essa classe age de maneira semelhante a um tipo de união. Sua finalidade é descrever um mapeamento entre um conjunto de URLs e os respectivos gerenciadores. O tipo de gerenciador de determinada instância é definido de acordo com o atributo handler-id que é usado.

Todo mapeamento pode ter um, e apenas um, tipo de gerenciador. A tentativa de usar mais de um atributo handler-id fará com que um erro UnknownHandlerType seja gerado durante a validação. Se você não fornecer nenhum atributo handler-id, o erro MissingHandlerType será gerado durante a validação.

A expressão regular usada pelo campo url será utilizada para corresponder ao caminho do URL inteiro e à string de consulta da solicitação, portanto, os mapas parciais não serão correspondidos. A especificação de um url, como /admin, é igual à correspondência com a expressão regular ^/admin$. Não inicie o url correspondente com ^ nem o termine com $. Essas expressões regulares não serão aceitas e gerarão o erro ValueError.

login

Especifica se um usuário deve efetuar login para acessar um URL. O valor padrão desse argumento é optional.

secure

Define a restrição no protocolo que pode ser usada para veicular esse URL ou gerenciador. Este valor pode ser definido como HTTP, HTTPS ou either.

url

Especifica uma expressão regular usada para corresponder totalmente ao caminho dos URLs de solicitação. Consulte a seção "Casos especiais" deste documento para saber mais.

static_files

Especifica o atributo de código do gerenciador que mapeia o url para o arquivo apropriado. Você pode especificar referências anteriores de expressão regular para a string correspondida ao url.

upload

Especifica a expressão regular usada pelo programa de configuração do aplicativo para determinar quais arquivos são carregados como blobs. Como é difícil determinar essas informações usando apenas os argumentos url e static_files, esse atributo precisa ser incluído. Esse atributo é necessário quando você define um mapeamento de static_files. Um nome de arquivo correspondente tem que corresponder totalmente à expressão regular upload, semelhante à correspondência de url com o caminho da solicitação. Não inicie o argumento upload com o caractere ^, nem o termine com o caractere $.

static_dir

Especifica o código do gerenciador que mapeia o url fornecido para um subdiretório dentro do diretório do aplicativo. Consulte "Casos especiais".

mime_type

Quando usado com static_files e static_dir, esse argumento especifica que o tipo MIME dos arquivos que são veiculados por esses diretórios precisa ser modificado por esse valor.

script

Especifica o código do gerenciador que mapeia URLs para um gerenciador de scripts no diretório do aplicativo que será executado usando a CGI.

position

Usado em objetos AppInclude para especificar se um gerenciador precisa ser inserido no início da lista de gerenciadores principais ou no final. Se o argumento tail for especificado, o gerenciador será inserido no final. Caso contrário, será inserido no início. Esse comportamento pressupõe que o argumento head seja o padrão efetivo.

expiration

Quando usado com arquivos e diretórios estáticos, esse argumento especifica o delta de tempo a ser usado para expiração do cache. Ele deve usar o seguinte formato: 4d 5h 30m 15s, em que cada letra significa dias, horas, minutos e segundos, respectivamente. O s de “segundos” pode ser omitido. Apenas um valor pode ser especificado, mas a combinação de vários valores é opcional. A lista a seguir contém exemplos de valores aceitáveis: 10, 1d 6h, 1h 30m, 7d 7d 7d, 5m 30.

api_endpoint

Especifica o código do gerenciador que identifica um ponto de extremidade como da API. As chamadas que terminam aqui serão tratadas pela biblioteca de veiculação da API.

Casos especiais:

Ao definir um gerenciador static_dir, não use uma expressão regular no atributo url. Os atributos url e static_dir são mapeados automaticamente para estes equivalentes:

<url>/(.*)
<static_dir>/\1

Por exemplo, esta declaração:

url: /images
static_dir: images_folder

é equivalente a esta declaração static_files:

url: /images/(.*)
static_files: images_folder/\1
upload: images_folder/(.*)
ALLOWED_FIELDS = {'api_endpoint': ('position', 'script'), 'static_files': ('mime_type', 'upload', 'expiration', 'require_matching_file', 'http_headers', 'application_readable'), 'static_dir': ('mime_type', 'expiration', 'require_matching_file', 'http_headers', 'application_readable'), 'script': 'position'}
ATRIBUTOS = {'secure': <google.appengine.api.validation.Options object>, 'static_files': <google.appengine.api.validation.Optional object>, 'application_readable': <google.appengine.api.validation.Optional object>, 'auth_fail_action': <google.appengine.api.validation.Options object>, 'require_matching_file': <google.appengine.api.validation.Optional object>, 'static_dir': <google.appengine.api.validation.Optional object>, 'redirect_http_response_code': <google.appengine.api.validation.Optional object>, 'http_headers': <google.appengine.api.validation.Optional object>, 'url': <google.appengine.api.validation.Optional object>, 'script': <google.appengine.api.validation.Optional object>, 'upload': <google.appengine.api.validation.Optional object>, 'api_endpoint': <google.appengine.api.validation.Optional object>, 'expiration': <google.appengine.api.validation.Optional object>, 'position': <google.appengine.api.validation.Optional object>, 'login': <google.appengine.api.validation.Options object>, 'mime_type': <google.appengine.api.validation.Optional object>}
AssertUniqueContentType()source

Garante que self.http_headers seja consistente com self.mime_type.

Esse método pressupõe que self seja um gerenciador estático, self.static_dir ou self.static_files. Não é possível especificar None.

Gera
appinfo_errors.ContentTypeSpecifiedMultipleTimes: se self.http_headers

contiver um cabeçalho Content-Type e self.mime_type estiver definido. Por exemplo, a seguinte configuração será rejeitada:

handlers:
- url: /static
  static_dir: static
  mime_type: text/html
  http_headers:
    content-type: text/html

Como este exemplo mostra, uma configuração será rejeitada quando http_headers e mime_type especificarem um tipo de conteúdo, mesmo quando especificarem o mesmo tipo de conteúdo.

COMMON_FIELDS = set(['url', 'redirect_http_response_code', 'login', 'secure', 'auth_fail_action'])
CheckInitialized()source

Inclui uma verificação adicional para garantir que um gerenciador tenha os campos corretos.

Além do método ValidatedCheck normal, esse método chama GetHandlerType, que valida se todos os campos do gerenciador estão configurados corretamente.

Gera
  • UnknownHandlerType: se nenhum dos atributos de código do gerenciador estiver definido.

  • UnexpectedHandlerAttribute: se um atributo inesperado for configurado para o tipo de gerenciador descoberto.

  • HandlerTypeMissingAttribute: se um atributo obrigatório para o respectivo tipo estiver ausente no gerenciador.

  • ContentTypeSpecifiedMultipleTimes: se mime_type for inconsistente com http_headers.

ErrorOnPositionForAppInfo()source

Gera um erro se a posição for especificada fora dos objetos AppInclude.

Gera

PositionUsedInAppYamlHandler: se o atributo position for especificado para um arquivo app.yaml, em vez de um arquivo include.yaml.

FixSecureDefaults()source

Força os campos do gerenciador secure a serem definidos como "secure: optional".

O efeito é que handler.secure nunca é igual ao padrão nominal.

GetHandler()source

Extrai o gerenciador de um mapeamento.

Retorna

O valor do gerenciador, conforme determinado pelo atributo de código do gerenciador.

GetHandlerType()source

Extrai o tipo de gerenciador de um mapeamento.

Retorna

O tipo de gerenciador, conforme determinado de acordo com o atributo de código do gerenciador definido.

Gera
  • UnknownHandlerType: se nenhum dos atributos de código do gerenciador estiver definido.

  • UnexpectedHandlerAttribute: se um atributo inesperado for configurado para o tipo de gerenciador descoberto.

  • HandlerTypeMissingAttribute: se um atributo obrigatório para o respectivo tipo estiver ausente no gerenciador.

  • MissingHandlerAttribute: se um gerenciador de URLs não tiver um atributo.

WarnReservedURLs()source

Gera um aviso para URLs reservados.

Consulte a documentação do elemento de versão para saber os URLs que estão reservados.

google.appengine.api.appinfo.ValidFilename(filename)source

Determina se um nome de arquivo é válido.

Parâmetros

filename –

O nome do arquivo para validar. O nome do arquivo precisa ser um nome de arquivo válido:

  • Pode conter apenas letras, números e os seguintes caracteres especiais: @, _, +, /, $, ., - ou "~".

  • Precisa ter menos de 256 caracteres.

  • Não pode conter /./, /../ ou //.

  • Não pode terminar em /.

  • Todos os espaços têm que estar no meio de um nome de diretório ou de arquivo.

Retorna

Uma string de erro se o nome do arquivo for inválido. ‘’ é retornado se o nome do arquivo for válido.

google.appengine.api.appinfo.ValidateCombinedSourceReferencesString(source_refs)source

Determina se source_refs contém uma lista válida de referências de origem.

Parâmetros

source_refs: uma string de várias linhas contendo uma referência de origem por linha.

Gera

ValidationError: se a referência estiver malformada.

google.appengine.api.appinfo.ValidateHandlers(handlers, is_include_file=False)source

Valida uma lista de objetos do gerenciador (URLMap).

Parâmetros
  • handlers: uma lista de objetos do gerenciador (URLMap).

  • is_include_file: se esse argumento estiver configurado como True, os gerenciadores adicionados como parte da diretiva includes serão validados.

google.appengine.api.appinfo.ValidateSourceReference(ref)source

Determina se uma referência de origem é válida.

Parâmetros

ref: uma referência de origem no seguinte formato: [repository_uri#]revision.

Gera

ValidationError: se a referência estiver malformada.

class google.appengine.api.appinfo.VmHealthCheck(**attributes)source

Bases: google.appengine.api.appinfo.HealthCheck

Classe que representa a configuração da verificação de integridade da VM.

class google.appengine.api.appinfo.VmSettings(**kwds)source

Bases: google.appengine.api.validation.ValidatedDict

Classe para configurações da VM.

As configurações não são mais validadas aqui. As configurações são validadas no lado do servidor.

KEY_VALIDATOR = <google.appengine.api.validation.Regex object>
classmethod Merge(vm_settings_one, vm_settings_two)source

Mescla duas instâncias de VmSettings.

Se uma variável é especificada por ambas as instâncias, o valor de vm_settings_one é usado.

Parâmetros
  • vm_settings_one: a primeira instância de VmSettings ou None.

  • vm_settings_two: a segunda instância de VmSettings ou None.

Retorna

A instância de VmSettings mesclada, ou None se as duas instâncias de entrada forem None ou vazias.

VALUE_VALIDATOR

alias de str

class google.appengine.api.appinfo.Volume(**attributes)source

Bases: google.appengine.api.validation.Validated

Classe que representa a configuração de um volume.

ATRIBUTOS = {'size_gb': <google.appengine.api.validation.Type object>, 'name': <google.appengine.api.validation.Type object>, 'volume_type': <google.appengine.api.validation.Type object>}
Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2