json

問題を報告する ソースを表示

モジュール json は、JSON 関連関数の Starlark モジュールです。

メンバー

decode

unknown json.decode(x, default=unbound)

デコード関数には、必須の位置パラメータである JSON 文字列が 1 つあります。文字列が示す Starlark 値を返します。
  • "null"、"true"、"false" は、None、True、False として解析されます。
  • 数値は int として解析されるか、小数点または指数が含まれる場合は浮動小数点として解析されます。JSON には非有限値に対する構文はありませんが、非常に大きな値は無限大としてデコードされる可能性があります。
  • フリーズされていない新しい Starlark 辞書として JSON オブジェクトが解析されます。同じキー文字列がオブジェクト内に複数回出現すると、キーの最後の値が保持されます。
  • JSON 配列が解析され、フリーズされていない新しい Starlark リストが生成されます。
x が有効な JSON エンコードではなく、オプションの default パラメータが指定されている場合（None として指定されている場合）、この関数は default 値を返します。x が有効な JSON エンコードではなく、オプションの default パラメータが指定されていない場合、この関数は失敗します。

パラメータ

パラメータ 説明
x デコードに必要な
JSON 文字列。
default デフォルトは unbound です。
指定すると、x をデコードできない場合に返される値です。

encode

string json.encode(x)

encode 関数は、必要な位置引数を 1 つ受け取ります。これは、状況に応じて JSON に変換します。

  • None、True、False は、それぞれ「null」、「true」、「false」に変換されます。
  • int は、その大きさに関係なく、10 進数にエンコードされます。一部のデコーダでは、非常に大きな整数をデコードできない場合があります。
  • 浮動小数点数は、数値が整数であっても、小数点と指数、またはその両方を使用してエンコードされます。非有限の浮動小数点値をエンコードするとエラーになります。
  • 文字列値は、値を示す JSON 文字列リテラルとしてエンコードされます。ペアリングされていない各サロゲートは、U+FFFD に置き換えられます。
  • 辞書は、JSON オブジェクトとしてキーの順序でエンコードされます。キーが文字列でない場合、エラーになります。
  • リストまたはタプルは、JSON 配列としてエンコードされます。
  • 構造体のような値は、フィールド名の順序で JSON オブジェクトとしてエンコードされます。
アプリケーション定義型では、独自の JSON エンコードを定義できます。他の値をエンコードするとエラーになります。

パラメータ

パラメータ 説明
x 必須

encode_indent

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

encode_indent 関数は json.indent(json.encode(x), ...) と同等です。フォーマット パラメータの説明については、indent をご覧ください。

パラメータ

パラメータ 説明
x 必須
prefix デフォルトは '' です。
indent デフォルトは '\t' です。

インデント

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

インデント関数は、有効な JSON エンコードの文字列をインデントして返します。各配列要素またはオブジェクト フィールドは新しい行に表示されます。ネストの深さに応じて、接頭辞の文字列で始まり、その後にインデント文字列のコピーが 1 つ以上続きます。この関数は、1 つの必須の位置パラメータである JSON 文字列と、2 つの省略可能なキーワードのみの文字列パラメータ（prefix と indent）を受け入れ、改行の接頭辞とインデントの単位を指定します。入力が有効でない場合、関数は失敗するか、無効な出力を返す可能性があります。

パラメータ

パラメータ 説明
s 必須
prefix デフォルトは '' です。
indent デフォルトは '\t' です。