json

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6
O módulo json é um módulo Starlark de funções relacionadas a JSON.

Membros

decode

unknown json.decode(x, default=unbound)

A função de decodificação tem um parâmetro posicional obrigatório: uma string JSON. Ele retorna o valor do Starlark que a string indica.
  • "null", "true" e "false" são analisados como None, True e False.
  • Os números são analisados como int ou como um ponto flutuante se contiverem um ponto decimal ou um expoente. Embora o JSON não tenha sintaxe para valores não finitos, valores muito grandes podem ser decodificados como infinito.
  • um objeto JSON é analisado como um novo dicionário Starlark não congelado. Se a mesma string de chave aparecer mais de uma vez no objeto, o último valor da chave será mantido.
  • uma matriz JSON é analisada como uma nova lista do Starlark não congelada.
Se x não for uma codificação JSON válida e o parâmetro opcional default for especificado (incluindo None), essa função vai retornar o valor default. Se x não for uma codificação JSON válida e o parâmetro opcional default não for especificado, essa função vai falhar.

Parâmetros

Parâmetro Descrição
x string; required
String JSON a ser decodificada.
default O padrão é unbound
. Se especificado, o valor a ser retornado quando x não puder ser decodificado.

encode

string json.encode(x)

A função "encode" aceita um argumento posicional obrigatório, que é convertido em JSON por casos:

  • "None", "True" e "False" são convertidos em "null", "true" e "false", respectivamente.
  • Um int, não importa o tamanho, é codificado como um número inteiro decimal. Alguns decodificadores não conseguem decodificar números inteiros muito grandes.
  • Um ponto flutuante é codificado usando um ponto decimal ou um expoente ou ambos, mesmo que o valor numérico seja um número inteiro. É um erro codificar um valor de ponto flutuante não finito.
  • Um valor de string é codificado como um literal de string JSON que indica o valor. Cada substituto não pareado é substituído por U+FFFD.
  • Um dicionário é codificado como um objeto JSON, em ordem lexicográfica de chaves. É um erro se alguma chave não for uma string.
  • Uma lista ou tupla é codificada como uma matriz JSON.
  • Um valor semelhante a uma struct é codificado como um objeto JSON, na ordem do nome do campo.
Um tipo definido pelo aplicativo pode definir a própria codificação JSON. A codificação de qualquer outro valor gera um erro.

Parâmetros

Parâmetro Descrição
x required

encode_indent

string json.encode_indent(x, *, prefix='', indent='\t')

A função "encode_indent" é equivalente a json.indent(json.encode(x), ...). Consulte indent para uma descrição dos parâmetros de formatação.

Parâmetros

Parâmetro Descrição
x required
prefix string; o padrão é ''
indent string; o padrão é '\t'

indent

string json.indent(s, *, prefix='', indent='\t')

A função "indent" retorna a forma indentada de uma string válida codificada em JSON. Cada elemento da matriz ou campo de objeto aparece em uma nova linha, começando com a string de prefixo seguida por uma ou mais cópias da string de indentação, de acordo com a profundidade de aninhamento. A função aceita um parâmetro posicional obrigatório, a string JSON, e dois parâmetros de string opcionais somente de palavra-chave, prefix e indent, que especificam um prefixo de cada nova linha e a unidade de indentação. Se a entrada não for válida, a função poderá falhar ou retornar uma saída inválida.

Parâmetros

Parâmetro Descrição
s string; required
prefix string; o padrão é ''
indent string; o padrão é '\t'