設定ファイルの編集機能を加えてみる

まあ、CLIツールを組み合わせても出来るのですが。
てか、むしろそっちの方が綺麗に作れる場合が多いのですが。
なにしろ、先人の知恵の結晶ですし。

とはいえ、ちょっとはPythonのリストっぽい機能を使っておかないと、Pythonのリスト機能の強力さが解らんかなーと思って機能を実装してみました。

やりたいのは、設定ファイルを読み込んで、そのキーワードでマッチする行を、新たな設定行と置き換える、というものです。
一応ターゲットとしては、Audaciousのconfigを書き換える、ことを目的としていますが、似たような構造のconfigなら書き換えることが出来ますし、まあ、置換後の文字列を工夫することで、XMLなんかも書き換えは可能です。
#単なるテキストファイルだしな。

    #設定ファイルの書き換え
    def editConfig(self,keyword,replaceString,configPath):
        f = open(configPath)
        def edit(f):
            '''キーワードが見つかったら置き換え文字列を返すローカル関数 '''
            for txt in f:
                if txt.strip().find(keyword) >= 0:
                    yield replaceString+"\n"
                else:
                    yield txt
        cnf = [x for x in edit(f)]
        f.close()
        fw = open(configPath,"w")
        fw.writelines(cnf)
        fw.close()

やってることは、キーワードと、書き換える文字列（キーワード含む）、書き換える設定ファイルのパスを受け取って、設定ファイルを開き、ローカル関数のジェネレータでキーワードとマッチしたら置き換える文字列を返して、マッチしなかったら、そのままの文字列を返す、という処理をして、リスと内包表記で新規にリストを生成し、それを設定ファイルとして書き出す、ということだけです。
Pythonではテキストファイルのオープンは組み込み関数で行えます。
そして、組み込み関数は読み込んだテキストをリストとして返してくれるのです。
なので、リストを処理するジェネレータにより、簡単に置換処理は記述可能になります。
書き込みも、リストを渡すとまとめて書いてくれるfileオブジェクトのメソッドがあるので、簡単に済みます。
ちと、このメソッド内でやってることを整理してみましょうか。

• 設定ファイルを開いてリストに読み込む
• 設定ファイルからキーワードを探す(設定ファイルの前後の空白は削除してキーワードと比較)
• キーワードがれば置換文字列を、なければ、そのままの文字列を返す
• 返された文字列をリストとして変数に格納
• 設定ファイルとして書き込む

てな感じですかね。
言葉にしてみれば、案外たいしたことやってないんですが。(笑)
これ、例えばC言語なんかで書くと、もう少し面倒なんですよね。
実は、リスト内包表記だけでなんとかならないかなーと考えたんですが。
#他にもmapとかの高階関数でなんとかならんかな、とも思ったんですが。lambdaとか使って。
新しい設定を末尾に追加、ならもっとシンプルに書けるんですが、「同じ位置で置換」だと、ワタクシのPythonレベルでは、これが精一杯でした。(笑)
#もっとうまい書き方があるよ、というPythonエキスパートの方がいらっしゃれば、ご指導いただけるとありがたいですね。いや、マジで。

とはいえ。
Pythonのリスト構造、およびそのサポート機能があるから、この手のファイルの扱いもお手軽にできるわけで、リストの強力さを示す一旦でもあります。
ちなみに、ジェネレータに関しては、この辺に詳しい説明があります。
リストを処理するための専用機能って感じですかね。
そのジェネレータを、メソッドの中のローカル関数として定義して使用してます。
#他で使わないので。

で、このメソッドは、インストールコマンドを発行し、設定ファイルのダウンロードや展開などが終わった後、自動的に設定ファイルを書き換えるために使います。
サンプルの呼び出しとしては以下の通りでしょうか。

        configpath = os.path.expanduser("~") + "/.config/audacious/config"
        self.editConfig("skin=", "skin=/usr/share/audacious/Skins/xxxxx", configpath)

一行目でaudaciousの設定ファイルのパスを生成して、2行目で、書き換えを指示しています。xxxxxが具体的なスキンのファイル名ですね。

ちと、Pythonのリスト機能の強力さを示すために作ってみたサンプルなんですが、強力さがまったく伝わらないのは残念な限りです。(^^;

今のままでは、猫に小判、宝の持ち腐れ状態なので、この辺を綺麗に説明できるといいんですがね。
ま、ネタもそれ向きじゃないし、ある程度仕方ないのか。
リスト化された文字列を一気に加工、とか、そういうのが簡単に書けたりするんですが。
例えば、単なるテキストファイルを読み込んで、HTMLとして出力する、とか。

気になる事務のあのコにアピールするポイントを持っているのに、自分では全然気がついてない、という状態でしょうか。
そのことに気づけば、おっぱいが揉めるかも知れないのに、大変残念なことです。

というわけで、呼び出しの部分はコメントアウトしてますが、全体。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import commands
import os
import os.path
import pygtk
import gtk

__author__="kaoru"
__date__ ="$2010/08/28 13:42:04$"

#インストールコマンド群
installCommands=(
("gksudo add-apt-repository ppa:khf03353/ppa-kaorin","gksudo apt-get update",'gksudo "apt-get -y install mikutube"'),    #一つめのチェックボックスのコマンド群
("gksudo add-apt-repository ppa:khf03353/ppa-kaorin","gksudo apt-get update",'gksudo "apt-get -y install mikukabe"'),    #二つめのチェックボックスのコマンド群
("gksudo add-apt-repository ppa:khf03353/ppa-kaorin","gksudo apt-get update","gksudo "apt-get -y install mikukabe"')     #三つめ以降は、このように増やしていく

class MikunchApp:

    def __init__(self):

        #Set the Glade file
        self.gladefile = "mikunchu.ui"
        self.wTree = gtk.Builder()
        self.wTree.add_from_file(os.path.dirname(os.path.abspath(__file__)) + "/"+self.gladefile)
        #Create our dictionay and connect it
        dic = {
                "on_btCansel_clicked" : self.on_btnCancel_clicked,
                "on_btOK_clicked" : self.on_btnOK_clicked,
                "on_TopLevel_destroy" : self.on_TopLevel_destroy }
        self.chkMikutube = self.wTree.get_object("chkMikutube")
        self.chkMikukabe = self.wTree.get_object("chkMikukabe")
        self.wTree.connect_signals(dic)

        self.mainWindow = self.wTree.get_object ("TopLevel")
        self.mainWindow.show_all()

    def on_TopLevel_destroy(self, widget):
        #ウィンドウを閉じてアプリケーションを終了する
        gtk.main_quit()

    def on_btnOK_clicked(self,widget):
        #適用を行ってアプリケーションを終了する
        if self.chkMikutube.get_active() == True:
            #みくつべ♪インストールコマンドを実行
            for cmd in installCommands[0]:
                self.execCommand(cmd)
        if self.chkMikukabe.get_active() == True:
            #みくかべ♪インストールコマンドを実行
            for cmd in installCommands[1]:
                self.execCommand(cmd)
        #configpath = os.path.expanduser("~") + "/.config/audacious/config"
        #self.editConfig("skin=", "skin=/usr/share/audacious/Skins/Default", configpath)

        #ウィンドウを閉じてアプリケーションを終了する
        gtk.main_quit()

    def on_btnCancel_clicked(self,widget):
        #ウィンドウを閉じてアプリケーションを終了する
        gtk.main_quit()

    #コマンド実行のメソッド
    def execCommand(self,command):
        print command   #受け渡されたコマンドのデバッグ用プリント
        ret = commands.getoutput(command)
        print ret             #実行結果のデバッグ用プリント
        return ret

    #設定ファイルの書き換え
    def editConfig(self,keyword,replaceString,configPath):
        f = open(configPath)
        def edit(f):
            '''キーワードが見つかったら置き換え文字列を返すローカル関数 '''
            for txt in f:
                if txt.strip().find(keyword) >= 0:
                    yield replaceString+"\n"
                else:
                    yield txt
        cnf = [x for x in edit(f)]
        f.close()
        fw = open(configPath,"w")
        fw.writelines(cnf)
        fw.close()

if __name__ == "__main__":
    MikunchApp()
    gtk.main()

これで、ほぼ予定していた機能は実装し、ある程度の説明は終わりました。

まだ完全な理解は得られていないと思いますが、あちこちで指し示したPythonのチュートリアル、それから、そこから辿れるリファレンスや、キーワードで検索などしてみれば、今後の拡張や、理解不足な部分は、補えるのではないか、と思います。

何より、このサンプルを、自分なりに改造してみて、失敗して、色々と身に染みることで、得られることが大きのではないかな、と思います。
これを、そのまま使うのではなく、まず改造してみる、そのことから始めて見るといいのではないでしょうか。

気になる事務のあのコを誘うのだって、マニュアル通りでは、彼女も飽き飽きしているかも知れません。オリジナルなアプローチだとうまく行く可能性だってあるし、直球で「おっぱいを揉ませてくれないか？」でうまく行く可能性だって0ではないのです。（そんなオカルトありえません）

というわけで、一旦、第一部完、かな、と思ってますが、オプションというか、補足として、GTKコントロールの他のコントロールの使い方、特にセットアップヘルパ辺りでは重要な、ドロップダウンリストによる選択のサンプルなど、次回以降取り上げてみようかと思います。
ま、この辺もネットを漁れば、やまほどサンプルなんて出てくるんですが、せっかくなのでGladeを使った方法を説明してみましょうかね。

---

設定ファイルの書き換えが解らん、との話がありましたので、ちと追記します。
「らしい書き方」をしてしまったが為に、初学者であるおっさんには、ちと難解な構造になってしまっていたようです。(^^;

で、まあ、何も無理してローカル関数やジェネレータ、リスト内包表記なんぞ使わんでも、以下の書き方で書けます。
ま、上記三つを使うには題材に無理がありましたかね。
こちらの表記のほうが結果シンプルになるので、何やってるのかは解り易いんじゃないかと。
まあ、実装の方法はいくつかあり、常にベストを探す必要はないでもないんですが、今回、ちとリストにこだわり過ぎたがための失敗ですな。(笑)

まあ、ぬるく書いてるので多めに見てやってください。
ってことで、もう少し何やってるのか解りやすく書き直したeditConfigメソッドを以下にご紹介。

    #設定ファイルの書き換え
    def editConfig(self,keyword,replaceString,configPath):
        print keyword
        print replaceString
        #ファイルをオープン
        f = open(configPath)
        #新しいコンフィグファイル用の空リスト
        cnf =[]
        #変数tに開いたファイルから一行づつ読み込む
        for t in f:
            #キーワードが含まれていれば、行を置き換える
            if t.strip().find(keyword) >= 0:
                cnf.append( replaceString+"\n")
            else:
                cnf.append(t)
        #ファイルをクローズ（読み終わったので）
        f.close()
        #書き込み用に再度ファイルを開く
        fw = open(configPath,"w")
        #生成したリストを書き込む
        fw.writelines(cnf)
        #書き込んだのでファイルを閉じる
        fw.close()

ぶっちゃけ、ローカル関数(ジェネレータ)にしてたのを外に出しただけ。(笑)
リスト内包表記にこだわらなければ、こっちの方がシンプルですな。

f=open(configPath)で設定ファイルを取得したあと、for t in f:の部分で、tという変数にfというリストから、一行づつ、中身を取り出しています。
その後に続くif文で、キーワードがある場合には、置換用の文字列(行)と置き換えて、新しいリストに追加し、それ以外のものは、そのまま新しいリストに追加する、というシンプルな処理です。

これなら、おっさんにも、まだ解りやすいんじゃないかと思うんですがね。
さて、どんなもんでしょうか。