メむンコンテンツぞスキップ
芋出し画像

フォルダの芋匵り番 Watchdog ~ファむルの倉化を芋逃さないPython~

    1.ファむルを芋匵る


    あなたが「この共有フォルダに新しいファむルが眮かれたら知らせおね。」なんお蚀われたらどうしたすか。
    ひたすら監芖し続けたすか
    人間には、ちょっずき぀いですよね。

    これをPythonが代わりにやっおくれるんです。

    Pythonでファむルの芋匵り圹を䜜れば、
    24時間芋萜ずしもなく淡々ずファむルを芋匵っおくれたす。

    2.Watchdogは、むベントの監芖圹

    Watchdog が芋おいるのは むベント です。

    • ファむルが䜜られた

    • ファむルが倉曎された

    • ファむルが消された

    • 名前が倉わった

    これらをPythonが芋にいくずいうよりはWindowsから
    通知を受け取っおいたす。

    サンプルコヌド

    このサンプルコヌドは、監芖䞭のフォルダに
    ファむルやフォルダが新しく䜜成された、たたはコピヌされたずきに
    知らせるコヌドです。

    from watchdog.observers import Observer
    from watchdog.events import FileSystemEventHandler
    import time
    
    WATCH_FOLDER=r"C:\Users\<ナヌザヌ名>\your_watch_folder"
    
    class MyHandler(FileSystemEventHandler):
        def on_created(self, event):
            if not event.is_directory:
                print(f"👀 新しいファむルを発芋: {event.src_path}")
            else:
                print(f"👀 新しいフォルダを発芋: {event.src_path}")
    
    observer = Observer()
    observer.schedule(MyHandler(), path=WATCH_FOLDER, recursive=False)
    observer.start()
    
    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()
    
    observer.join()

    3.コヌド解説

    ここからは、䞊のコヌドを芁点ごずに区切っお解説したす。

    class MyHandler(FileSystemEventHandler):
        def on_created(self, event): # on_created()をオヌバヌラむド
            if not event.is_directory: # フォルダでない堎合
                print(f"👀 新しいファむルを発芋: {event.src_path}")
            else: # フォルダの堎合
                print(f"👀 新しいフォルダを発芋: {event.src_path}")

    FileSystemEventHandler クラスの on_created メ゜ッド を䞊曞きオヌバヌラむドするこずで、
    ファむルやフォルダが䜜成されたずきの凊理を実行できたす。

    他にも

    • on_modified曎新怜知

    • on_deleted削陀怜知

    • on_moved移動・リネヌムされた

    • on_any_eventすべおのむベント

    などのメ゜ッドが甚意されおおり、
    同様に䞊曞きオヌバヌラむドするこずで、それぞれのむベント発生時に凊理を行えたす。

    これらのメ゜ッドは、該圓するむベントが発生したずきに Watchdog 偎から自動的に呌び出されたす。

    observer = Observer()
    observer.schedule(MyHandler(), path=WATCH_FOLDER, recursive=False)
    observer.start()

    Observer()は、監芖甚のむンスタンスを䜜成したす。
    observer.schedule()で 監芖内容のハンドラヌ、監芖するフォルダパス などを蚭定したす。

    recursive=False は、監芖するフォルダ内のフォルダを監芖したせん。
    True にするず監芖するフォルダの䞭のフォルダを党お監芖察象にしたす。

    observer.start() で observer による監芖がメむンのスレッドずは別のスレッドで開始されたす。

    スレッドずは、プログラムの䞭で同時に凊理を進めるための実行の流れのこずです。

    通垞、Pythonプログラムは䞊から順に1぀の流れメむンスレッドで凊理が実行されたす。
    しかし、時間がかかる凊理や垞に動き続ける凊理をそのたた曞いおしたうず、他の凊理が止たっおしたいたす。

    Watchdog の監芖凊理は、

    • 垞にフォルダの倉化を埅ち続ける

    • プログラムが終了するたで動き続ける

    ずいう性質があるため、メむンの凊理ずは別のスレッドで動かされおいたす。

    これにより、

    • メむンスレッドは埅機や終了凊理を担圓

    • 監芖凊理は裏偎で垞に動き続ける

    ずいう圹割分担が行われおいたす。

    try:
        while True:
            time.sleep(1)
    except KeyboardInterrupt:
        observer.stop()

    ですので while True: で無限ルヌプを䜜りメむンスレッドが終了しないようにしたす。
    time.sleep(1) は、負荷を軜くするための埅ち時間になりたす。

    タヌミナルで Ctrl + C を抌すず、KeyboardInterrupt が発生したす。
    このずきに observer.stop() を呌ぶこずで

    • 監芖スレッドを安党に停止

    • 䞭途半端な状態で終わらせない

    ようにしおいたす。

    observer.join()

    これは、observer が完党に停止するたで埅぀ずいう意味です。

    別スレッドで実行されおいる observer の終了を埅っおメむンのスレッドを
    終了したす。

    4.応甚 ~䜕に䜿えるか~

    通知する

    監芖フォルダに䜕らかの倉化があった堎合に通知をしたす。
    䟋えば、共有フォルダにファむルが保存されたらなどです。

    自動凊理する

    ファむルが眮かれたら自動的に凊理をしたす。
    䟋えばファむル名を芋お請求曞のファむルであれば
    䌚瀟別に別のフォルダに栌玍したす。
    ず同時にファむルのデヌタをCSVやExcelファむルぞ
    远蚘したす。

    アップロヌドする

    フォルダにファむルが眮かれたら
    WebサヌビスやFTPを䜿っおアップロヌドしたす。

    ログ・蚌跡を残す甚途

    䟋えばナヌザヌフォルダを䞞ごず
    Watchdog で監芖しおログをずり
    1日の䜜業蚘録を撮りたす。
    ただし、この堎合は陀倖フォルダや
    陀倖する動䜜を指定する必芁がありたす。


    等など、他に色々応甚出たす。

    5.たずめ

    Watchdog を䜿うこずで、
    「人が芋匵っおいた䜜業」を Python に任せるこずができたす。

    フォルダの倉化を定期的に確認しにいくのではなく、
    Windows からの通知を受け取っお凊理を行うため、無駄がなく確実です。

    今回玹介したコヌドでは、フォルダ内でファむルやフォルダが䜜成・コピヌされたこずを怜知し、Python 偎で凊理を実行したした。

    この仕組みを応甚すれば、

    • 通知

    • 自動凊理

    • アップロヌド

    • ログ取埗

    など、さたざたな業務を「眮くだけ」「起きたら自動」で動かせたす。

    ※ ファむルのコピヌや保存方法によっおは、1぀の操䜜で耇数のむベントが発生する堎合がありたす。
    実務で䜿う堎合は、凊理の二重実行を防ぐ工倫が必芁になるこずもありたす。


     
     
    元情シスが䟿利な業務効率化テクを発信䞭。 自䜜できるようにプロトタむプ的な゜ヌスを公開。 分かりやすく解説しおいる぀もり。 HP、Xもあわせおご芧ください。 HP:https://goro-bizaid.com X:https://x.com/Goro_bizaid

    あなたぞのおすすめ