PythonでCLIツールを作ってみた

PythonでCLIツールを作ってみた見た目でわかる！ビジュアルネタLT会うーたん

自己紹介うーたん所属 : 公立千歳科学技術大学 twitter : @uutan1108 github :
OHMORIYUSUKE 趣味 : アニメを見ること　　　　ヤマノススメが好き　　　　今期はリコリス・リコイル

目次 1. 作ったもの 2. 仕様技術 a. ﬁre b. rich c.
pydantic 3. コード

作ったもの

作ったもの YAMLで定義されたテストを実行するためのCLIツールスター★ください https://github.com/OHMORIYUSUKE/grech

特徴 1. Shellで様々な環境をテストすることができる a. shellが実行可能な環境であればテストすることができる 2. YAMLでテストを定義することができる a. テストの書き方を決めることができる 3.
テストケースを配布することができる a. YAMLファイルは公開されている必要がある 4. Shellの結果のみでテストの正誤判定 a. cat test.py | grep main のようなコマンドを実行させてテストする 5. YAML内で使いたい変数を環境ごとに設定させることができる a. テストを行う人が設定することができる(rootのパスワードなど)

YAMLでテストを定義する YAMLのサンプル https://github.com/OHMORIYUSUKE/grech/blob/main/test.yml

環境ごとの変数テスト内で環境ごとの値を設定させることができる。コマンド内で用いることができる

テストテストをまとめることができるテストの名前コマンド正規表現正規表現すべてにマッチするかどうかコマンドを実行するディレクトリ成功しなかったときに出るメッセージ

テストを走らせる

インストール pipでインストールすることができる mainにマージされるとビルドされる

初回どのテストを行うか設定 yamlファイルを設定し、必要な値を設定する YAMLで設定した変数の設定を求められる

テストを実行すべてのテストを実行することができる

テストの内容 –debug 1 を与えるとどのようなコマンドを実行してテストを行っているか確認することができる

仕様技術

ライブラリ - poetry(Pythonのパッケージマネージャ) を使った - 開発環境はDockr 話したいこと • ﬁre •
rich • pydantic 使ったライブラリ

ﬁre PythonでCLIツールを作るときに便利 helpなども良しなにしてくれる https://github.com/google/python-ﬁre

rich • 画面幅に合わせたテーブルを作成することができる(感動) ◦ termtables(テーブルをいい感じに表示するライブラリ )は画面幅を考慮しない • 文字に色もつけられる • マークダウンをいい感じに表示
• プログレスバーも作れるターミナルをおしゃれにできる https://github.com/Textualize/rich

pydantic

pydantic モデルの型を定義することができる型に合致しない場合はエラーになる型ヒントも出してくれる！！今回はYAMLのデータをモデルにしてコード内で扱うようにした https://github.com/samuelcolvin/pydantic

コード

コードを自分なりにきれいに main.pyだけで処理していたコードを MVCを意識して書き直してみた。 main.py → Controller → UseCase → Controller
→ View mai.pyだけのコードよりは見やすくなったのでは...

きれいなコードを書きたい...

ご清聴ありがとうございました

PythonでCLIツールを作ってみた

PythonでCLIツールを作ってみた

uutan1108

More Decks by uutan1108

Other Decks in Technology

Featured

Transcript