Pointing結果のTOML出力の実装

[daisukenaito]

[astropenguin]

こちらの機能を実装いただき大変ありがとうございます。2点ほどコメントいたします。

TOMLの出力方法について

decode-qlookのコマンドラインの仕様として、出力データフォーマット（png等の画像形式・zarr.zip等の配列形式）を指定するとそれに応じた出力データを保存し、標準出力に出力データの絶対パスを出力するようになっています。例えば、dems_20241026080223.zarr.zip に対してpdf形式で保存するようにするには以下のように実行します。

$ decode-qlook auto dems_20241026080223.zarr.zip --format pdf --outdir /path/to
/path/to/dems_20241026080223.zarr.daisy.pdf

こうした仕様なので、daisyに対してのみ、上記の出力データに加え相対パスでpointing.tomlが出力されるのは適切ではないのかなと考えています。（少なくとも追加のヘルプドキュメントが必要になってしまうのと、連続したdecode-qlookで上書きされてしまう。decode-qlookでは既存ファイルの上書きをデフォルトで禁止にしています。）decode-qlookの実行時間は（私の手元のラップトップで）たかだか3秒程度ですので、

$ decode-qlook auto dems_20241026080223.zarr.zip --format pdf --outdir /path/to
/path/to/dems_20241026080223.zarr.daisy.pdf
$ decode-qlook auto dems_20241026080223.zarr.zip --format toml --outdir /path/to
/path/to/dems_20241026080223.zarr.daisy.toml

のように実行を2回に分けて、それぞれで画像とTOMLを出力するようにする方が後ほど使いやすいかと思いますがいかがでしょうか？これを実装するには、qlook.pyの# constantsの下に

# constants
# (中略)
TEXT_FORMAT = "toml"

を定義し、save_qlookを以下のようにアップデートし、

def save_qlook(
    qlook: Union[Figure, xr.DataArray, str], # TOML文字列の型を追加

    # (中略)

    if path.name.endswith(".zarr.zip"):
        qlook.to_zarr(path, mode="w", **options)
        return path

    # TOML文字列をファイルに書き込む処理を追加
    if path.name.endswith(".toml"):
        with open(path, "w") as f:
            f.write(qlook)

        return path

    raise ValueError("Extension of filename is not valid.")

daisy関数で以下のようにTOMLを保存する場合分けをするのが良いかと思います。

def daisy(

    # (中略)

    if format in DATA_FORMATS:
        return save_qlook(cont, file, overwrite=overwrite, **options)

    if format == TEXT_FORMAT:
        toml_string = ... # save_pointing_toml関数でファイル保存せず文字列を返すようにすればOK
        return save_qlook(toml_string, overwrite=overwrite, **options)

TOMLの出力対象について

TOMLの出力機能は、daisy関数に加えてraster関数にも実装されるべきかと思いました。

[astropenguin]

すみません、追加でもう一点、現バージョンではtomlのインポートができません。pyproject.tomlおよびpoetry.lockを更新していただけますでしょうか？加えて、tomlは更新が止まってしまったパッケージで最新のTOML v1.0.0に対応していませんので、代わりにtomli-wを使っていただくのがよいかと思います。サードパーティー製ですが、Pythonの公式ドキュメントにも言及があるパッケージです。

参考 Tomli-W パッケージ はTOMLの書き込み用にこのモジュールと組み合わせて使用でき、標準ライブラリの marshal や pickle モジュールなどでユーザーによく知られている書き込みAPIを提供します。
https://docs.python.org/ja/3.13/library/tomllib.html