自作の python utility を作ってみたので使ってみて！

はじめに

自作の python utlity を作ったので、せっかくなのでシェアします！

使えるコンポーネントは、以下の通り

• utils.add_args (本記事でかるく解説）
• utils.Logger
• utils.build_ulid

コード

• コードは、こちら

動作環境

対象	バージョン
OS	Ubuntu 22.04
python	Python 3.10.10 in pyenv

使い方

まずはインストール

サンドボックス用などの実験用に使える環境などで、インストールします。

pip install git+https://github.com/tkosht/utils.git

サンプルコードを作成

ここでは、utils.params のサンプルコードで解説します。

以下の内容で params_examples.py として保存

params_example.py

import utils


@utils.add_args(params_file="conf/params.yml", root_key="/test_params")
def run(a, b):
    print(f"{a=}, {b=}")


if __name__ == "__main__":
    run()

※ examplesと同じです

utils.add_args は、YMLファイル（例：params_file）の特定の設定項目のパス(例：root_key の test_params)直下を関数引数にマッピングする機能を提供します

実行前に下準備

mkdir -p log
mkdir -p conf
cat << YML > conf/params.yml
test_params:
  a: 2
  b: 7
YML

実行します

python params_example.py 

こんな感じに出力されればOK

a=2, b=7

まとめ

• 思ったより、簡単に自作ライブラリを作れることがわかった
• 毎回、自分のコードにコピーしていたライブラリ的なコードを使い回しやすくなった
• よかったら使ってみてねー