自作サンプルコードの自筆記事を作成する時、Phindを記事作成支援機能として利用する

はじめに

サンプルコードを自作して、自筆の記事を書こうとする時に、ChatGPTでなくPhindを記事作成の支援機能として利用してみる試みを記載します。

Phind

Phindの利用に際して、アカウント登録等は不要で、Google検索と同様に、誰でもWeb上でそのまま利用可能です。
Phindに、サンプルコードの説明を付ける作業を支援して貰い、記事作成の支援としてPhindを使う方法を模索します。

ChatGPT

ChatGPTを記事作成の支援機能として利用する内容は、別途下記にあります。

サンプルコード

ここで用いるサンプルコードは、以前、Qiitaの記事として投稿した、Pythonでコンソール出力をテキストファイルに保存する、下記の記事内のサンプルコードを用いて、このサンプルコードの記事を改めて作成してみます。

記事: 他の.exeを起動して、コンソール出力をテキストファイルに保存する試行 (2020年12月30日に作成)

Phindを使ってサンプルコードの記事を作成する手順

「ChatGPTを記事作成の支援機能として利用する記事」で記載した通りの手順に従って(下記に再掲)、Phindを用いてサンプルコードの記事を作成してみます。

Phindを使ってサンプルコードの記事を作成する手順:

①サンプルコードに付け加える説明文の文章候補を生成
　↓
Phindへ下記の形式で質問:

• Phindへの質問: 前記のコードの、根幹部分の処理方法だけを説明、コメント部の内容を大いに反映
• Phindへの質問: 前記のコードの、根幹部分の処理方法だけを説明、コメント部の内容を大いに反映、体言止めで箇条書き、5個以内

　↓
得られたPhindの生成文から、好ましい部分を手動でピックアップして、コードの説明文を作成(※①)
　↓
②「はじめに」章の文章候補を生成
　↓
Phindへ下記の形式で質問:

• 前記のコードの、根幹部分の処理方法だけを説明、200字以内
• 前記のコードで、何が出来るようになるのかの説明、200字以内

　↓
得られたPhindの生成文から、好ましい部分を手動でピックアップして、「はじめに」章の内容を作成(※②)
　↓
③キーワード(タグ)の候補を作成
　↓
Phindへ下記の形式で質問:

• 前記のコードの、根幹部分の処理に、キーワード(タグ)を付与、5個

　↓
得られたPhindの生成文から、好ましい部分を手動でピックアップして、記事に付与するキーワード(タグ)を作成(※③)
　↓
前記の、※①・※②・※③をつなげて、記事全体を作成

「はじめに」章:

(※②)をここに配置

キーワード: (※③)をここに配置

「処理方法」章:

(※①)をここに配置

「サンプルコード」章:

(ここにサンプルコードをそのまま配置)

①サンプルコードに付け加える説明文の文章候補を生成

ChatGPTでなくPhindでも、同等レベル(若しくは、若干劣化)の結果が得られる印象。Phindでは、日本語で質問した場合も、英語表記で回答が作成されることがあるので、質問末尾に「日本語で表記」を追加。

試行1

▼私(人間)
下記のコードの、根幹部分の処理方法だけを説明、コメント部の内容を大いに反映、日本語で表記

# -*- coding: utf-8 -*-

# subprocessで起動したプロセスのコンソール出力を取得・保存するには
# ref: https://www.it-swarm-ja.tech/ja/python/subprocesscall%EF%BC%88%EF%BC%89%E3%81%AE%E5%87%BA%E5%8A%9B%E3%82%92%E5%8F%96%E5%BE%97%E3%81%99%E3%82%8B/968744582/

import subprocess

def main(): #   実行切替用
    run__main1()

# sec: コンソール出力を取得・保存

def run__main1():
    # 結果:
    # test.exeのコンソール出力保存可
    # test.batもコンソール出力保存可、.batも可
    
  # case: FAIL
    # subprocess.call("test.exe > res.log.txt")
    
  # case: Popen(.., stdout=..)を使用
    with open("res.log.txt", 'w') as file_log:
        proc = subprocess.Popen(
            ["test.bat"], 
            stdout=file_log, stderr=subprocess.PIPE) #   出力が必要な場合はstdout・stderr引数を利用
        proc.communicate() #   これで待機
    print("return code:", proc.returncode) #   DEBUG: 待機・終了確認用
  # case: end
    
    print("ended.")

# sec: entry

if __name__ == "__main__": main()

▼Phind(自動応答)
このコードは、subprocessモジュールを使用して外部プロセスを実行し、そのプロセスのコンソール出力を取得・保存する方法を示しています。

まず、run__main1関数が定義されています。この関数では、subprocess.Popenを使用して外部プロセスを実行し、その出力をファイルに保存します。具体的には、test.batというバッチファイルを実行し、その出力をres.log.txtというファイルに保存しています。

subprocess.Popenの引数として、実行するコマンドをリスト形式で指定しています。また、stdout引数には、出力を保存するファイルオブジェクトを指定しています。さらに、stderr=subprocess.PIPEとして、エラー出力を取得するように設定しています。

proc.communicate()は、外部プロセスの終了を待機するために使用されます。これにより、外部プロセスが終了するまでプログラムがブロックされます。

最後に、proc.returncodeを使用して、外部プロセスの終了コードを取得し、デバッグのために出力しています。

このコードの根幹部分の処理方法は、外部プロセスのコンソール出力を取得・保存するために、subprocess.Popenを使用し、stdout引数にファイルオブジェクトを指定して出力を保存し、proc.communicate()で外部プロセスの終了を待機するという手順です。

以上が、このコードの根幹部分の処理方法の説明です。もし他に何か質問があれば、お知らせください。

試行2

▼私(人間)
前記のコードの、根幹部分の処理方法だけを説明、コメント部の内容を大いに反映、体言止めで箇条書き、5個以内

▼Phind(自動応答)

• run__main1関数は、外部プロセスを実行し、そのコンソール出力を取得・保存する処理を行います。
• subprocess.Popenを使用して外部プロセスを実行します。
• 実行するコマンドは、test.batというバッチファイルです。
• 出力を保存するために、stdout引数にファイルオブジェクトを指定します。
• proc.communicate()を使用して、外部プロセスの終了を待機します。

②「はじめに」章の文章候補を生成

試行1

▼私(人間)
前記のコードの、根幹部分の処理方法だけを説明、200字以内

▼Phind(自動応答)
このコードは、外部プロセスを実行し、そのコンソール出力を取得・保存する方法を示しています。具体的には、subprocess.Popenを使用して外部プロセスを実行し、stdout引数にファイルオブジェクトを指定して出力を保存します。また、proc.communicate()を使用して外部プロセスの終了を待機します。これにより、外部プロセスのコンソール出力を取得・保存することができます。

試行2

▼私(人間)
前記のコードで、何が出来るようになるのかの説明、200字以内

▼Phind(自動応答)
このコードを使用することで、外部プロセスのコンソール出力を取得・保存することができます。これにより、他のプログラムやスクリプトを実行し、その出力をファイルに保存することができます。例えば、テスト実行時の結果やログの保存に利用することができます。また、外部プロセスの実行結果を後続の処理に利用する場合にも役立ちます。このコードを使用することで、外部プロセスとの連携やデータの取得・保存を効率的に行うことができます。

③キーワード(タグ)の候補を作成

試行1

▼私(人間)
前記のコードの、根幹部分の処理に、キーワード(タグ)を付与、5個

▼Phind(自動応答)

• 外部プロセスの実行: subprocess.Popen
• コンソール出力の取得: stdout
• 出力の保存: ファイルオブジェクト
• 待機: proc.communicate()
• 終了コードの取得: proc.returncode

以上が、このコードの根幹部分の処理に関連するキーワードです。

記事の文章候補を作成

前章までで得られたPhindの生成文を、記事のテンプレートにそのまま配置して、記事の文章候補全体を見てみると、

「はじめに」章:

↓(※② 試行1:)
このコードは、外部プロセスを実行し、そのコンソール出力を取得・保存する方法を示しています。具体的には、subprocess.Popenを使用して外部プロセスを実行し、stdout引数にファイルオブジェクトを指定して出力を保存します。また、proc.communicate()を使用して外部プロセスの終了を待機します。これにより、外部プロセスのコンソール出力を取得・保存することができます。

↓(※② 試行2:)
このコードを使用することで、外部プロセスのコンソール出力を取得・保存することができます。これにより、他のプログラムやスクリプトを実行し、その出力をファイルに保存することができます。例えば、テスト実行時の結果やログの保存に利用することができます。また、外部プロセスの実行結果を後続の処理に利用する場合にも役立ちます。このコードを使用することで、外部プロセスとの連携やデータの取得・保存を効率的に行うことができます。

↓(※③)
キーワード:

• 外部プロセスの実行: subprocess.Popen
• コンソール出力の取得: stdout
• 出力の保存: ファイルオブジェクト
• 待機: proc.communicate()
• 終了コードの取得: proc.returncode

「処理方法」章:

↓(※① 試行1:)

このコードは、subprocessモジュールを使用して外部プロセスを実行し、そのプロセスのコンソール出力を取得・保存する方法を示しています。

まず、run__main1関数が定義されています。この関数では、subprocess.Popenを使用して外部プロセスを実行し、その出力をファイルに保存します。具体的には、test.batというバッチファイルを実行し、その出力をres.log.txtというファイルに保存しています。

subprocess.Popenの引数として、実行するコマンドをリスト形式で指定しています。また、stdout引数には、出力を保存するファイルオブジェクトを指定しています。さらに、stderr=subprocess.PIPEとして、エラー出力を取得するように設定しています。

proc.communicate()は、外部プロセスの終了を待機するために使用されます。これにより、外部プロセスが終了するまでプログラムがブロックされます。

最後に、proc.returncodeを使用して、外部プロセスの終了コードを取得し、デバッグのために出力しています。

このコードの根幹部分の処理方法は、外部プロセスのコンソール出力を取得・保存するために、subprocess.Popenを使用し、stdout引数にファイルオブジェクトを指定して出力を保存し、proc.communicate()で外部プロセスの終了を待機するという手順です。

以上が、このコードの根幹部分の処理方法の説明です。もし他に何か質問があれば、お知らせください。

↓(※① 試行2:)

• run__main1関数は、外部プロセスを実行し、そのコンソール出力を取得・保存する処理を行います。
• subprocess.Popenを使用して外部プロセスを実行します。
• 実行するコマンドは、test.batというバッチファイルです。
• 出力を保存するために、stdout引数にファイルオブジェクトを指定します。
• proc.communicate()を使用して、外部プロセスの終了を待機します。

「サンプルコード」章:

(ここにサンプルコードをそのまま貼付け、再掲は省略)

最終的な記事を作成

前章の文章候補(Phindの生成文)から、好ましい部分を選択・加筆・整形して、記事全体を作成すると、

「はじめに」章:

↓(※②)
外部プロセスを実行し、そのコンソール出力を取得・保存するサンプルコード。
他のプログラムやスクリプトを実行し、proc.communicate()を使用して外部プロセスの終了を待機、その出力をファイルに保存できます。

↓(※③)
キーワード: subprocess.Popen、stdout、コンソール出力保存、終了の待機

「処理方法」章:

• ↓(※①)
• subprocess.Popenを使用して外部プロセスを実行
• 出力を保存するために、stdout引数にファイルオブジェクトを指定
• proc.communicate()を使用して、外部プロセスの終了を待機

「サンプルコード」章:

(ここにサンプルコードをそのまま貼付け、再掲は省略)

まとめ

ChatGPTでなくPhindでも、同等レベル(若しくは、若干劣化)の結果が得られる印象。Phindを記事作成の支援機能として十分利用可。一から説明文を作り上げるよりも候補から選択する方が楽。