TOML

TOML.jlは、TOML v1.0ファイルを解析・書き込みするためのJulia標準ライブラリです。

Parsing TOML data

julia> using TOML

julia> data = """
           [database]
           server = "192.168.1.1"
           ports = [ 8001, 8001, 8002 ]
       """;

julia> TOML.parse(data)
Dict{String, Any} with 1 entry:
  "database" => Dict{String, Any}("server"=>"192.168.1.1", "ports"=>[8001, 8001…

ファイルを解析するには、TOML.parsefileを使います。ファイルに構文エラーがある場合は、例外がスローされます。

julia> using TOML

julia> TOML.parse("""
           value = 0.0.0
       """)
ERROR: TOML Parser error:
none:1:16 error: failed to parse value
      value = 0.0.0
                 ^
[...]

解析エラー時に例外をスローする代わりに、情報を含むTOML.ParserErrorを返す解析関数もあります(TOML.tryparseおよびTOML.tryparsefile)。

julia> using TOML

julia> err = TOML.tryparse("""
           value = 0.0.0
       """);

julia> err.type
ErrGenericValueError::ErrorType = 14

julia> err.line
1

julia> err.column
16

Exporting data to TOML file

データをTOML形式で出力(シリアライズ)するには、TOML.print関数を使います。

julia> using TOML

julia> data = Dict(
          "names" => ["Julia", "Julio"],
          "age" => [10, 20],
       );

julia> TOML.print(data)
names = ["Julia", "Julio"]
age = [10, 20]

julia> fname = tempname();

julia> open(fname, "w") do io
           TOML.print(io, data)
       end

julia> TOML.parsefile(fname)
Dict{String, Any} with 2 entries:
  "names" => ["Julia", "Julio"]
  "age"   => [10, 20]

キーは、指定した値に従って並べ替えることができます。

julia> using TOML

julia> TOML.print(Dict(
       "abc"  => 1,
       "ab"   => 2,
       "abcd" => 3,
       ); sorted=true, by=length)
ab = 2
abc = 1
abcd = 3

カスタム構造体の場合は、構造体をサポートされている型に変換する関数を渡します。

julia> using TOML

julia> struct MyStruct
           a::Int
           b::String
       end

julia> TOML.print(Dict("foo" => MyStruct(5, "bar"))) do x
           x isa MyStruct && return [x.a, x.b]
           error("unhandled type $(typeof(x))")
       end
foo = [5, "bar"]

References

TOML.parse — Function
parse(x::Union{AbstractString, IO})
parse(p::Parser, x::Union{AbstractString, IO})

文字列またはストリーム x を解析し、結果のテーブル(辞書)を返します。失敗した場合は ParserError をスローします。

TOML.tryparse も参照してください。

source
TOML.parsefile — Function
parsefile(f::AbstractString)
parsefile(p::Parser, f::AbstractString)

f ファイルを解析し、結果のテーブル(辞書)を返します。失敗した場合は ParserError をスローします。

TOML.tryparsefile も参照してください。

source
TOML.tryparse — Function
tryparse(x::Union{AbstractString, IO})
tryparse(p::Parser, x::Union{AbstractString, IO})

文字列またはストリーム x を解析し、結果のテーブル(辞書)を返します。失敗した場合は ParserError を返します。

TOML.parse も参照してください。

source
TOML.tryparsefile — Function
tryparsefile(f::AbstractString)
tryparsefile(p::Parser, f::AbstractString)

ファイル f を解析し、結果のテーブル(辞書)を返します。失敗した場合は ParserError を返します。

TOML.parsefile も参照してください。

source
TOML.print — Function
print([to_toml::Function], io::IO [=stdout], data::AbstractDict; sorted=false, by=identity, inline_tables::IdSet{<:AbstractDict})

dataをTOML構文でioに書き込みます。キーワード引数sortedにtrueが設定されている場合、キーワード引数byで指定された関数に従ってテーブルを並べ替えます。キーワード引数inline_tablesを指定する場合は、「インライン」で出力するテーブルの集合を指定してください。

Julia 1.11

キーワード引数inline_tablesは、Julia 1.11以降でサポートされています。

次のデータ型がサポートされています:AbstractDict、AbstractVector、AbstractString、Integer、AbstractFloat、Bool、Dates.DateTime、Dates.Time、Dates.Date。整数と浮動小数点数は、それぞれFloat64およびInt64に変換可能である必要があります。それ以外のデータ型については、そのデータ型を受け取り、サポート対象の型の値を返す関数to_tomlを渡してください。

source
TOML.Parser — Type
Parser()

TOML Parser のコンストラクター。通常は Parser を明示的に作成する必要はなく、代わりに TOML.parsefile または TOML.parse を直接使用します。ただし、明示的なパーサーを使用すると内部データ構造の一部が再利用されるため、多数の小さなファイルを解析する場合はパフォーマンス上の利点があります。

source
TOML.ParserError — Type
ParserError

tryparseおよびtryparsefileで解析に失敗した場合に返される型です。次のフィールドなどを含みます。

  • pos:エラーが発生した文字列内の位置
  • table:それまでに正常に解析された結果
  • type:エラーの種類を示す値。エラーの種類ごとに異なります。
source