メインコンテンツへスキップ
見出し画像

pythonを用いたGUIソフト制作から配布の流れ【個人的メモ】

    最近、頼まれてpythonで簡単なGUIアプリを制作しました。今まででも何度かそういうことがあり、個人的にこういうときの制作の流れみたいなものを決めておこう、と思いこの記事を書いています。

    簡単なソフトから規模が大きめなものまで大体共通する考え方だと思うので、pythonで制作したいけど何をすればいいかわからない、という方のお役に立てれば幸いです。

    ※ windowsで開発、最終的にexe化して配布することを想定しています。また、プログラムの組み方などは自己流なので、セオリーと違う部分は多々あるかもしれません…

    1. 作るものは?

    当然ですが、どんなアプリを作るのかは最初になんとなく決めるのが必須です。細かい機能まで想像できるならそれはそれで良いのですが、この段階ではなんとなく「こういう感じのものを作る」程度で十分だと思います。

    本記事では、ちょうど自分が制作したビープタイマー(一定間隔で音を鳴らせるようなアプリ、メトロノームと何が違うかさっぱりわからない)を例に説明していきます。

    ※ 完成形はなんとなくでいいので想像しておくと後が楽です。

    画像
    ビープタイマーの完成形

    2. 制作方針を決める

    作るものが決まったら、具体的にpythonでどう開発していくのかを考えます。pythonには様々なGUIモジュールが入っているので、何を使うのかを考えます。
    自分はtkinterとpygameしか書けないのでこの比較になりますが、個人的には以下のように使い分けています。

    <tkinter>
    ボタンを多く付けたい、また画面上のアニメーションがないもの
    <pygame>
    画面上でアニメーションがある、またキーボード操作やマウス操作を多用するようなもの

    一番大きい違いはアニメーションがあるかないかで、tkinterでアニメーションをやろうとすると結構面倒になるというのが個人的な認識です。ただし、ボタンは圧倒的にtkinterのほうが作りやすいので、そこは重宝します。

    今回の例のビープタイマーでは、ボタン操作と画面への文字表示だけなので基本的にはtkinterを使用しましたが、音を鳴らすのはpygameでないとできないので、その部分だけpygameを使っています。

    3. プログラミング

    ここに関しては制作するものによって変わるので、あまり説明することもないのですが、自分がすべてに共通して意識していることを書きます。

    (1) 最初から配布(exe化)を見越しておく

    これが一番大事だと思います。経験上、ファイルの読み込み等を含むプログラムの場合は、後からexe化に対応するのはかなり面倒です。よくわからない方は一旦以下の記事(特に5.や6.など)をご覧ください。

    このように、従来の方法で読み込むだけではダメで、ひと手間加えておかないとexe化したときにエラーを吐かれます。

    自分は、ファイル読み込みを含む場合は開発の際に以下で配布している自作モジュールを使用しています。

    pygameだけしか使えないみたいに見えますが(完全に記事を書いたときの自分のミス)、あくまでpygame関連が多いだけで、exe化用のファイル読み込み処理もできます。

    ビープタイマーのファイル読み込み部は以下のように書いています。

    画像
    patch.path関数がexe化対応処理です

    (2) コメントは最小限でもいいので書いておく

    コメントを1行ごとに書くというのは面倒なのでさすがにいちいちやりませんが、各関数ごとにどんな機能?くらいは書いておくべきです。そうしないと後で自分で見返すとき(例えばバグ修正や機能追加など)に痛い目を見ます(経験談)。

    自分は以下のような感じで書いています。

    画像
    これは小規模で大したことはしていないので簡易的ですが、
    もっと大規模なら関数内でも割と区切ります

    (3) プログラムの「書く順序」

    ここは完全に趣味の問題ですが、自分はプログラムはだいたい以下のように書いています。

    ① モジュール類のインポート
    ② 準備が必要なモジュールの処理(tkinter,pygameなど)
    ③ ローカルデータの読み込み
    ④ 全体共通変数の初期化
    ⑤ classや関数など
    ⑥ 実行する処理やメインループなど

    ※②~④はあまり順序を気にして書いたことないです…

    (4) 動作確認について

    動作確認に関しては、自分が思った通りの動作をしているなら、細かくバグを血眼になって探す必要はないと思っています。有料ソフトを作るなら確かにデバッグはしっかりするべきですが、無料配布・個人開発の範囲で、なら多少バグがあったところでさほど問題になるようなものではないですし、気づいたら修正する、くらいで良いと思います。

    ※ 大規模なゲームは話が別です。ちょっとバグがあると全体の動作に影響することも多いので、試験段階としていろいろな無理な操作を試したり、第三者にプレイしてもらったりするのが良いと思います。

    4. exe化する

    自分はpyinstaller\verb|pyinstaller|派なので、ここではpyinstaller\verb|pyinstaller|を用いたやり方です。
    ここで、3.(1)で書いた「最初からexe化を見越しておく」が効いてきます。つまり、もうプログラムはいじる必要がないのです。

    ※ exe化した後にプログラムを修正するのは基本的に不可能です。何かあるならこの段階で直しておくことをオススメします。exe化してから不具合に気づくとexe化のやり直しが待っています・・・

    exe化の詳しいやり方やコマンドの詳細などは以下(再掲)で解説しているので省略しますが、自分がいつもやっている手順は軽く書いておきます。(windowsです)

    (1) コマンドプロンプトでプログラムのディレクトリを開く

    もちろんスタートメニューの検索ボックスから起動してもいいですが、なんか妙に動作が重かったりして面倒ですよね。しかも、起動した後はcd\verb|cd|コマンドを使用してプログラムファイルがあるディレクトリに飛ぶというひと手間が要ります。

    そんな時に便利なのがエクスプローラーから直接開く方法です。

    エクスプローラーでそのプログラム(今回はmain.py\verb|main.py|)が入ったディレクトリを開き、上のところをクリックします。

    画像
    配布仕様でmain.exeとreadmeがありますが気にしないでください

    その部分にcmd\verb|cmd|と入力してEnterキーを押します。

    画像

    するとこのように、既にそのディレクトリに移動した後のコマンドプロンプトが起動します。

    画像
    もちろん場所は環境や制作した場所によって変わると思います

    ※ 普段他のことに使うときは自分はWindows+Rからcmd\verb|cmd|と入力して起動するのが好みです。他にもWindows+Rからはwinver\verb|winver|だとかtaskmgr\verb|taskmgr|とか(これに関してはCtrl+Shift+Escで良い気もする)いろいろショートカットがあってかなり便利なのに知名度低くて悲しい…

    (2) exe化で必ず入れたほうが良いコマンド

    構文については前述のように前に解説したので省略しますが、必ず入れたほうが良いオプション(コマンド)が2つあります。
    --onefile\verb|--onefile|と--windowed\verb|--windowed|です。

    --onefile\verb|--onefile|はファイルを1つにまとめてくれる機能、--windowed\verb|--windowed|は実行時にログを表示しない(=pygameやtkinterのウィンドウだけ)にするオプションです。これを組み合わせて、以下のようにするのが良いと思います。

    pyinstaller --onefile --windowed main.py

    main.py\verb|main.py|はオプション類の前でも後でも大丈夫です。すなわち、pyinstaller main.py --onefile --windowed\verb|pyinstaller main.py --onefile --windowed|としても結果は変わりません。

    その他のオプションとしては、--name\verb|--name|は正直あとからファイル名を変更すればよいので指定する必要がなく、--icon\verb|--icon|は欲しい場合は作る程度で十分だと思います。

    (3) exe化の実行

    コマンドプロンプトで実行すると、とんでもない量のログが出てくると思いますが、これが正常な動作です。

    実際、実行すると以下のような感じになります。

    画像
    (場合によっては時間がかかることがあります)
    画像

    最後に INFO: Build complete! … \verb| INFO: Build complete! … |と出てきて、コマンドプロンプトに次の命令が打てるようになっていたら成功です。なお、途中でWarning: …\verb|Warning: …|などと警告が出ることがありますが、最後にこれが出て成功していれば基本的に問題ありません(無視してOK)。

    途中でエラーなどが出て、最後に Build complete! \verb| Build complete! |が出なかった場合は、エラー文をチャッピーに丸投げして原因を聞くのが一番早いと思います。

    ※ 実行が終わったらコマンドプロンプトは閉じて大丈夫です。

    (4) exe化後の動作確認とファイル整理

    exe化が終わったら、エクスプローラーでそのディレクトリを開いてみましょう。以下のようになっているはずです。

    画像
    buildフォルダ、distフォルダ、(プログラム名).specが増えているはずです。
    (readmeは先に作っておいただけなのでここでは関係ありません)

    まずは、distフォルダの中にexe化したプログラムが入っていると思うので、それを元プログラム(,py)と同じところに配置してください。

    画像
    このようにドラック&ドロップでも良いですし、コピペ等でも構いません

    そうしたら、一度そのexeファイルをダブルクリックして実行してみましょう。プログラム通りの挙動をすれば成功です。

    ※ windowsセキュリティによってブロックされた場合は、「詳細情報」→「実行」で実行できます。なお、このとき管理者権限が必要なことがあるようです。また、他のセキュリティソフト(ウイルスバスターなど)によってブロックされることも考えられる(自分の環境ではなかったが)ので、その際は一度セキュリティを切るなどの対応をしてください。

    この動作確認ができたら、buildフォルダ・distフォルダ・(プログラム名).specはすべて消して大丈夫です。一応何が入っているかだけ書いておきます。

    【buildフォルダ】
    exe化時の作業などで使われたログや一時保存のデータなど。
    【distフォルダ】
    完成品がおかれる場所。今回は--onefileとしているのでmain.exeのみが入った。元ディレクトリに移動してしまえば完全に空なので存在意義はない。
    【(プログラム名).spec】
    exe化時での内部の設定など。再作業の予定が無ければ不要。

    なお、元プログラムのmain.pyは、もうこれで完成でこれ以上プログラムを修正する必要がないなら消しても大丈夫です。ただ、exeファイルから元に戻すことはかなり困難なので、そのフォルダには入れずとも別の場所に保管することをオススメします。

    5. 配布する

    4.(4)で書いたファイル整理をしたらもう配布できる形にはなっています。ただ、一応公開するならreadme.txt(またはreadme.md)は書いておくと良いと思います。

    なお、フリー素材をダウンロードしてきてソフト内で使っている場合(例えば画像や音など)は、必ずダウンロード元の利用規約を確認するようにしてください。このような個人開発のものにおいては、再配布の可/不可については特に重要で、不安なら問い合わせてみる、またはそもそも使わないべきです。

    配布の方法は何でも良いと思います。GitHubやらGoogleドライブやら、方法はいろいろあります。もちろんnoteにも、.zipにして圧縮すればアップロードできます。

    6. 今回の例の配布

    今回の例として使った制作したビープタイマーの配布です。

    readmeにも書きましたが、著作権の都合上、音ファイルをこちらで同梱していません。使用の際はお手数ですが、どこかからサウンドをダウンロードしてきて、以下のようにsoundフォルダ内に「sound1.mp3」として保存してください。

    画像

    ※ 一応、こちらでは、効果音ラボ様の「カーソル移動1.mp3」を使用することを想定しています。



    >>>全記事ポータルページはこちら




     
     
    数学とPythonが好きな人です。 主に数学と自作のPythonプログラムの解説記事を書いています。 最近はBVE関連にハマってます… X垢(主にBVE):https://x.com/__init__92435

    あなたへのおすすめ