2010年10月30日土曜日

課題２：解答編

だいぶ間が開いてしまいましたが、解答編を書いときます。

まずは、ソースコード全体を。

view plainprint?
  1. #!/usr/bin/env python  
  2. # -*- coding: utf-8 -*-  
  3.   
  4. import os  
  5. import gtk  
  6. import glib  
  7.   
  8. class SlideShow:  
  9.       
  10.     def __init__(self):  
  11.           
  12.         #GTK.Builderを構築  
  13.         wTree = gtk.Builder()  
  14.         #Gladeファイルの読み込み  
  15.         wTree.add_from_file("SlideShow.ui")  
  16.         #MainWindowオブジェクトを取得する  
  17.         self.mainWindow = wTree.get_object("MainWindow")  
  18.         #シグナルとシグナルハンドラをdic形式で作成する  
  19.         dic = {"on_MainWindow_destroy":self.on_MainWindow_destroy}  
  20.         #シグナルハンドラとシグナルを結びつける  
  21.         wTree.connect_signals(dic)  
  22.         #スライドショー用のGTKImageオブジェクトを取得する  
  23.         self.imgSlideShow = wTree.get_object("imgSlideShow")  
  24.         #画像のパスを取得  
  25.         self.imagePath = []  
  26.         #os.walk関数により、再帰的にフォルダを降りていき画像を探す  
  27.         for base, path, imPath in os.walk("/usr/share/backgrounds"):  
  28.             for img in imPath:  
  29.                 limg = img.lower()  
  30.                 #jpg/png/jpegファイルだけを対象にする  
  31.                 if limg.find("jpg") > 0 or limg.find("png") > 0 or limg.find("jpeg") > 0:   
  32.                     self.imagePath.append(base+"/"+img)  
  33.         #初期画面をロード  
  34.         #初期画面を表示するためのカウンタを初期化  
  35.         self.count = 0   
  36.         #gtk.Imageに画像ファイルを表示する関数をコールする  
  37.         self._loadImage()  
  38.         #ウィンドウを表示する  
  39.         self.mainWindow.show_all()  
  40.         self.timeout = glib.timeout_add_seconds(2,self._timeouf,self)  
  41.           
  42.       
  43.     def on_MainWindow_destroy(self,widget):  
  44.         #GTKのメッセージループを終了する  
  45.         gtk.main_quit()  
  46.       
  47.     def _timeouf(self,event):  
  48.         #gtk.Imageに画像ファイルを表示する関数をコールする  
  49.         self._loadImage()  
  50.         return True  
  51.           
  52.     def _loadImage(self):  
  53.         #現在のカウンタを使用して画像ファイル名を取得。  
  54.         wallpaper = self.imagePath[self.count]  
  55.         #現在のウィンドウサイズを取得（x,y）のタプルで返る  
  56.         size = self.mainWindow.get_size()  
  57.         #新規にPixBufを作成し、指定されたファイルを読み込む  
  58.         pixbuf = gtk.gdk.pixbuf_new_from_file(wallpaper)  
  59.         #読み込んだPixBufの縦と横のサイズを取得  
  60.         x = float(pixbuf.get_width())  
  61.         y = float(pixbuf.get_height())  
  62.         #アスペクト比を算出  
  63.         aspect = y / x  
  64.         #pixbuf.scale_simpleメソッドを使用し、ウィンドウにマップされたImage用のpixbufを作成する  
  65.         #その際、アスペクト比を合わせる。基準は横幅  
  66.         pixbuf2 = pixbuf.scale_simple(size[0], int(size[0]*aspect),gtk.gdk.INTERP_BILINEAR )  
  67.         #使い終わったPixBufを削除      
  68.         del pixbuf  
  69.         #ウィンドウにマップされたgtk.Imageに新規にリサイズしたPixBufをアサイン  
  70.         self.imgSlideShow.set_from_pixbuf(pixbuf2)  
  71.         #アスペクト比に合わせてウィンドウサイズをリサイズ  
  72.         self.mainWindow.resize(size[0],int(size[0]*aspect))  
  73.         #画像リスト用のカウンタをカウントアップ  
  74.         if len(self.imagePath) > self.count+1:  
  75.             self.count += 1  
  76.         else:  
  77.             self.count = 0  
  78.   
  79. if __name__ == "__main__":  
  80.     #イメージ表示ウィンドウのコンストラクタを実行する（オブジェクトを作成する）  
  81.     SlideShow()  
  82.     #GTKのメッセージループを実行する  
  83.     gtk.main()  

これに、課題２の時に母体コードとして提供したSlideShow.uiファイルを組み合わせれば、２秒置きに画像が表示されるスライドショーが完成します。

今回、ポイントとなるのは、以下の関数というかメソッドなわけですが。
view plainprint?
  1. def _loadImage(self):  
  2.         #現在のカウンタを使用して画像ファイル名を取得。  
  3.         wallpaper = self.imagePath[self.count]  
  4.         #現在のウィンドウサイズを取得（x,y）のタプルで返る  
  5.         size = self.mainWindow.get_size()  
  6.         #新規にPixBufを作成し、指定されたファイルを読み込む  
  7.         pixbuf = gtk.gdk.pixbuf_new_from_file(wallpaper)  
  8.         #読み込んだPixBufの縦と横のサイズを取得  
  9.         x = float(pixbuf.get_width())  
  10.         y = float(pixbuf.get_height())  
  11.         #アスペクト比を算出  
  12.         aspect = y / x  
  13.         #pixbuf.scale_simpleメソッドを使用し、ウィンドウにマップされたImage用のpixbufを作成する  
  14.         #その際、アスペクト比を合わせる。基準は横幅  
  15.         pixbuf2 = pixbuf.scale_simple(size[0], int(size[0]*aspect),gtk.gdk.INTERP_BILINEAR )  
  16.         #使い終わったPixBufを削除      
  17.         del pixbuf  
  18.         #ウィンドウにマップされたgtk.Imageに新規にリサイズしたPixBufをアサイン  
  19.         self.imgSlideShow.set_from_pixbuf(pixbuf2)  
  20.         #アスペクト比に合わせてウィンドウサイズをリサイズ  
  21.         self.mainWindow.resize(size[0],int(size[0]*aspect))  
  22.         #画像リスト用のカウンタをカウントアップ  
  23.         if len(self.imagePath) > self.count+1:  
  24.             self.count += 1  
  25.         else:  
  26.             self.count = 0  
中身に関しては、ソースコードの一行ごとにコメント入れたので、そちらを参照してもらうとして。

これが、２箇所でコールされている、ということです。
__init__と_timeoufの２箇所ですね。
もちろん、もっとシンプルな処理の場合、２箇所に同じ処理を書いてもいいのですが、基本的に、gtk.Imageに指定された画像ファイルを表示する、という全く同じ処理を行っているわけです。

さすがに、ここまで長いと理解できると思いますが、同じ処理を何度も書くのはムダなんですね。
どのようにムダかというと、以下の点でムダ。

同じことを２回書かなくてはならない（コピペでいいじゃんという説はある）
もしも修正した場合、同じ箇所を２回直さないとならない（コピペでいいじゃんという説はある）
同じコードが2度も現れると読みにくい

いずれの場合も、同じ手間を２度行わなくてはならないのがムダ、ということになります。
で、まあ２箇所くらいなら、別にコピペでもいいんですが、これが20箇所とかになると、さすがにコピペも厳しいし、読みづらくなるし、コピペ漏れも出てきます。
そのため、同じ処理はまとめてしまって、関数、あるいはローカルメソッドして定義してしまうほうが効率がよいわけです。

ローカルメソッドとするか、関数とするかは、スコープの問題なので、各種クラスで汎用的に使われる処理であれば、関数として、どこからでも呼べるようにしておくべきでしょう。
例えば、エラーメッセージのメッセージボックスを表示するための処理、とか、デバッグ用のログ出力を行う処理とか、ですね。
#デバッグログとか、日時出力とか行うので、それなりに長い処理になったりする。

このように、効率の悪くなるコードを関数やローカルメソッドにしてしまうプログラムの事を構造化プログラミングといいます。
いつぞや番外で触れましたけど。

見直せば、もっと構造化できそうなところもないではないですが、まあ、無理に構造化しても実行が遅くなったり、却って見にくくなってりします。
その他、Pythonでは、リスト内包表記が使えるので、あまり見ませんがループのネストが深くなる場合や、条件式の内側が、かなり大きくなる場合に、ローカルメソッドにして、処理そのもの流れを見やすくするなど、構造化プログラミングの手法としてあったりします。
#これもやり過ぎると実行速度に影響が出たりします。

いずれにせよ、ひとが見やすいように、処理を分割し、関数化、あるいはローカルメソッド化することにより、ムダを省き、バグが発生しにくくしましょうよ、ということを、今回の課題では伝えたかったんですが、ちとネタがディープ過ぎて伝わり難いというね。(笑)
これなら、リストの処理で、内部関数とか、そういうのをネタにした方が良かったかな。(^^;

まあ、例えて言うなら、毎日の通勤路、自分は階段を降りる時に、階段を登ってくるOLさんの胸の谷間を見るために、若干右よりに降りていく、すれ違う瞬間だけ、さっと左側に視線を走らせる、ということを毎日やっているとして、これをルーチン化して、無意識に行うのと同じようなことです。

意識して、毎度毎度やっていたのでは、不自然な動きになり、OLさんに警戒されてしまうでしょう。
そこを不自然にならないように、無意識に行えるように自分の中でルーチンとして一連の動きが処理されるようにまとめてしまう、ということです。
#例えがハイエンド過ぎて分かり難いか。
見事谷間を目撃できたら、その日はいいことがありますよ、的な占いのようなものでもあるかも知れません。
そのために、いかに自然に振舞うか。それがルーチン化の要でもあります。

プログラムだって同じなのです。毎度繰り返されるような処理はひとかたまりにして、ひとつのブロックとして、単に呼び出せば、それが実行される、という形にまとめておいた方が、いろいろと都合がいいわけです。
ルーチンを見直す時とかですね。
例えば、先の例だと、季節ごとにOLさんの服装も代わります。その場合、右によるか、左によるか、季節ごとの見直しが必要です。
しかもターゲットのOLさんがひとりでない場合、全体的に見直しになってしまいます。
そこで、きちんと関数として、まとめておくことで、季節ごとに、一箇所修正することで、無事に谷間を拝めるようになるのです。

朝の通勤時、OLさんの谷間を拝めるかどうか、それだけで朝の気分は違います。
それだけ、ルーチン化、関数化というのは重要なことなのです。

今回の課題で主張したかったのは、この点ですね。
「谷間を見逃すな」「同じ処理を2度書くな」ということです。

では、ぼちぼち、次のネタを考えることにしましょうかね。
投稿者 時刻:

0 件のコメント:

コメントを投稿

登録: コメントの投稿 (Atom)