クリップボードにある文字列のうち、{}で囲まれたものを、辞書から検索し、置換したい

Question

【やりたいこと】
pythonを用いて、クリップボードに入った文字列のうち、{}で囲まれたものを、
置換用の辞書にあるキーと一致した場合に、値の文字列に一斉に置換するプログラムを作りたいと思っています。

（例)
辞書ファイル(rep_dict.txt)
郵便番号,〒100-8111
住所,東京都千代田区千代田１-１
宛先指名,山田　太郎
案件,H社向け××システム

クリップボードの文字：
{宛先指名}様
先月ご依頼いただきました{案件}についてですが、…（中略)

以下住所に書類を送付いただけませんでしょうか。
{郵便番号} {住所} 宛

お忙しい中大変申し訳ありませんが、ご対応のほど、よろしくお願いいたします。

【やってみたこと】
下記コードを描いてみました。

import pyperclip, re, threading, random

def task():
    copy_text = str(pyperclip.paste())

    #todo:ここで読み込む。下はテストで置き替え。{}で囲まれた文字は****で置き換えはできた
#    new = re.sub(r'{.+}', '****', copy_text)
    
    if len(copy_text) > 0:
        pyperclip.copy(''.join(new))
#        print('---Rewrite Complete!---')
    else:
        print('---Failure---')
    th = threading.Timer(5, task)
    th.start()

t = threading.Thread(target=task)
t.start()

上記のコードで、定期的に{}内の文字を****に置換するのには成功したのですが、
辞書を読み込んで、その情報と一致したら置換する処理を描こうとして詰まってしまいました。

下記のコードを追加したら、辞書を読み込む際に、エラーが出てしまいました。

with open("rep_dict.txt") as f:
s = f.read()
print(s)
dict_rep = dict(line.strip().split(',') for line in s)
dict_rep

ValueError: dictionary update sequence element #0 has length 1; 2 is required

もしよろしければ、よい解決策についてご教示いただければと考えます。

Answer 1

エラーの原因

下記のコードを追加したら、辞書を読み込む際に、エラーが出てしまいました。

with open("rep_dict.txt") as f:
s = f.read()
print(s)
dict_rep = dict(line.strip().split(',') for line in s)
dict_rep

ValueError: dictionary update sequence element #0 has length 1; 2 is required

期待に反して、lineに各行が与えられていないからです。

print([line for line in s])   # => ['郵', '便', '番', '号', ',', '〒', '1', '0', '0', '-', '8', '1', '1', '1', '\n', '住', '所', ',', '東', '京', '都', '千', '代', '田', '区', '千', '代', '田', '１', '-', '１', '\n', '宛', '先', '指', '名', ',', '山', '田', '\u3000', '太', '郎', '\n', '案', '件', ',', 'H', '社', '向', 'け', '×', '×', 'シ', 'ス', 'テ', 'ム']

次のように書けば良いです。

dict_rep = dict(line.strip().split(',') for line in s.split('\n'))

また、さらに簡潔にも書けます。

with open("rep_dict.txt") as f:
    # s = f.read()
    # print(s)
    dict_rep = dict(line.strip().split(',') for line in f)
    print(dict_rep)

書いてみた

面白そうなので、ちょっと書いてみました。

from collections import defaultdict
import re

#
# 本当はjsonで扱いたいところ
rep_dict = defaultdict(str)
with open(r'rep_dict.txt') as f:
    for row in f:
        row = row.strip()
        key, value = row.split(',')
        rep_dict[key] = value
        
#
#
def my_replace(match):
    key = match.group().strip('{}')
    return rep_dict[key]

src = open(r'clipboard.txt').read()
dst = re.sub(r'{.+?}', my_replace, src)

print(dst)

実行結果 Wandbox

山田　太郎様
先月ご依頼いただきましたH社向け××システムについてですが、…（中略)

以下住所に書類を送付いただけませんでしょうか。
〒100-8111  東京都千代田区千代田１-１ 宛

お忙しい中大変申し訳ありませんが、ご対応のほど、よろしくお願いいたします。

何かご不明な点があれば、お気軽にお尋ねください。

Comments

[H.K2]

迅速なご回答ありがとうございます！
なるほど、、[line for line in s]だと1文字ずつになってしまうのですね…。
[line for line in s.split('\n'))]のように改行コードをつかって分割するときちんと取得できるのはなぜなのでしょうか…。基本的な質問で申し訳ありません。。。

[LouiS0616]

前者は、文字列そのものに対してループしようとしています。
後者は、文字列を改行文字で分割したリストに対してループしようとしているのです。

[H.K2]

ああなるほど…。文字列扱いで、1文字ずつループになるけど、
リストに対してのループなら、その分割後の要素に対してのループになるのですね、、ありがとうございます！

Answer 2

おもしろいプログラムですね。変換テーブルのファイルを読み込むのは LouiS0616 さんが解説なさっている通りです。CSVであれば csv モジュールを使うのがおすすめですが。

今回のように { ほげほげ } のような決められた記法で書かれたテキストに別の文字列を埋め込む仕組みを「テンプレート」と呼びます。Python では Jinja2 という大変有名なテンプレートエンジンがあります。自前で {…} を検索して文字を入れていってもよいですが、テンプレートエンジンを使うことによってより簡単に、より正確に、そしてより柔軟な事ができるようになります。

以下サンプルで書いてみました。

import csv
import time

from jinja2 import Environment
import pyperclip


if __name__ == '__main__':
    with open("rep_dict.txt") as f:
        reader = csv.reader(f)
        dict_rep = {row[0]: row[1] for row in reader}

    clip_last = None
    while True:
        clip = pyperclip.paste()
        if clip != clip_last:
            print('--- Clipboard changed ---')
            new_clip = Environment().from_string(clip).render(dict_rep)
            if clip != new_clip:
                pyperclip.copy(new_clip)
                print('--- Rewrite Complete! ---')
        clip_last = new_clip
        time.sleep(1)

{{ 宛先指名 }}様
先月ご依頼いただきました{案件}についてですが、…（中略)

以下住所に書類を送付いただけませんでしょうか。
{{ 郵便番号 }}  {{ 住所 }} 宛

お忙しい中大変申し訳ありませんが、ご対応のほど、よろしくお願いいたします。

↑ Jinja2 では変数の埋め込みに {{ 変数名 }} という記法を使います。

---

次に応用編です。テンプレートエンジンを使うとより柔軟にテキストを生成することができます。

{
    "郵便番号": "〒100-8111",
    "住所": "東京都千代田区千代田１-１",
    "宛先指名": "山田　太郎",
    "案件": "H社向け××システム",
    "必要書類": [
        "見積もり確認書",
        "要求案件シート",
        "仮契約書"
    ]
}

import json
import time

from jinja2 import Environment
import pyperclip


if __name__ == '__main__':
    with open('rep_dict.json', 'r', encoding="utf-8") as f:
        dict_rep = json.load(f)

    clip_last = None
    while True:
        clip = str(pyperclip.paste())
        if clip != clip_last:
            print('--- Clipboard changed ---')
            new_clip = Environment().from_string(clip).render(dict_rep)
            if clip != new_clip:
                pyperclip.copy(new_clip)
                print('--- Rewrite Complete! ---')
            clip_last = new_clip
        time.sleep(1)

{{ 宛先指名 }}様
先月ご依頼いただきました{案件}についてですが、…（中略)

書類を送付いただけませんでしょうか。

送付先：
{{ 郵便番号 }}  {{ 住所 }} 宛

送付書類：
{% for 書類名 in 必要書類 %}・{{ 書類名 }}
{% endfor %}
以上{{ 必要書類|length }}点

お忙しい中大変申し訳ありませんが、ご対応のほど、よろしくお願いいたします。

山田　太郎様
先月ご依頼いただきました{案件}についてですが、…（中略)

書類を送付いただけませんでしょうか。

送付先：
〒100-8111  東京都千代田区千代田１-１ 宛

送付書類：
・見積もり確認書
・要求案件シート
・仮契約書

以上3点

お忙しい中大変申し訳ありませんが、ご対応のほど、よろしくお願いいたします。

↑ このようにデータが複数ある場合でも対応できますし、要素の数を計算したりと様々な処理が可能です

Jinja2 はWebアプリケーションでHTMLを生成したり、メールの定型文を作ったりなど、動的にテキストを生成する用途に広く使えます。覚えて損はありませんのでぜひ触ってみて下さい。

Comments

[H.K2]

ありがとうございます！
なるほど、jinja2という便利なライブラリがあるんですね…。
テンプレートエンジン、ですか…。非常に便利そうなので、ちょっとググって使えるようにしてみます！